ARINC429 Windows SDK Getting Started Manual · 4 AIT ARINC-429 Windows SDK Getting Started Manual 1.4Applicable Documents AIT has developed several documents that may be used to aid

February 2013

Getting Started Manual

ARINC429 Windows SDK GettingStarted Manual

V01.00.00 Rev. A

V01.00.00 Rev. A

Getting Started Manual

ARINC429 Windows SDK Getting Started Manual

February 2013

AIT ARINC-429 Windows SDK Getting Started Manual II

Table of Contents

Section 1 ....................................................................................................1INTRODUCTION

.................................................................................................................... 11.1 About this Manual

.................................................................................................................... 31.2 How this Manual is Organized

.................................................................................................................... 31.3 General Documentation Conventions

.................................................................................................................... 41.4 Applicable Documents

Section 2....................................................................................................5

NEW SDK AND HARDWARE INSTALLATIONPROCEDURE

.................................................................................................................... 52.1 SDK Installation

.................................................................................................................... 102.2 Hardware Installation

...................................................................................................... 112.2.1 Installing the AIT Hardware

...................................................................................................... 112.2.2 Installing the Windows XP/7 Driver

Section 3 ....................................................................................................17SDK UPGRADE PROCEDURE

.................................................................................................................... 173.1 Removing Previously Installed Drivers and SDK

.................................................................................................................... 193.2 Install the New SDK

.................................................................................................................... 193.3 Update the Onboard Firmware/FPGA

...................................................................................................... 193.3.1 Update Firmware on 429 Modules

.................................................................................................................... 213.4 Installing the New Windows Driver

Section 4 ....................................................................................................22AIT FLIGHT SIMULYZER

Section 5 ....................................................................................................24ARINC-429 SOFT FRONT PANEL

Section 6 ....................................................................................................27COMPILING AND RUNNING A SAMPLE PROJECT

Section 7 ....................................................................................................29DOWNLOADING THE SDK FROM AVIFTECH.COM

AIT ARINC-429 Windows SDK Getting Started Manual 1

1 INTRODUCTION

1.1 About this Manual

This Getting Started Manual has been developed to assist first time users of AITARINC429 interface modules with software installation, hardware setup, and starting asample project.

Step by step instructions cover PMC/XMC/PCI/PCIe/PXI/USB/PC104p-429 SoftwareDevelopment Kit (SDK) installation, board installation, and driver configuration. TheSDK provides users with current documentation, board drivers, and sampledevelopment projects. Additionally, the SDK provides utility files that are used toupgrade the 429 board and the onboard firmware, which is also described in thismanual. The current version of all SDKs are available from the DOWNLOAD AREAof the AIT website at http://www.aviftech.com.

AIT is also a leading designer and manufacturer of other high performance test andsimulation modules, databus analyzer software, and systems for MIL-STD-1553 A/B,ARINC664/AFDX, MIL-STD-1760E, Fibre Channel, Time-Triggered Ethernet, andTime-Triggered Protocol. Supported hardware platforms include PMC, XMC,PCI/PCI-X, PCIe, PXI/PXIe, cPCI, PC104+, USB, VME, and VXI.

Information about all AIT products can be found at http://www.aviftech.com.

AIT ARINC-429 Windows SDK Getting Started Manual2

DOCUMENT HISTORY

VersionCoverDate

Created by Description

V01.00.00 Rev.A

February2013

T. Fleissner Screenshot updates and content corrections


1.2 How this Manual is Organized

This manual is organized as follows:

Section 1, INTRODUCTION, contains an overview of this manual.

Section 2, NEW SDK INSTALLATION PROCEDURE, describes theprocedure used to install the SDK software and thePMC/XMC/PCI/PCIe/PXI/PC104p-429 hardware on a system that doesnot have a previous SDK installed.

Section 3, SDK UPGRADE PROCEDURE, describes the procedure used toupgrade the SDK software and the onboard flash firmware on a systemthat has a previous SDK installed.

Section 4, AIT FLIGHT SIMULYZER, contains a description and diagramsof AIT's 429 Full Function Analyzer.

Section 5, ARINC-429 SOFT FRONT PANEL, contains a description andAIT's Soft Front Panel GUI application.

Section 6, COMPILING AND RUNNING A SAMPLE PROJECT, containsthe procedure used to open, build, and run a sample project included inthe SDK. Microsoft Visual C++ is used.

