Software Library API naibrd 1.62
See all documentation at naii.docs.com
IRIG Basic Configuration Functions: IRIG Digital I/O Signal Level

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetDigitalInput (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_signal_level_t signalLevel)
 Set the IRIG digital input to either RS485 or RS232 when not using the analog IRIG signal.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetDigitalInput (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_signal_level_t *p_outsignalLevel)
 Gets the IRIG digital input signal level (RS485 or RS232).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetDigitalLevel (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_signal_type_t signalType, naibrd_irig_signal_level_t signalLevel)
 Set the IRIG digital output signal level for either RS485 or RS232. b0: IRIG Digital out: 1=RS485, 0=RS232 b1: 1PPS out, event in: 1=RS485, 0=RS232.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetDigitalLevel (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_signal_type_t signalType, naibrd_irig_signal_level_t *p_outsignalLevel)
 Gets the IRIG digital output signal level (RS485 or RS232).
 

Detailed Description


Function Documentation

◆ naibrd_IRIG_GetDigitalInput()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetDigitalInput ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_signal_level_t * p_outsignalLevel )

Gets the IRIG digital input signal level (RS485 or RS232).

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]).
p_outsignalLevel: (Output) Input signal level (NAIBRD_IRIG_SIGNAL_LEVEL_RS232 or NAIBRD_IRIG_SIGNAL_LEVEL_RS485).
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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IRIG_GetDigitalLevel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetDigitalLevel ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_signal_type_t signalType,
naibrd_irig_signal_level_t * p_outsignalLevel )

Gets the IRIG digital output signal level (RS485 or RS232).

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]).
signalType: (Input) Signal Type: refer to naibrd_irig_signal_type_t definition.
p_outsignalLevel: (Output) NAIBRD_IRIG_SIGNAL_LEVEL_RS232 for RS-232, NAIBRD_IRIG_SIGNAL_LEVEL_RS485 for RS-485.
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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid signalType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IRIG_SetDigitalInput()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetDigitalInput ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_signal_level_t signalLevel )

Set the IRIG digital input to either RS485 or RS232 when not using the analog IRIG signal.

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]).
signalLevel: (Input) NAIBRD_IRIG_SIGNAL_LEVEL_RS232 for RS-232, NAIBRD_IRIG_SIGNAL_LEVEL_RS485 for RS-485.
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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.
  • NAI_ERROR_INVALID_VALUE when invalid input value is supplied.

◆ naibrd_IRIG_SetDigitalLevel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetDigitalLevel ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_signal_type_t signalType,
naibrd_irig_signal_level_t signalLevel )

Set the IRIG digital output signal level for either RS485 or RS232. b0: IRIG Digital out: 1=RS485, 0=RS232 b1: 1PPS out, event in: 1=RS485, 0=RS232.

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]).
signalType: (Input) Signal Type: refer to naibrd_irig_signal_type_t definition.
signalLevel: (Input) NAIBRD_IRIG_SIGNAL_LEVEL_RS232 for RS-232, NAIBRD_IRIG_SIGNAL_LEVEL_RS485 for RS-485.
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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid signalType parameter or invalid signalLevel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.