Altaapi Software User's Manual
Total Page:16
File Type:pdf, Size:1020Kb
AltaAPI™ Software User’s Manual Part Number: 14301-00000-I4 Cage Code: 4RK27 ● NAICS: 334118 Alta Data Technologies LLC 4901 Rockaway Blvd, Building A Rio Rancho, NM 87124 USA (tel) 505-994-3111 ● www.altadt.com i AltaAPI™ Software User’s Manual ● 14301-00000-I4 Alta Data Technologies LLC ● www.altadt.com CUSTOMER NOTES: Document Information: Alta Software Version: 2.6.5.0 Rev I4 Release Date: November 10, 2014 Note to the Reader and End-User: This document is provided for information only and is copyright by © Alta Data Technologies LLC. While Alta strives to provide the most accurate information, there may be errors and omissions in this document. Alta disclaims all liability in document errors and any product usage. By using an Alta product, the customer or end user agrees (1) to accept Alta’s Standard Terms and Conditions of Sale, Standard Warranty and Software License and (2) to not hold Alta Members, Employees, Contractors or Sales & Support Representatives responsible for any loss or legal liability, tangible or intangible, from any document errors or any product usage. The product described in this document is not US ITAR controlled. Use of Alta products or documentation in violation of local usage, waste discard and export control rules, or in violation of US ITAR regulations, voids product warranty and shall not be supported. This document may be distributed to support government programs and projects. Third party person, company or consultant distribution is not allowed without Alta’s written permission. AltaCore, AltaCore-1553, AltaCore-ARINC, AltaAPI, AltaAPI-LV, AltaView, AltaRTVal, ENET- 1553, ENET-A429 & ENET-1553-EBR are Trademarks of Alta Data Technologies LLC, Rio Rancho, New Mexico USA Contact: We welcome comments and suggestions. Please contact us at 888-429-1553 (toll free in US) or 505-994-3111 or visit our web site for support submit forms at www.altadt.com or email us at [email protected] or [email protected]. ii AltaAPI™ Software User’s Manual ● 14301-00000-I4 Alta Data Technologies LLC ● www.altadt.com Table of Contents Table of Contents ................................................................................................. iii The AltaAPI Software Model ................................................................................. 1 Layer 0 API Modules ......................................................................................... 3 Layer 1 API Module ........................................................................................... 4 Layer 2 API Modules ......................................................................................... 5 List of Acronyms ................................................................................................ 6 The Layer 0 API .................................................................................................... 8 Layer 0 API Constants ...................................................................................... 8 The Device Identifier (Device ID – or DEVID).................................................... 9 #Define Device ID Examples for Layer 1 Programs (from ADT_L0.h): ........ 11 Layer 0 API Files ............................................................................................. 12 Layer 0 API Type Definitions ........................................................................... 12 ADT_L0_UINT32 ......................................................................................... 12 ADT_L0_UINT16 ......................................................................................... 12 ADT_L0_UINT8 ........................................................................................... 12 Error Code Constants .................................................................................. 13 Low Level Functions .................................................................................... 14 ADT_L0_AttachIntHandler ................................................................................................. 14 ADT_L0_DetachIntHandler ................................................................................................ 14 ADT_L0_MapMemory ....................................................................................................... 15 ADT_L0_MapMemory_pciInfo .......................................................................................... 16 ADT_L0_UnmapMemory ................................................................................................... 16 ADT_L0_msSleep ............................................................................................................... 17 ADT_L0_ReadMem16 ........................................................................................................ 17 ADT_L0_ReadMem32 ........................................................................................................ 18 ADT_L0_ReadSetupMem32 .............................................................................................. 18 ADT_L0_WriteMem16 ....................................................................................................... 19 ADT_L0_WriteMem32 ....................................................................................................... 19 ADT_L0_WriteSetupMem32 ............................................................................................. 20 iii AltaAPI™ Software User’s Manual ● 14301-00000-I4 Alta Data Technologies LLC ● www.altadt.com ADT_L0_ENET_ADCP_Reset .............................................................................................. 20 ADT_L0_ENET_ADCP_GetStatistics ................................................................................... 21 ADT_L0_ENET_ADCP_ClearStatistics ................................................................................. 21 The Layer 1 API .................................................................................................. 23 Channels & Devices – Basic Definition Reviewed ....................................... 24 Table Layer 1 API - 1: ARINC/A429 Device ID (DEVID) Bank Channel Assignments ......... 25 Common Layer 1 API Functions & Discussion ................................................ 26 ADT_L1.h File & 1553 or ARINC Quick Reference Guides ......................... 26 Basic Data Types ................................................................................................................ 26 Data Structures .................................................................................................................. 27 General Programming Flow ......................................................................... 27 Initializing and Closing the API .................................................................... 28 Advanced Concepts on Device Initialization ..................................................................... 28 Closing the Device – Last Step of an Application............................................................... 29 Memory Management ...................................................................................................... 29 Multi-Threaded Applications ............................................................................................. 30 Built-In-Test (BIT) Operation ........................................................................ 31 Power-On Self Test ............................................................................................................ 31 Initiated BIT ....................................................................................................................... 31 Periodic BIT ........................................................................................................................ 31 BIT Status Register ............................................................................................................. 31 Using IRIG-B Time ....................................................................................... 32 IRIG Calibration .................................................................................................................. 32 Verifying IRIG Lock ............................................................................................................. 32 Reading the IRIG time from the Global Device.................................................................. 33 Reading the LATCHED IRIG and Internal Time from a 1553/A429 Device ........................ 33 Converting Internal Time-Stamps to IRIG Time ................................................................. 34 ENET Device and Software Overview ............................................................. 35 ENET Device Programming: ADCP ............................................................ 36 Alta Passive Monitor Protocol (APMP) ........................................................ 37 AltaAPI and ENET Programming .................................................................... 38 iv AltaAPI™ Software User’s Manual ● 14301-00000-I4 Alta Data Technologies LLC ● www.altadt.com Assigning IP Addresses ...................................................................................................... 38 Initialize the Device ........................................................................................................... 38 Checking the ADCP Connection Status .............................................................................. 38 System and Network Performance with ENET Devices ....................................................