Section 7, DOWNLOADING THE SDK FROM AVIFTECH.COM,provides the steps to download a new SDK from AIT's full servicetechnical website, www.aviftech.com.

1.3 General Documentation Conventions

We use a number of different styles of text and layout in this document to helpdifferentiate between the different kinds of information. Here are some examples of thestyles we use and an explanation of what they mean:

Italics - used as a placeholder for the actual name, filename, or version of thesoftware in use

Bold text - a function, or parameter, or used to highlight important information

Bold Blue - will be used to show reference documentation

Bold italics - caution, warning or note


1.4 Applicable Documents

AIT has developed several documents that may be used to aid the user with otheraspects of our ARINC429 bus interface cards. These documents and a summary oftheir contents are listed below:

· Software Library Reference Manual for AIT 429 Windows Applications,provides the 429 application developer with detailed programming informationincluding library function call and header file details and specific troubleshootinginformation. This guide is to be used in conjunction with the 429 Programmer'sGuide.

· PMC429 Hardware Manual - for the PMC429 PMC modules. Provides hardwareinstallation instructions, board connections, technical data, and a generaldescription of the hardware architecture.

· PCI-C429 Hardware Manual - for the PCI-C429 PCIbus modules. Provideshardware installation instructions, board connections, technical data, and a generaldescription of the hardware architecture.

· PCIe-C429 Hardware Manual - for the PCIe-C429 PCIebus modules. Provideshardware installation instructions, board connections, technical data, and a generaldescription of the hardware architecture.

· PXI-C429 Hardware Manual - for the PXI-C429 PXI/PXIe/cPCI modules.Provides hardware installation instructions, board connections, technical data, and ageneral description of the hardware architecture.

· PC104p-429 Hardware Manual - for the PC104p-429 PC104+ modules. Provideshardware installation instructions, board connections, technical data, and a generaldescription of the hardware architecture.

· USB-429 Hardware Manual - for the USB-429 modules. Provides hardwareinstallation instructions, board connections, technical data, and a generaldescription of the hardware architecture.


2 NEW SDK AND HARDWARE INSTALLATIONPROCEDURE

This section contains the procedure used to install the SDK software and the 429hardware on a system that does not have a previous 429 SDK installed. If installing ona system that has a previous version of the SDK installed, the SDK upgrade proceduredescribed in Section 3 should be used.

The 429 SDK contains reference documentation, board drivers, sample developmentprojects, and firmware upgrade utility files. These files are automatically loaded ontothe system by installing the SDK software package.

The software is available on CD from AIT or via a download from www.aviftech.com.

2.1 SDK Installation

To properly install the AIT 429 SDK and hardware:

a. Complete the procedure described in SDK Software Installation.

b. Perform the procedure described in Hardware Installation.

Note: In order to ensure proper installation, it is important that the SDK Softwareinstallation is completed before the 429 hardware is installed.

The 429 SDK includes the following resources which will be installed on yourcomputer upon completion of the steps described in this section:

· Software Library Reference Manual· SDK Release Notes· Windows System Drivers· Onboard firmware update utilities· Sample project

· To install the SDK software from the AIT-provided CD or a download fromwww.aviftech.com:

1. If using the AIT provided CD, insert the CD into the CD ROM drive.The Setup Application will automatically start after a few seconds.

If the Setup Application does not start after a few seconds, or if theSDK is being installed from an aviftech.com download, the SetupApplication must be manually started.

http://www.aviftech.com


2. To Start the application manually, navigate to the CD ROM drive or thedownload directory and double click the Setup.exe icon, or start it withthe Start | Run... command.

3. Once the Setup Application has started, step through the install wizardto complete the installation.

You will be given the opportunity to choose the directory where theSDK is to be installed. Default locations can also be used.

4. Follow the onscreen instructions, to begin installation, press Next

5. You will be prompted to select the components to install. The tablebelow describes each of these components. after selecting allcomponents that you wish to install, press Next.


Component DescriptionA429 C-Api ARINC-429 High Level C API providing a

standard C interface to the high level functions ofthe ARINC-429 modules.

OWL C/C++ API (PCI) ARINC-429 Object Wrapper Layer API Libraryincluding all required include files, link library, anddynamic link library. Also includes sampleapplications and utilities.

OWL .NET Assembly ARINC429 Object Wrapper Layer API Library for .NET applications. Provides support for C#, VB.NET, and VC++

