xPCI-3001 API

Functions

_INT_ i_PCI3001_StopTimer (BYTE_ b_BoardHandle)
 
_INT_ i_PCI3001_ReadTimer (BYTE_ b_BoardHandle, PLONG_ pl_ReadValue)
 
_INT_ i_PCI3001_WriteTimer (BYTE_ b_BoardHandle, LONG_ l_WriteValue)
 
_INT_ i_PCI3001_InitTimer (BYTE_ b_BoardHandle, LONG_ l_DelayValue, BYTE_ b_InterruptFlag)
 
_INT_ i_PCI3001_StartTimer (BYTE_ b_BoardHandle)
 

Detailed Description

Function Documentation

_INT_ i_PCI3001_StopTimer ( BYTE_  b_BoardHandle)

Stops the timer.

Parameters
[in]b_BoardHandle: Handle of the board
Return values
0: No Error
-1: The handle parameter of the board is wrong
-2: Timer has not been initialised
-3: Timer has not been started
_INT_ i_PCI3001_ReadTimer ( BYTE_  b_BoardHandle,
PLONG_  pl_ReadValue 
)

Reads the current value of the timer.

Parameters
[in]b_BoardHandle: Handle of the board
[out]pl_ReadValue: Current timer value (from 0 to FFFFFF Hex)
Return values
0: No Error
-1: The handle parameter of the board is wrong
-2: Timer has not been initialised
_INT_ i_PCI3001_WriteTimer ( BYTE_  b_BoardHandle,
LONG_  l_WriteValue 
)

Writes a new value in the timer.

Parameters
[in]b_BoardHandle: Handle of the board
[in]l_WriteValue: New timer value (from 0 to FFFFFF Hex)
Return values
0: No Error
-1: The handle parameter of the board is wrong
-2: Timer has not been initialised
_INT_ i_PCI3001_InitTimer ( BYTE_  b_BoardHandle,
LONG_  l_DelayValue,
BYTE_  b_InterruptFlag 
)

Initialises the timer as an edge generator.

Parameters
[in]b_BoardHandle: Handle of the board
[in]l_DelayValue: Time interval of the timer from 100 μs up to 838.5 s
[in]b_InterruptFlag: PCI3001_ENABLE: an interrupt is generated at the end of each time interval PCI3001_DISABLE: No interrupt is generated.
Return values
0: No Error
-1: The handle parameter of the board is wrong
-2: The user interrupt routine has not been installed. See function "i_PCI3001_SetBoardIntRoutineXX"
-3: The interrupt parameter is wrong
-4: Time selection is wrong
_INT_ i_PCI3001_StartTimer ( BYTE_  b_BoardHandle)

Starts the timer.

Parameters
[in]b_BoardHandle: Handle of the board
Return values
0: No Error
-1: The handle parameter of the board is wrong
-2: Timer has not been initialised