Windows MATRIX SDK/API Install Guide · Windows MATRIX SDK/API Install Guide For use with Windows Operating System Matrix series products December 12, 2012

Windows MATRIX SDK/API Install Guide For use with Windows Operating System

Matrix series products

December 12, 2012

Great River Technology Inc.

Matrix Windows Install Guide 2 12/12/2012

Table of contents

TABLE OF CONTENTS ............................................................................................................................. 2

OVERVIEW ............................................................................................................................................ 3

INSTALLATION STEPS ............................................................................................................................. 4

INSTALLED FILES AND DIRECTORIES ..................................................................................................... 13

ARINC818 / FCAV INSTALL ........................................................................................................................... 14 ARINC818 / FCAV Products Applications .............................................................................................. 14

HOTLINK II VIDEO (HL2V) INSTALL ................................................................................................................... 15 Hotlink II Video (HL2V) Products Applications ...................................................................................... 15

SDK ONLY INSTALLED FILES ............................................................................................................................. 16

DEVICE MANAGER ............................................................................................................................... 17

UPGRADING INSTALLED PRODUCTS ..................................................................................................... 18



Overview This document will outline the steps necessary to install the software and documentation for the MATRIX Series cards. Both the ARINC818 and HL2V products are covered. This document shows the ARINC818 setup, but the HL2V setup follows the same flow and installs the same device drivers. Only the test applications and SDK files will be different. See the section “Installed Files and Directories” This is applicable to Windows Operating systems listed below Windows XP 32bit Windows Vista 32bit Windows Server 2003/2008 32bit Windows 7 32bit Windows 7 64bit Windows 8 32bit Windows 8 64bit This document describes the software and documentation installation only. After this installation, refer back to the Quick Start to determine your next step. Refer to the User’s Manual for instructions on how to use the test applications. If you purchased the SDK for your card, refer to the SDK API User’s Manuals for detailed information on custom programming using the SDK API.



Installation Steps NOTE : It is recommended that you install the hardware first and then boot up to run the setup program. If the setup program is run first and then the hardware installed, this is also acceptable. 1. Install the Hardware Turn off PC power and install the Matrix PCIe card into an available PCIe slot that is 4 lanes or more. 2. Turn on PC and during windows startup, a new device will probably be detected if you

installed the Matrix card before running setup. If so, hit “Cancel” as it is not required to step through the setup Wizard.

You must be logged in as an administrator for the following step ! 3. Install the software Install the software by inserting the supplied CDROM into the drive on your PC. Run “GRSETUP.EXE” from this disk if it does not auto start. Follow the instructions on the screen to install all of the files to the specified directory

Click on “Cancel”



4. Select Setup Type for your Operating system. This menu allows the user to install on either 32bit or 64bit Windows OS’s. The program will detect 32 bit or 64 bit and show the selected OS type in the selection Button. (This is based on either 32bit or 64 bit Windows Operating Systems) The following menu should autorun when you insert the setup CD. If not run the “grsetup” program from the root of the setup CD.

NOTE : If for some reason the “MatrixMenu” program does not run the selected setup, you can manually run “setup.exe” from the appropriate directory based on your OS type. This is only if you have problems and is a manual back door operation if for some reason the menu program fails or some other un-foreseen failure.

Run “setup.exe” in this directory for 32 bit Windows

Run “setup.exe” in this directory for 64 bit Windows



Setup Files and Redistributable package Some PC will require the Redistributable package. 5. Click Install on this and wait for it to complete.

6. The install will begin. Click “Next”



7. Read the license agreement and accept the terms to continue

8. Select the installation type.

Note : The SDK requires a purchased unlock code. If you purchased this product, the unlock code will be on the Setup CD



9. If you selected the “SDK” setup type, enter the unlock code and click “Next”.

Note : The unlock code is case sensitive.

10. The summary page will show what will be installed. Click “Next” to run the setup



11. The files will be copied to the install directory

C:\GreatRiverTech\Matrix

12. The device driver is installed and will start a console box to do the low level registration. Do

not close this box or halt the install. This process can sometimes take a few minutes to complete.



13. Click on the “Install Driver” area of any warning dialogs that pop up. There will typically be

2 of these. This is just telling Windows that this driver is ok and from a trusted source.

On some PC’s or if you are upgrading or re-installing the Matrix drivers, you will get a screen that looks like the figure below. This screen prompts the user for input. Always press the ‘C’ key for Cancel as this will re-install the correct driver.