Flight Simulyzer ARINC-429 Analyzer and Configuration Tool GUIApplication

PCI Device Drivers andFirmware

ARINC-429 Hardware module device drivers andon-board firmware. This component is needed onsystems where the ARINC-429 hardwaremodules will be installed.

Visual C++ 2005 SP1 RuntimeThe Microsoft Visual C++ 2005 Service Pack1runtime. This component may be required onsystems that do not have the latest Visual Studioruntime installed.




6. Review the installation tasks and, when ready, press Install to begincopying files to disk.

7. When prompted, choose whether or not the computer should be restartedafter the installer exits. If you have installed the VISA drivers andfirmware then you must restart the computer in order for the ARINC-429hardware modules to be restarted with the new drivers. (See the nextsection for Hardware installation instructions)


The SDK installation will result in the creation of the following Program Folder iconswhich can be located by going to Start | All Programs | Avionics InterfaceTechnologies | ARINC-429 SDK vX.X.X:

The SDK installation will also result in the creation of the directory structure shownbelow. The AIT directory will be located in x:\Program Files\AIT. The Program Filesdirectory will be located on the drive that was chosen during the SDK install


The folder contents are:

C++ API High Level OWL C/C++ Object Oriented API, includinglibraries, reference manuals, sample projects, etc

C API High Level ANSI C API, including libraries, referencemanuals, sample projects, etc

Front Panel The Soft Front Panel provides a simple and easy to useGraphical User's Interface to the AIT ARINC-429hardware modules.

Hardware Utils Update utilities that are used to update onboard firmware

NET API .NET API, , including libraries, reference manuals,sample projects, etc

2.2 Hardware Installation

Once you have installed the SDK as described in SDK Installation, you can now begininstallation of the hardware and associated driver. The 429 board features full'plug-and-play' capability. There are no jumpers or switches to modify beforeinstallation.

The hardware installation is completed by performing the steps as described below:

a. Install the 429 board as described in Installing the AIT Hardware.


b. Install and verify the Windows driver using Driver installation for aWindows XP/7 system.

2.2.1 Installing the AIT Hardware

ESD Warning!!! The 429 boards are typical electronic devices that are sensitive toelectrostatic discharge. It is important to observe normal precautions whenhandling the board to prevent damage.

· To install the PCI/PCIx/PCIe/PXI-C429 board:

1. Power off the PC.

2. Insert the board into an available PCI slot.

3. Reboot the PC.Windows will recognize the new hardware as a PCI/PCIe-C429 board ora PCI Bridge Device and start the Found New Hardware Wizard.

· To install the PMC429 board:

1. Power off the PC.

2. Insert the PMC429 board into an available PCI slot via a PMC-Adapteror insert the PMC429 board into an available cPCI slot via a PMCcarrier board.

3. Reboot the PC.Windows will recognize the new hardware as a PMC429 board or a PCIMemory Controller and start the Found New Hardware Wizard.

2.2.2 Installing the Windows XP/7 Driver

The following procedures perform installation and verification of the Windows XP/7driver. The Hardware Wizard will be directed to obtain the Windows XP/7 driver forthe 429 board from:

C:\Program Files\AIT\Drivers\UAPI PCI Drivers vX.X.X

· To install the Windows XP/7 driver:

1. When the computer starts up, the “Found New Hardware Wizard” willstart. Follow the wizard, choosing the illustrated options.

Install from a list or specific location (Advanced)


Then select the Next button. (You do not need the installation CDinserted into the CD drive.)

2. Install the software automatically.



3. The wizard will find the appropriate driver files.

4. Press Finish to complete the installation.


· To verify proper installation of Windows XP/7 driver:

1. Go to Start | Control Panel and select System, then click on theHardware tab and select the Device Manager… button.For Windows XP users it may be necessary to first select Start | ControlPanel | Switch to Classic View in order to find the System icon.

2. In the Device Manager window, expand the AIT Components entry byclicking on it.


· AITUAPI : AIT's Lower Level Driver Node· USB-A429 : The ARINC-429 Hardware Module (depends on board type)

NOTE: Both of these nodes need to be present in order forthe module to be installed correctly

3. If the Device Manager appears with both nodes as shown above,installation is complete. If not, continue to Step 4.

