xPCI-3009 API
PCI-3009 SSI raw data functions

Functions

_INT_ i_PCI3009_InitSSIRawData (DWORD_ dw_BoardHandle, BYTE_ b_SSIProfile, DWORD_ dw_SSIOutputClock)
 
_INT_ i_PCI3009_Read1SSIRawDataValue (DWORD_ dw_BoardHandle, BYTE_ b_SelectedSSI, PDWORD_ pdw_ValueArray, BYTE_ b_ValueArraySize)
 
_INT_ i_PCI3009_ReadAllSSIRawDataValue (DWORD_ dw_BoardHandle, PDWORD_ pdw_ValueArray, BYTE_ b_ValueArraySize)
 
_INT_ i_PCI3009_StartSSIAcquisition (DWORD_ dw_BoardHandle)
 
_INT_ i_PCI3009_GetSSIAcquisitionStatus (DWORD_ dw_BoardHandle, PBYTE_ pb_Status)
 
_INT_ i_PCI3009_GetSSIValue (DWORD_ dw_BoardHandle, BYTE_ b_SelectedSSI, PDWORD_ pdw_Position, PDWORD_ pdw_TurnCpt)
 
_INT_ i_PCI3009_GetSSIRawDataValue (DWORD_ dw_BoardHandle, BYTE_ b_SelectedSSI, PDWORD_ pdw_ValueArray, BYTE_ b_ValueArraySize)
 

Detailed Description

Function Documentation

_INT_ i_PCI3009_InitSSIRawData ( DWORD_  dw_BoardHandle,
BYTE_  b_SSIProfile,
DWORD_  dw_SSIOutputClock 
)

Configure the SSI operating mode.
You must calling this function be for you call any other function witch access of SSI.

Parameters
[in]dw_BoardHandle: Handle of board PCI-3009
[in]b_SSIProfile: Selection from SSI profile length (1 to 49).
[in]dw_SSIOutputClock: Selection from SSI output clock.
From 252 to 5 000 000 Hz
Returns
0: No error
-1: The handle parameter of the board is wrong
-2: The module is not a SSI module
-3: The module does not support this profile length
-4: The selected SSI profile length is wrong
-5: The selected SSI output clock is wrong
_INT_ i_PCI3009_Read1SSIRawDataValue ( DWORD_  dw_BoardHandle,
BYTE_  b_SelectedSSI,
PDWORD_  pdw_ValueArray,
BYTE_  b_ValueArraySize 
)

Read the selected SSI counter (b_SelectedSSI)

Parameters
[in]dw_BoardHandle: Handle of board PCI-3009
[in]b_SelectedSSI: Selection from SSI counter (0 to 2)
[in]b_ValueArraySize: Size of the pdw_ValueArray in dword
[out]pdw_ValueArray: Array of the raw data from the SSI counter
Returns
0: No error
-1: The handle parameter of the board is wrong
-2: The module is not a SSI module
-3: SSI not initialised see function "i_PCI3009_InitSSI"
-4: The selected SSI is wrong
-5: The b_ValueArraySize parameter is wrong
_INT_ i_PCI3009_ReadAllSSIRawDataValue ( DWORD_  dw_BoardHandle,
PDWORD_  pdw_ValueArray,
BYTE_  b_ValueArraySize 
)

Read all SSI counter

Parameters
[in]dw_BoardHandle: Handle of board PCI-3009
[in]b_ValueArraySize: Size of the pdw_ValueArray in dword
[out]pdw_ValueArray: Array of the raw data from the SSI counter
Returns
0: No error
-1: The handle parameter of the board is wrong
-2: The module is not a SSI module
-3: SSI not initialised see function "i_PCI3009_InitSSI"
-4: The b_ValueArraySize parameter is wrong
_INT_ i_PCI3009_StartSSIAcquisition ( DWORD_  dw_BoardHandle)

Start the SSI acquisition

Parameters
[in]dw_BoardHandle: Handle of board PCI-3009
Returns
0: No error
-1: The handle parameter of the board is wrong
-2: The module is not a SSI module
-3: SSI not initialised see function "i_PCI3009_InitSSI"
-4: Acquisition already in progress
_INT_ i_PCI3009_GetSSIAcquisitionStatus ( DWORD_  dw_BoardHandle,
PBYTE_  pb_Status 
)

Return the SSI acquisition status

Parameters
[in]dw_BoardHandle: Handle of board PCI-3009
[out]pb_Status: 1 Acquisition in progress
0 Acquisition beend
Returns
0: No error
-1: The handle parameter of the board is wrong
-2: The module is not a SSI module
-3: SSI not initialised see function "i_PCI3009_InitSSI"
_INT_ i_PCI3009_GetSSIValue ( DWORD_  dw_BoardHandle,
BYTE_  b_SelectedSSI,
PDWORD_  pdw_Position,
PDWORD_  pdw_TurnCpt 
)

Read the selected SSI counter

Parameters
[in]dw_BoardHandle: Handle of board PCI-3009
[in]b_SelectedSSI: Selection from SSI counter (0 to 2)
[out]pdw_Position: SSI position in the turn
[out]pdw_TurnCpt: Number of turns
Returns
0: No error
-1: The handle parameter of the board is wrong
-2: The module is not a SSI module
-3: SSI not initialised see function "i_PCI3009_InitSSI"
-4: The selected SSI is wrong
-5: Acquisition in progress
-6: This function does not support more than 32 bits profile length
_INT_ i_PCI3009_GetSSIRawDataValue ( DWORD_  dw_BoardHandle,
BYTE_  b_SelectedSSI,
PDWORD_  pdw_ValueArray,
BYTE_  b_ValueArraySize 
)

Read the selected SSI counter

Parameters
[in]dw_BoardHandle: Handle of board PCI-3009
[in]b_SelectedSSI: Selection from SSI
[in]b_ValueArraySize: Size of the pdw_ValueArray in dword
[out]pdw_ValueArray: Array of the raw data from the SSI counter
Returns
0: No error
-1: The handle parameter of the board is wrong
-2: The module is not a SSI module
-3: SSI not initialised see function "i_PCI3009_InitSSI"
-4: The selected SSI is wrong
-5: Acquisition in progress
-6: The b_ValueArraySize parameter is wrong