Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
SEP Duration Functions
IOCT Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_SetSEPPulse (int32_t cardIndex, int32_t module, int32_t channel, float64_t pulsewidth_ms)
 Sets the IOCT SEP pulse high time for the specified IOCT module. The IOCT SEP pulse high time is user-configurable, with a default of 1.25 msec. The value is set in steps of the internal high-speed clock (11.303 nsec).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_GetSEPPulse (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outpulsewidth_ms)
 Retrieves the IOCT SEP pulse high time for the specified IOCT module. The IOCT SEP pulse high time is user-configurable, with a default of 1.25 msec. The value is set in steps of the internal high-speed clock (11.303 nsec).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_SetSEPPulseLowTime (int32_t cardIndex, int32_t module, int32_t channel, float64_t lowtime_ms)
 Sets the IOCT SEP pulse low time for the specified IOCT module. The IOCT SEP pulse low time is user-configurable, with a default of 98.75 msec. The value is set in steps of the internal high-speed clock (11.303 nsec).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_GetSEPPulseLowTime (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outlowtime_ms)
 Retrieves the IOCT SEP pulse low time for the specified IOCT module. The IOCT SEP pulse low time is user-configurable, with a default of 98.75 msec. The value is set in steps of the internal high-speed clock (11.303 nsec).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_SetSEPTxWindow (int32_t cardIndex, int32_t module, int32_t channel, float64_t txwindow_ms)
 Sets the window after the triggering edge of the SEP pulse during which a message may be initiated for the specified IOCT module. The IOCT SEP Tx Window is user-configurable, with a default of 340 usec. The value is set in steps of the internal high-speed clock (11.303 nsec).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_GetSEPTxWindow (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outtxwindow_ms)
 Retrieves the window after the triggering edge of the SEP pulse during which a message may be initiated for the specified IOCT module. The IOCT SEP Tx Window is user-configurable, with a default of 340 usec. The value is set in steps of the internal high-speed clock (11.303 nsec).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_SetSEPManualMode (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Sets the manual SEP mode enable bit. When the manual SEP mode is enabled, the SEP may be controlled directly calling the naibrd_IOCT_SetSEPManualState to set the SEP state. As such, control will be limited to the speed of the software, and underlying communication method (Ethernet versus Bus). When loopback testing, the receiver will nominally ignore messages received outside of a specified time window following the SEP edge (2 msec for Master and 500 usec for Slave). The window may be disabled by setting the RX Always bit (IOCT_CMD_RX_ALWAYS) in the Command Register.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_GetSEPManualMode (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outenable)
 Retrieves the manual SEP mode enable bit. When the manual SEP mode is enabled, the SEP may be controlled directly calling the naibrd_IOCT_SetSEPManualState to set the SEP state. As such, control will be limited to the speed of the software, and underlying communication method (Ethernet versus Bus). When loopback testing, the receiver will nominally ignore messages received outside of a specified time window following the SEP edge (2 msec for Master and 500 usec for Slave). The window may be disabled by setting the RX Always bit (IOCT_CMD_RX_ALWAYS) in the Command Register.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_SetSEPManualState (int32_t cardIndex, int32_t module, int32_t channel, uint8_t state)
 Sets the manual SEP state. When the manual SEP mode is enabled, the SEP may be controlled directly calling the naibrd_IOCT_SetSEPManualState to set the SEP state. As such, control will be limited to the speed of the software, and underlying communication method (Ethernet versus Bus). When loopback testing, the receiver will nominally ignore messages received outside of a specified time window following the SEP edge (2 msec for Master and 500 usec for Slave). The window may be disabled by setting the RX Always bit (IOCT_CMD_RX_ALWAYS) in the Command Register.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_GetSEPManualState (int32_t cardIndex, int32_t module, int32_t channel, uint8_t *outstate)
 Retrieves the manual SEP state. When the manual SEP mode is enabled, the SEP may be controlled directly calling the naibrd_IOCT_SetSEPManualState to set the SEP state. As such, control will be limited to the speed of the software, and underlying communication method (Ethernet versus Bus). When loopback testing, the receiver will nominally ignore messages received outside of a specified time window following the SEP edge (2 msec for Master and 500 usec for Slave). The window may be disabled by setting the RX Always bit (IOCT_CMD_RX_ALWAYS) in the Command Register.
 

Detailed Description


Function Documentation

◆ naibrd_IOCT_GetSEPManualMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_GetSEPManualMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * outenable )

