xPCI-3001 API

Functions

_INT_ i_PCI3001_Read1DigitalInput (BYTE_ b_BoardHandle, BYTE_ b_Channel, PBYTE_ pb_ChannelValue)
 
_INT_ i_PCI3001_Read4DigitalInput (BYTE_ b_BoardHandle, PBYTE_ pb_PortValue)
 
_INT_ i_PCI3001_Set1DigitalOutputOn (BYTE_ b_BoardHandle, BYTE_ b_Channel)
 
_INT_ i_PCI3001_Set1DigitalOutputOff (BYTE_ b_BoardHandle, BYTE_ b_Channel)
 
_INT_ i_PCI3001_Set4DigitalOutputOn (BYTE_ b_BoardHandle, BYTE_ b_Value)
 
_INT_ i_PCI3001_Set4DigitalOutputOff (BYTE_ b_BoardHandle, BYTE_ b_Value)
 
_INT_ i_PCI3001_SetOutputMemoryOn (BYTE_ b_BoardHandle)
 
_INT_ i_PCI3001_SetOutputMemoryOff (BYTE_ b_BoardHandle)
 

Detailed Description

Function Documentation

_INT_ i_PCI3001_Read1DigitalInput ( BYTE_  b_BoardHandle,
BYTE_  b_Channel,
PBYTE_  pb_ChannelValue 
)

Indicates the state of an input. The variable b_Channel passes the input to be read (1 to 4). A value is returned with the variable pb_ChannelValue: 0 (Low), 1 (High).

Parameters
[in]b_BoardHandle: Handle of the board
[out]pb_ChannelValue: State of the digital input 0 : Low, 1 : High
Return values
0: No Error
-1: The handle parameter of the board is wrong
-2: The input number is not between 1 and 4.
_INT_ i_PCI3001_Read4DigitalInput ( BYTE_  b_BoardHandle,
PBYTE_  pb_PortValue 
)

Indicates the state of the port . A value is returned with the variable pb_PortValue.

Parameters
[in]b_BoardHandle: Handle of the board
[out]pb_PortValue: State of the digital input port (0 to 15)
Return values
0: No Error
-1: The handle parameter of the board is wrong
_INT_ i_PCI3001_Set1DigitalOutputOn ( BYTE_  b_BoardHandle,
BYTE_  b_Channel 
)

Sets the output which has been passed with the parameter b_Channel. Setting an output means setting an output high.

Parameters
[in]b_BoardHandle: Handle of the board
[in]b_Channel: Number of the output to be set (1 to 4).
Return values
0: No Error
-1: The handle parameter of the board is wrong
-2: The input number is not between 1 and 4
_INT_ i_PCI3001_Set1DigitalOutputOff ( BYTE_  b_BoardHandle,
BYTE_  b_Channel 
)

Resets the output which has been passed with the parameter b_Channel. Resetting an output means setting an output low.

Parameters
[in]b_BoardHandle: Handle of the board
[in]b_Channel: Number of the output to be set (1 to 4).
Return values
0: No Error
-1: The handle parameter of the board is wrong
-2: The input number is not between 1 and 4
-3: Digital output memory is OFF. Use previously the function "i_PCI3001_SetOutputMemoryOn".
_INT_ i_PCI3001_Set4DigitalOutputOn ( BYTE_  b_BoardHandle,
BYTE_  b_Value 
)

Sets one or several outputs of a port. Setting an output means setting an output high. If you have switched OFF the digital output memory, all other outputs are set to "0"..

Parameters
[in]b_BoardHandle: Handle of the board
[in]b_Value: Output value (0 to 15)
Return values
0: No Error
-1: The handle parameter of the board is wrong
_INT_ i_PCI3001_Set4DigitalOutputOff ( BYTE_  b_BoardHandle,
BYTE_  b_Value 
)

Resets one or several outputs of one port. Resetting means setting low.

Parameters
[in]b_BoardHandle: Handle of the board
[in]b_Value: Output value (0 to 15)
Return values
0: No Error
-1: The handle parameter of the board is wrong
-2: The digital output memory is OFF. Please use previously the function "i_PCI3001_SetOutputMemoryOn".
_INT_ i_PCI3001_SetOutputMemoryOn ( BYTE_  b_BoardHandle)

Activates the digital output memory. After calling up this function, the outputs you have previously activated with the function "i_PCI3001_SetXDigitalOutputOn" are not reset. You can reset them with the function "i_PCI3001_SetXDigitalOutputOff".

Parameters
[in]b_BoardHandle: Handle of the board
Return values
0: No Error
-1: The handle parameter of the board is wrong
_INT_ i_PCI3001_SetOutputMemoryOff ( BYTE_  b_BoardHandle)

Deactivates the digital output memory.

Parameters
[in]b_BoardHandle: Handle of the board
Return values
0: No Error
-1: The handle parameter of the board is wrong