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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetVoltage (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outVoltage)
 Retrieves the voltage measurement for the specified TC channel. The raw data reading is 32 bits formatted as IEEE 754 Single Precision Floating Point.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetAllVoltages (int32_t cardIndex, int32_t module, int32_t arraysize, float64_t outVoltages[])
 Retrieves all the voltage measurements for the specified TC module. The raw data reading is 32 bits formatted as IEEE 754 Single Precision Floating Point.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetTemperature (int32_t cardIndex, int32_t module, int32_t channel, nai_tc_temperature_type_t tempType, float64_t *outTemperature)
 Retrieves the temperature measurement in either fahrenheit or celsius for the specified TC channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetAllTemperatures (int32_t cardIndex, int32_t module, nai_tc_temperature_type_t tempType, int32_t arraysize, float64_t outTemperatures[])
 Retrieves all the temperature measurement in either fahrenheit or celsius for the specified TC module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetResistance (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outresistance)
 Retrieves the resistance measurement for the specified TC channel. The raw data reading is 32 bits formatted as IEEE 754 Single Precision Floating Point. This function only applies to channel 8 and only in CJC mode. It returns an invalid reading if CJC mode is disabled. If a channel other than 8 is passed in, the function will return NAI_ERROR_INVALID_CHANNEL.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_tc_status_type_t type, nai_status_bit_t *outStatus)
 Retrieves the status for the specified TC channel and status type. Note: The background BIT test runs at intervals of up to 2 minutes, and the BIT Status is only updated at these intervals. Module Summary Status: Feature supported in FPGA Version >= 1.9.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_ClearStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_tc_status_type_t type)
 Clears the latched status for the specified channel and status type. Note: The background BIT test runs at intervals of up to 2 minutes, and the BIT Status is only updated at these intervals. Module Summary Status: Feature supported in FPGA Version >= 1.9.
 

Detailed Description


Function Documentation

◆ naibrd_TC_ClearStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_ClearStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_tc_status_type_t type )

Clears the latched status for the specified channel and status type. Note: The background BIT test runs at intervals of up to 2 minutes, and the BIT Status is only updated at these intervals. Module Summary Status: Feature 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 card 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_TC_GetAllTemperatures()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetAllTemperatures ( int32_t cardIndex,
int32_t module,
nai_tc_temperature_type_t tempType,
int32_t arraysize,
float64_t outTemperatures[] )

Retrieves all the temperature measurement in either fahrenheit or celsius for the specified TC module.

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]).
tempType: (Input) Temperature Type: refer to nai_rts_temperature_type_t definition.
arraysize: (Input) Size of the outvoltage array. If specified size is less than max channels, the voltages returned will be for channel 1 to size.
outTemperatures: (Output) Temperature reading in celsius for all channels.
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_TC_GetAllVoltages()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetAllVoltages ( int32_t cardIndex,
int32_t module,
int32_t arraysize,
float64_t outVoltages[] )

Retrieves all the voltage measurements for the specified TC module. The raw data reading is 32 bits formatted as IEEE 754 Single Precision Floating Point.

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]).
arraysize: (Input) Size of the outVoltage array. If specified size is less than max channels, the voltages returned will be for channel 1 to size.
outVoltages: (Output) Voltage reading in volts for all channels.
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_TC_GetResistance()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetResistance ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * outresistance )

Retrieves the resistance measurement for the specified TC channel. The raw data reading is 32 bits formatted as IEEE 754 Single Precision Floating Point. This function only applies to channel 8 and only in CJC mode. It returns an invalid reading if CJC mode is disabled. If a channel other than 8 is passed in, the function will return NAI_ERROR_INVALID_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]).
outresistance: (Output) Resistance reading in ohms.
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_TC_GetStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_tc_status_type_t type,
nai_status_bit_t * outStatus )

Retrieves the status for the specified TC channel and status type. Note: The background BIT test runs at intervals of up to 2 minutes, and the BIT Status is only updated at these intervals. Module Summary Status: Feature 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_tc_status_type_t definition
outStatus: (Output) A pointer to where the status is returned.
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_TC_GetTemperature()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetTemperature ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_tc_temperature_type_t tempType,
float64_t * outTemperature )

Retrieves the temperature measurement in either fahrenheit or celsius for the specified TC 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]).
tempType: (Input) Temperature Type: refer to nai_rts_temperature_type_t definition.
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outTemperature: (Output) Temperature reading in celsius or fahrenheit.
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_TC_GetVoltage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetVoltage ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * outVoltage )

Retrieves the voltage measurement for the specified TC channel. The raw data reading is 32 bits formatted as IEEE 754 Single Precision Floating Point.

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]).
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_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.