Retrieves the manual SEP mode enable bit. When the manual SEP mode is enabled, the SEP may be controlled directly calling the naibrd_IOCT_SetSEPManualState to set the SEP state. As such, control will be limited to the speed of the software, and underlying communication method (Ethernet versus Bus). When loopback testing, the receiver will nominally ignore messages received outside of a specified time window following the SEP edge (2 msec for Master and 500 usec for Slave). The window may be disabled by setting the RX Always bit (IOCT_CMD_RX_ALWAYS) in the Command Register.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outenable: (Output) Manual SEP Mode enable.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IOCT_GetSEPManualState()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_GetSEPManualState ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint8_t * outstate )

Retrieves the manual SEP state. When the manual SEP mode is enabled, the SEP may be controlled directly calling the naibrd_IOCT_SetSEPManualState to set the SEP state. As such, control will be limited to the speed of the software, and underlying communication method (Ethernet versus Bus). When loopback testing, the receiver will nominally ignore messages received outside of a specified time window following the SEP edge (2 msec for Master and 500 usec for Slave). The window may be disabled by setting the RX Always bit (IOCT_CMD_RX_ALWAYS) in the Command Register.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outstate: (Output) Manual SEP state (1 - high, 0 - low).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IOCT_GetSEPPulse()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_GetSEPPulse ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * outpulsewidth_ms )

Retrieves the IOCT SEP pulse high time for the specified IOCT module. The IOCT SEP pulse high time is user-configurable, with a default of 1.25 msec. The value is set in steps of the internal high-speed clock (11.303 nsec).

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outpulsewidth_ms: (Output) SEP Pulse width in milliseconds.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IOCT_GetSEPPulseLowTime()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_GetSEPPulseLowTime ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * outlowtime_ms )

Retrieves the IOCT SEP pulse low time for the specified IOCT module. The IOCT SEP pulse low time is user-configurable, with a default of 98.75 msec. The value is set in steps of the internal high-speed clock (11.303 nsec).

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outlowtime_ms: (Output) SEP Pulse low time in milliseconds.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IOCT_GetSEPTxWindow()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_GetSEPTxWindow ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * outtxwindow_ms )

Retrieves the window after the triggering edge of the SEP pulse during which a message may be initiated for the specified IOCT module. The IOCT SEP Tx Window is user-configurable, with a default of 340 usec. The value is set in steps of the internal high-speed clock (11.303 nsec).

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outtxwindow_ms: (Output) SEP Transmit Window in milliseconds.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IOCT_SetSEPManualMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_SetSEPManualMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t enable )

Sets the manual SEP mode enable bit. When the manual SEP mode is enabled, the SEP may be controlled directly calling the naibrd_IOCT_SetSEPManualState to set the SEP state. As such, control will be limited to the speed of the software, and underlying communication method (Ethernet versus Bus). When loopback testing, the receiver will nominally ignore messages received outside of a specified time window following the SEP edge (2 msec for Master and 500 usec for Slave). The window may be disabled by setting the RX Always bit (IOCT_CMD_RX_ALWAYS) in the Command Register.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
enable: (Input) Manual SEP Mode enable.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IOCT_SetSEPManualState()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_SetSEPManualState ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint8_t state )

Sets the manual SEP state. When the manual SEP mode is enabled, the SEP may be controlled directly calling the naibrd_IOCT_SetSEPManualState to set the SEP state. As such, control will be limited to the speed of the software, and underlying communication method (Ethernet versus Bus). When loopback testing, the receiver will nominally ignore messages received outside of a specified time window following the SEP edge (2 msec for Master and 500 usec for Slave). The window may be disabled by setting the RX Always bit (IOCT_CMD_RX_ALWAYS) in the Command Register.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
state: (Input) Manual SEP state (1 - high, 0 - low).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IOCT_SetSEPPulse()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_SetSEPPulse ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t pulsewidth_ms )

Sets the IOCT SEP pulse high time for the specified IOCT module. The IOCT SEP pulse high time is user-configurable, with a default of 1.25 msec. The value is set in steps of the internal high-speed clock (11.303 nsec).

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
pulsewidth_ms: (Input) SEP Pulse width in milliseconds.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IOCT_SetSEPPulseLowTime()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_SetSEPPulseLowTime ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t lowtime_ms )

Sets the IOCT SEP pulse low time for the specified IOCT module. The IOCT SEP pulse low time is user-configurable, with a default of 98.75 msec. The value is set in steps of the internal high-speed clock (11.303 nsec).

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
lowtime_ms: (Input) SSEP Pulse low time in milliseconds.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IOCT_SetSEPTxWindow()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IOCT_SetSEPTxWindow ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t txwindow_ms )

Sets the window after the triggering edge of the SEP pulse during which a message may be initiated for the specified IOCT module. The IOCT SEP Tx Window is user-configurable, with a default of 340 usec. The value is set in steps of the internal high-speed clock (11.303 nsec).

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
txwindow_ms: (Input) SEP Transmit Window in milliseconds.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.