Sensoray 2410 API - Manual (Page 3)

Sensoray 24xx Programming Guide i Table of Contents
Table of Contents
Introduction
1.1 Scope ............................................................. 1
1.2 Description ................................................... 1
1.2.1 Software Hierarchy .......................................... 1
Installation
2.1 Executable Software Components ............. 2
2.1.1 Windows .......................................................... 2
2.1.2 Linux ................................................................ 2
2.2 Application SDK Components ................... 2
Fundamentals
3.1 Board Addressing ........................................ 3
3.1.1 Board Handles.................................................. 3
3.1.2 IP Address and Port ......................................... 3
3.1.2.1 Configuring the Network Interface ........... 3
3.2 Programming Examples ............................. 4
3.2.1 Constants.......................................................... 4
3.2.2 Data Types ....................................................... 4
3.3 Required Function Calls ............................. 4
Sessions and Transactions
4.1 Overview ...................................................... 5
4.1.1 Blocking Behavior ........................................... 5
4.1.2 Thread Safety ................................................... 5
4.2 Concurrent Transactions............................ 5
4.3 Errors ........................................................... 5
4.3.1 Error Passing Mechanism ................................ 5
4.3.2 Error Handling ................................................. 6
4.3.3 Error Codes ...................................................... 6
Module-Independent Functions
5.1 Overview ...................................................... 8
5.2 API Initialization and Shutdown ............... 8
5.2.1 s24xx_ApiOpen()............................................. 8
5.2.2 S24xx_ApiClose() ........................................... 8
5.3 Session Initialization and Shutdown.......... 9
5.3.1 s24xx_SessionOpen() ...................................... 9
5.3.2 s24xx_SessionClose() ...................................... 9
5.4 Error Functions ......................................... 10
5.4.1 s24xx_ErrorText() ......................................... 10
5.5 Status and Control .....................................11
5.5.1 s24xx_SetTimeout()....................................... 11
5.5.2 s24xx_ResetIo() ............................................. 11
5.5.3 s24xx_GetVersionInfo() ................................ 12
5.6 Timestamp Functions ................................12
5.6.1 s24xx_ReadTimestamp() ............................... 12
5.6.2 s24xx_WriteTimestamp() .............................. 13
Model 2410 Digital I/O Module
6.1 Overview .....................................................14
6.2 Digital I/O Functions .................................14
6.2.1 s2410_SetDebounceTime() ........................... 14
6.2.2 s2410_ReadDin() ........................................... 15
6.2.3 s2410_ReadDout() ......................................... 15
6.2.4 s2410_WriteDout() ........................................ 16
6.2.5 s2410_SetDoutMode()................................... 16
6.2.6 s2410_WritePwm()........................................ 17
6.3 Utility Functions.........................................17
6.3.1 s2410_SetLedBrightness()............................. 17
6.4 Event Capture Functions...........................18
6.4.1 Overview........................................................ 18
6.4.2 s2410_ReadCapFlags().................................. 18
6.4.3 s2410_AsyncCapBegin() ............................... 19
6.4.3.1 Callback Function ................................... 19
6.4.4 s2410_AsyncCapEnd() .................................. 21
6.4.5 s2410_WriteCapPolarity() ............................. 22
6.4.6 s2410_WriteCapContinuous() ....................... 22
6.4.7 s2410_WriteCapOneshot() ............................ 23
6.4.8 s2410_WriteCapDisable() ............................. 23
6.4.9 s2410_WriteCapTimer()................................ 24
Model 2426 Multi-Function I/O Module
7.1 Overview .....................................................25
7.2 Digital I/O Functions .................................25
7.2.1 s2426_SetDebounceTime() ........................... 25
7.2.2 s2426_ReadDin() ........................................... 26
7.2.3 s2426_ReadDout() ......................................... 26
7.2.4 s2426_SetDoutMode()................................... 27
7.2.5 s2426_WriteDout() ........................................ 27
7.2.6 s2426_WritePwm()........................................ 28