14. Once the install completes, click “Finish” and restart the computer. This will load the driver

for the card. Note : If you did not install the Matrix card before you ran setup, turn off the PC and install the card. Once the PC is turned back on the driver installation will be completed.



Write application to call the API or Run the Test Application See the programs groups in windows. Look for the “Great River Tech” program group The example below shows the installed programs for the HL2V (Hotlink) video card. Note: For ARINC818 the ARINC818 Test App Icon would be seen instead

If you purchased the SDK, write your application software to use functions in the API and control the Matrix card. Reference the SDK API “User’s Manual” in the \DOCS directory for examples and function descriptions.



Installed files and Directories The following files will be installed to your harddrive. Default install directory:

C:\GreatRiverTech\Matrix This Directory will contain the files from the install. See the following information for each install type



ARINC818 / FCAV Install

ARINC818 / FCAV Products Applications Directory Filename Description

C:\GreatRiverTech\Matrix MatrixA818Test.exe

ARINC-818 specific test application

C:\GreatRiverTech\Matrix HOSTMatrix.ini Test application initialization file. See Matrix ARINC818 User Manual for description

C:\GreatRiverTech\Matrix MatrixDiag.exe Diagnostics application for .for Matrix products. This application is typically not used, but is very useful for technical support and debugging

Docs directory contains all user manuals and support documents

DriverWDM directory contains setup files and driver. Do not use these files unless directed by tech support

Header directory contains header files for use with MatrixA818Test application. These headers support ARINC818 and FCAV

Video directory contains test images for loading into the Matrix Card memory. These test images can be transmitted

Root application directory contains the following list of applications shown below



Hotlink II Video (HL2V) Install

Hotlink II Video (HL2V) Products Applications Directory Filename Description

C:\GreatRiverTech\Matrix MatrixHL2V_Rcvr.EXE Hotlink II Video Receiver test application NOTE: This application is not supported and is for demonstration purposes only.

C:\GreatRiverTech\Matrix MatrixHL2V_Xmit.EXE Hotlink II Video Transmitter test application NOTE: This application is not supported and is for demonstration purposes only.

C:\GreatRiverTech\Matrix HL2V_RCVR.PARAM Hotlink II Video Receiver Application Executable initialization file. Contains control register value

C:\GreatRiverTech\Matrix HL2V_XMIT.PARAM Hotlink II Video Transmit Application Executable initialization file. Contains control register value

C:\GreatRiverTech\Matrix MatrixDiag.exe Diagnostics application for .for Matrix products. This application is typically not used, but is very useful for technical support and debugging

Docs directory contains all user manuals and support documents

DriverWDM directory contains setup files and driver. Do not use these files unless directed by tech support

Video directory contains test images for loading into the Matrix Card memory. These test images can be transmitted

Root application directory contains the following list of applications shown below



SDK Only Installed files (Both Matrix Product Lines) Note: Installed only with optional SDK.

Directory Filename Description C:\GreatRiverTech\Matrix \Code

GRTM_API.H C/C++ Header file for usage of the MATRIX API.

C:\GreatRiverTech\Matrix \Code

GRTM_API.LIB C/C++ link library file for usage of the MATRIX API. This file must be included in the C/C++ project for linking to the exported API functions.

C:\GreatRiverTech\Matrix \Code

modGRTM_API.bas Visual Basic module file to be included in any Visual Basic project that calls the MATRIX API.

C:\GreatRiverTech\Matrix \Code\Examples

Example File directories for each product line installed

Example source code For 32 bit install a .DSW Visual C++ project For 64 bit install a .SNL Visual Studio 2010 project



Device Manager Once MATRIX setup is complete, the Windows Device manager will show the GRT devices as shown below Note: For each card installed there will be a Matrix PCIe Card entry



Upgrading Installed Products To upgrade a previously installed Matrix product, run the normal installation steps until the following dialog below pops up. The old install must be removed to do a full upgrade to the newest version. Click on “Remove” as shown below.

Once the install is removed, run the “GRSETUP.EXE” and follow the normal installation steps. Note: A manual removal of the old install can also be done in Windows Control panel as shown below. Click on and remove the “Matrix” products from “Great River Technology”



Reboot your computer and you are finished upgrading

Windows MATRIX SDK/API Install Guide · Windows MATRIX SDK/API Install Guide For use with Windows Operating System Matrix series products December 12, 2012

Documents