Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Standard Operation Functions
Discrete Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetOutputState (int32_t cardIndex, int32_t module, int32_t channel, nai_dt_state_t state)
 Sets the Output State for the specified Discrete channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetOutputState (int32_t cardIndex, int32_t module, int32_t channel, nai_dt_state_t *p_outstate)
 Retrieves the Output State for the specified Discrete channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetInputState (int32_t cardIndex, int32_t module, int32_t channel, nai_dt_state_t *p_outstate)
 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)
 Retrieves the current measurement for the specified Discrete channel.
 
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.
 
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_GetStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_dt_status_type_t type, nai_status_bit_t *p_outstatusBit)
 Retrieves the status for the specified Discrete channel and status type. Inter-FPGA Status: Feature supported in FPGA Version >= 13.2 (8-bit rev, older than 1.9), SPL Rev >= 9 Summary Status and Watchdog Timer Status: Features supported in FPGA Version >= 1.9.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetBitStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_dt_bit_status_type_t type, nai_status_bit_t *p_outstatusBit)
 Retrieves the BIT error trigger type for the specified channel and BIT status error trigger type, when BIT status has been set. A return of 1 indicates the BIT was a result of the queried trigger type (voltage measurement, or driver error).
 
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. Inter-FPGA Status: Feature supported in FPGA Version >= 13.2 (8-bit rev, older than 1.9), SPL Rev >= 9 Summary Status and Watchdog Timer Status: Features supported in FPGA Version >= 1.9.
 

Detailed Description


Function Documentation

◆ 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. Inter-FPGA Status: Feature supported in FPGA Version >= 13.2 (8-bit rev, older than 1.9), SPL Rev >= 9 Summary Status and Watchdog Timer Status: Features supported in FPGA Version >= 1.9.

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,
nai_dt_bit_status_type_t type,
nai_status_bit_t * p_outstatusBit )

Retrieves the BIT error trigger type for the specified channel and BIT status error trigger type, when BIT status has been set. A return of 1 indicates the BIT was a result of the queried trigger type (voltage measurement, or driver error).

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_GetCurrent()

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

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: (Output) Current reading in amps.
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,
nai_dt_state_t * p_outstate )

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_outstate: (Output) NAI_DT_STATE_LO or NAI_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.

nai_dt_raw_group_t

◆ naibrd_DT_GetOutputState()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_GetOutputState ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dt_state_t * p_outstate )

Retrieves the Output 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_outstate: (Output) NAI_DT_STATE_LO or NAI_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 * p_outstatusBit )

Retrieves the status for the specified Discrete channel and status type. Inter-FPGA Status: Feature supported in FPGA Version >= 13.2 (8-bit rev, older than 1.9), SPL Rev >= 9 Summary Status and Watchdog Timer Status: Features supported in FPGA Version >= 1.9.

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.
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_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.

◆ naibrd_DT_SetOutputState()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DT_SetOutputState ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dt_state_t state )

Sets the Output 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]).
state: (Input) NAI_DT_STATE_LO or NAI_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.