4. If the AITUAPI node is not present, the lower level AITUAPI driver wasnot correctly installed on the system. To fix this, go to the directory: C:\Program Files\AIT\Drivers\UAPI PCI Drivers vX.X.X and runDriverInstall.bat. After this completes, check Device Manager andverify the AIT 429 node appears.

5. If the AIT 429 node now appears, Scan for Hardware Changes by rightclicking in the Device Manager window, and repeat Steps 1 - 3.


3 SDK UPGRADE PROCEDURE

This section contains the procedures used to upgrade the SDK for the 429 module on asystem which has a previous version of the 429 SDK installed. This proceduredescribes the steps which must be taken to upgrade both the host PC driver softwareand the onboard target driver software. The SDK is available on CD from AIT or via a download from www.aviftech.com. Appendix A contains instructions for performing the download.

· To properly update the 429 SDK:

1. Remove the old driver and SDK.

2. Install the new SDK.

3. Update the onboard flash firmware.

4. Complete the upgrade by installing the new AIT device driver.

3.1 Removing Previously Installed Drivers and SDK

Before installing the new 429 SDK, it is recommended that the previously installeddrivers and SDK are removed from the system.

· To remove the previously installed Windows XP/7 driver:

1. Go to Start | Settings | Control Panel | System. Then select theHardware Tab. In the Hardware Tab select the Device Manager…button. (For Windows XP users it may be necessary to first select Start |Control Panel | Switch to Classic View in order to find the Systemicon)


2. In the Device Manager window, right click over the AITUAPI and theUSB-A429 entry and select Uninstall.

3. Confirm the device removal by selecting the OK button.

4. Next, delete the following files if they exist:

x:\Windows\System32\Drivers\aituapi.sys


x:\Windows\System32\Drivers\kpuapi.sys

x:\Windows\INF\oemxx.inf (where xx = number)

INF is a hidden folder, to find this folder you may first need to select Tools|FolderOptions|View tab|Show hidden files and folders inWindows Explorer.

Note: Windows creates the oemxx.inf installation files (where xx =number) when installing new drivers. Therefore, it will be necessary todetermine the actual name that Windows has assigned to the AIT 429 driver.inf file (for example, oem0.inf or oem11.inf). To find the actual nameof the .inf file, search the INF folder for the text "AIT" and verify thecontents are related to the AIT driver using a text editor such as Notepad orWordpad prior to deletion.

5. Now, remove the SDK by going to C:\Program Files\AIT\ARINC-429SDK vX.X.X and selecting unins000.exe

3.2 Install the New SDK

Once the old SDK and drivers have been removed, the upgrade may continue with theinstallation of the new SDK. The new SDK may be obtained via a download fromwww.aviftech.com, or from an AIT-provided CD. To install the new SDK from theAIT-provided CD or a download from www.aviftech.com, see Section 2.1.

3.3 Update the Onboard Firmware/FPGA

This section contains the procedures used to update the onboard firmware on theARINC-429 module when upgrading to a newer version of the Software DevelopmentKit. By installing the SDK, all the files necessary to update the onboard Flash firmwareare also installed. AIT recommends updating the onboard firmware to guarantee properoperation.

3.3.1 Update Firmware on 429 Modules

A typical installation of the Windows SDK will contain an assortment of files withinC:\Program Files\AIT\ARINC-429 vX.X.X. The directory for updating the firmware is located here: C:\Program Files\AIT\ARINC-429 SDK vX.X.X\HardwareUtils\UAPI\utils

1) Run update_firmware.bat and select option (a) Show Devices.


The Hw Build ID is the firmware version that is currently loaded on the board andthe File Build ID is the firmware version that was shipped with the SDK. Youalways want these to be the same. If they are different, you need to continue andupdate the firmware.

2) To Update the Firmware, select option (b) Program Devices

You will see stars across the bottom of the window as the firmware update takesplace. This process takes about 15 minutes.


NOTE: Do not turn off the computer or stop the application in the middle ofthe update

3) Once this process completes, you will see the message below.

4) Then completely cycle power to your machine. A restart is NOT sufficient.

5) Once your machine is on, you can repeat Step 1 to verify that the Hw BuildID and the File Build ID are the same.

3.4 Installing the New Windows Driver

Once the PC is rebooted, Windows will recognize the new hardware.

To Install and verify the new Windows driver use Driver installation for a WindowsXP/7 system as described in New SDK and Hardware Installation Procedure.


4 AIT FLIGHT SIMULYZER

