Advanced Transportation Controller (ATC) Application Programming Interface Reference Implementation (APIRI) Software User Manual
Douglas Crawford, Intelight, Inc.
Ralph W. Boaz, Pillar Consulting, Inc.
INTRODUCTION 6
1Purpose 6
1Purpose 6
2Scope 6
2Scope 6
3Document Organization 6
3Document Organization 6
CONCEPT OF OPERATIONS 6
GETTING THE APIRI SOFTWARE SOURCE CODE 8
4APRI Software Source Code Organization 8
4APRI Software Source Code Organization 8
BUILDING THE APIRI LIBRARIES 9
5Unix / Macintosh 9
5Unix / Macintosh 9
CREATING APPLICATION SOFTWARE 10
6Sample Applications 11
6Sample Applications 11
7Registering Applications in FPUI 15
7Registering Applications in FPUI 15
8Supporting Legacy Applications 15
8Supporting Legacy Applications 15
9Packaging Applications 15
9Packaging Applications 15
APIRI USER INTERFACE COMPONENTS 15
10ATC APIRI Front Panel Manager 16
10ATC APIRI Front Panel Manager 16
11Front Panel Manager Interface Guide 17
11Front Panel Manager Interface Guide 17
12ATC APIRI Configuration Information Manager 18
12ATC APIRI Configuration Information Manager 18
13Setting Date/Time 19
13Setting Date/Time 19
14Setting Ethernet 1 Parameters 20
14Setting Ethernet 1 Parameters 20
15Setting Ethernet 2 Parameters 21
15Setting Ethernet 2 Parameters 21
16Programs and Services Startup Behavior 23
16Programs and Services Startup Behavior 23
17Linux Information 26
17Linux Information 26
18ATC API Version Information 27
18ATC API Version Information 27
19Host EEPROM Information 28
19Host EEPROM Information 28
20Time Source Configuration 32
20Time Source Configuration 32
APIRI PROGRAMMATIC INTERFACE 32
21Add Transaction to fio_fiod_outputs_set 33
21Add Transaction to fio_fiod_outputs_set 33
22Add Frame Sent Callback 34
22Add Frame Sent Callback 34
23Add Timeout to fio_fiod_frame_read 39
23Add Timeout to fio_fiod_frame_read 39
24Add App_Handle to fpui_open_aux_switch/fpui_read_aux_switch 39
24Add App_Handle to fpui_open_aux_switch/fpui_read_aux_switch 39
25Add File Handle Parameter to tod_request/cancel_tick/onchange_signal() 42
25Add File Handle Parameter to tod_request/cancel_tick/onchange_signal() 42
26Add fpui_panel_present function to detect physical front panel presence 44
26Add fpui_panel_present function to detect physical front panel presence 44
27Remove fpui_get/set_led functions 46
27Remove fpui_get/set_led functions 46
28Rearrangement of System Configuration Menu Items (ATC5401 Section 3.2.1) 46
29Separate and Enhanced Ethernet Configuration Screens (ATC5401 Section 3.2.3) 47
29Separate and Enhanced Ethernet Configuration Screens (ATC5401 Section 3.2.3) 47
30Enhanced Linux Information Screen (ATC5401 Section 3.2.5) 48
30Enhanced Linux Information Screen (ATC5401 Section 3.2.5) 48
31Enhanced API Information Screen (ATC5401 Section 3.2.5) 49
31Enhanced API Information Screen (ATC5401 Section 3.2.5) 49
32Time Source Configuration Screen Addition 50
32Time Source Configuration Screen Addition 50
DEFINITIONS AND ACRONYMS 50
REFERENCES 53