Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Standard Operation Functions
NAI Board Library - Module Functions » DT Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetInputState (int32_t cardIndex, int32_t module, int32_t channel, naibrd_dt_state_t *p_inputState)
 Retrieves the Input State for the specified Discrete channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetVoltage (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outVoltage)
 Retrieves the voltage measurement for the specified Discrete channel. Feature only available on newer K6 Ver.4 releases.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetCurrent (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outCurrent_mA)
 Retrieves the current measurement for the specified Discrete channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetBankVccVoltage (int32_t cardIndex, int32_t module, int32_t bank, float64_t *p_outVoltage)
 Retrieves the Vcc voltage reading at the input pin for the channel bank.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetBitStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_dt_bit_status_type_t type, nai_status_bit_t *p_outstatusBit)
 Retrieves the bit status for the specified Discrete channel and bit status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_dt_chan_mapped_status_type_t statusType, nai_status_bit_t *p_outstatusBit)
 Retrieves the status for the specified Discrete channel and status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_ClearChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_dt_chan_mapped_status_type_t statusType)
 Clears the latched or realtime status for the specified Discrete channel and status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_dt_status_type_t type, nai_status_bit_t *outstatusBit)
 Retrieves the status for the specified Discrete channel and status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_ClearStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_dt_status_type_t type)
 Clears the latched status for the specified Discrete channel and status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetCurrent_mA (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outcurrent_mA)
 Retrieves the current measurement in milliamps for the specified Discrete channel.
 

Detailed Description

Function Documentation

◆ naibrd_DT_ClearChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_ClearChanMappedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_dt_chan_mapped_status_type_t statusType )

Clears the latched or realtime status for the specified Discrete channel and status type.

Note
If any realtime status type is provided, the function will return NAI_ERROR_INVALID_VALUE since realtime status bits are not cleared by the user.
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]).
statusType: (Input) Status Type: refer to naibrd_dt_chan_mapped_status_type_t definition.
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 status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_ClearStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_ClearStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dt_status_type_t type )

Clears the latched status for the specified Discrete channel and status type.

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]).
type: (Input) Status Type: refer to nai_dt_status_type_t definition.
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 status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_GetBankVccVoltage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetBankVccVoltage ( int32_t cardIndex,
int32_t module,
int32_t bank,
float64_t * p_outVoltage )

Retrieves the Vcc voltage reading at the input pin for the channel bank.

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]).
bank: (Input) Channel Bank number (1 - [max channel banks for module]).
p_outVoltage: (Output) Vcc Voltage reading in volts.
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_VALUE when invalid bank parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_GetBitStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetBitStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_dt_bit_status_type_t type,
nai_status_bit_t * p_outstatusBit )

Retrieves the bit status for the specified Discrete channel and bit status type.

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]).
type: (Input) Status Type: refer to nai_dt_bit_status_type_t definition.
p_outstatusBit: (Output) 0 for Normal, 1 Failure Detected.
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 status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_GetChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetChanMappedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_dt_chan_mapped_status_type_t statusType,
nai_status_bit_t * p_outstatusBit )

Retrieves the status for the specified Discrete channel and status type.

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]).
statusType: (Input) Status Type: refer to naibrd_dt_chan_mapped_status_type_t definition.
p_outstatusBit: (Output) 0 for Normal, 1 Failure Detected.
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 status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_GetCurrent()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetCurrent ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * p_outCurrent_mA )

Retrieves the current measurement for the specified Discrete channel.

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_outCurrent_mA: (Output) Current reading in miliamps.
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_DT_GetCurrent_mA()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetCurrent_mA ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * p_outcurrent_mA )

Retrieves the current measurement in milliamps for the specified Discrete channel.

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_outcurrent_mA: (Output) Current reading in milliamps.
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_DT_GetInputState()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetInputState ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_dt_state_t * p_inputState )

Retrieves the Input State for the specified Discrete channel.

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_inputState: (Output) NAIBRD_DT_STATE_LO or NAIBRD_DT_STATE_HI.
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_DT_GetStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dt_status_type_t type,
nai_status_bit_t * outstatusBit )

Retrieves the status for the specified Discrete channel and status type.

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]).
type: (Input) Status Type: refer to nai_dt_status_type_t definition.
outstatusBit: (Output) 0 for Normal, 1 Failure Detected.
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 status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DT_GetVoltage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetVoltage ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * p_outVoltage )

Retrieves the voltage measurement for the specified Discrete channel. Feature only available on newer K6 Ver.4 releases.

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_outVoltage: (Output) Voltage reading in volts.
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.