The Flight Simulyzer 429 Analyzer Software is used in conjunction with AIT’s familyof 429 interface boards to provide a powerful Windows-based 429 Analyzer tool. Aneasy-to-use GUI allows complete visual programming that enables users totroubleshoot, optimize, plan and configure ARINC-429 databuses. Low-level and high-level protocol analysis features work by capturing, filtering, time stamping andinterpreting ARINC-429 databus traffic and then generating advanced statistics for theusers. Flight Simulyzer’s Transmit and Receive Channel configurations are based on acommon data format (XML) which allows simulation setups created and used withinthe Flight Simulyzer application to also be loaded and executed from within the AITARINC-429 LabView instrument driver, high-level C++ and C# application interfacelibraries. This allows configurations generated by Flight Simulyzer to be utilized fromwithin user applications developed using LabView, C/C++, or C#.

The operation of the Flight Simulyzer application is documented in the FlightSimulyzer User's Guide.

The Flight Simulyzer User's Guide can be found at: Start | All Programs | AvionicsInterface Technologies | Flight Simulyzer | User's Guide



5 ARINC-429 SOFT FRONT PANEL

This section specifies the use of the ARINC-429 Soft Front Panel (SFP) GUIapplication. The SFP provides a simple and easy to use GUI interface to the ARINC-429 Instruments.

The 429 Soft Front Panel application is started from the Start | Avionics InterfaceTechnologies | ARINC-429 SDK vX.X.X | Front Panel ..... Start menu item.

When launched, the Main tab of the SFP is displayed. Board Information is display aswells as the ability to configure a transmit and receive channel and the channel speed.

NOTE: The transmit and receive channel have to be different.

Transmit OperationsThe 429 Transmitting Tab is used to define a 32-bit 429 data transfers on the transmit channel.The + and - buttons allow the user to add or delete transfers. The data can be changed bydouble clicking on the data value in the table. The configuration properties allow the user tospecify a rate and whether the transfers will be sent continuously or a specific number of times.


Receive OperationsThe 429 Receiving Tab is used to view the data the is being received by the channel. It displaysthe Timetag and the 32 bit data word. It also displays a count of the total number of wordscaptured by the channel.

NOTE: In order to view data on the receive channel, the user has to properly connect thetransmit and receive channels externally.



6 COMPILING AND RUNNING A SAMPLE PROJECT

The 429 SDK includes a Microsoft Visual C++ sample workspace that consists ofseveral 429 application sample programs. This section contains the procedure whichcan be used to compile and run any of the sample programs included in the sampleworkspace (once the SDK has been installed).

For further information regarding development of a 429 application software programto interface to the 429 module see the 429 Software Library Reference Manual.

Note: The procedures in this section assume the use of Microsoft Visual C++ 2005, 2008, or 2010.

The processes involved in compiling and running a sample program for the OWL429C/C++ Object Oriented API include:

· Opening the sample Project· Building and executing the sample program

· To Open the sample Project, double click on the Samples.sln located inC:\Program Files\AIT\ARINC-429 SDK vX.X.X\C++API\samples\projects\vs20xxsp1


· To Build and Execute a Sample Program:

1. Using File View, right click on any sample program (ex. Samples) andselect Set as StartUp Project.

2. Select Build | Build Samples.

3. The program can now be executed by selecting Debug | StartDebugging or go to the Output directory and run the Samples.exe.

· Similarily, samples for the High Level ANSI C API and .NET API are located inC:\Program Files\AIT\ARINC-429 SDK vX.X.X\C-API\samples and C:\ProgramFiles\AIT\ARINC-429 SDK vX.X.X\NET API\samples, respectively.


7 DOWNLOADING THE SDK FROM AVIFTECH.COM

The AIT DOWNLOAD AREA consists of current manuals, SDKs, and documentationcategorized by product.

· To obtain the 429 SDK, Product Guides, Datasheets, and Hardware Manualsfrom the Download Area:

1. The SDK can be downloaded directly from the Download Area of the AITWebsite. The Download Area is accessible via the Download Area link located at thetop of the AIT Home page - www.aviftech.com.

2. Once in the Download Area, login using your Customer (User) ID andPassword. If you do not already have a user account for Aviftech.com, you can registerto create one.

http://www.aviftech.com/download-area/

http://www.aviftech.com/download-area/





3. The software is accessible from within the 429 | 429 Windows software productpage as shown below.
