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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetResistance (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outresistance)
 Retrieves the resistance measurement for the specified RTD channel. For Generation 2 and Generation 3 modules (G4), the raw data reading is scaled based upon the range setting for the RTD channel. For Generation 5 modules (RT1), the raw data reading is a 32 bits formatted as IEEE 754 Single Precision Floating Point. For Generation 5 modules (TC1) only applies to channel 8 and only in CJC mode. It returns a invalid reading if not in CJC and channel 8.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetAllResistances (int32_t cardIndex, int32_t module, int32_t arraysize, float64_t outresistances[])
 Retrieves all the resistance measurement for the specified RTD module. For Generation 2 and Generation 3 modules (G4), the raw data reading is scaled based upon the range setting for the RTD channel. For Generation 5 modules (RT1), the raw data reading is a 32 bits formatted as IEEE 754 Single Precision Floating Point.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetTemperature (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outtemperature)
 Retrieves the temperature measurement in Celsius for the specified RTD channel. This feature is available only on Generation 5 modules (RT1). For Generation 5 modules (TC1) only applies to channel 8 and only in CJC mode. It returns a invalid reading if not in CJC and channel 8.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetTemperatureEx (int32_t cardIndex, int32_t module, int32_t channel, nai_rtd_temperature_type_t tempType, float64_t *outtemperature)
 Retrieves the temperature measurement in either fahrenheit or celsius for the specified RTD channel. This feature is available only on Generation 5 modules (RT1). For Generation 5 modules (TC1) only applies to channel 8 and only in CJC mode. It returns a invalid reading if not in CJC and channel 8.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetAllTemperatures (int32_t cardIndex, int32_t module, int32_t arraysize, float64_t outtemperatures[])
 Retrieves all the temperature measurement for the specified RTD module. This feature is available only on Generation 5 modules (RT1).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetAllTemperaturesEx (int32_t cardIndex, int32_t module, nai_rtd_temperature_type_t tempType, int32_t arraysize, float64_t outtemperatures[])
 Retrieves all the temperature measurement in either fahrenheit or celsius for the specified RTD module. This feature is available only on Generation 5 modules (RT1).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_rtd_status_type_t type, uint32_t *outstatus)
 Retrieves the status for the specified RTD channel and status type. Module Summary Status: Feature supported in FPGA Version >= X.X.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_ClearStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_rtd_status_type_t type)
 Clears the latched status for the specified channel and status type. Module Summary Status: Feature supported in FPGA Version >= X.X.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetBusy (int32_t cardIndex, int32_t module, uint32_t *outbusy)
 NOTE: This API only applies to the G4 module. Retrieves the busy status indicating whether the RTD module is performing either BIT/open detection or a background calibration. Resistance data is not updated while the busy status is set.
 

Detailed Description


Function Documentation

◆ naibrd_RTD_ClearStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_ClearStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_rtd_status_type_t type )

Clears the latched status for the specified channel and status type. Module Summary Status: Feature supported in FPGA Version >= X.X.

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_rtd_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_RTD_GetAllResistances()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetAllResistances ( int32_t cardIndex,
int32_t module,
int32_t arraysize,
float64_t outresistances[] )

Retrieves all the resistance measurement for the specified RTD module. For Generation 2 and Generation 3 modules (G4), the raw data reading is scaled based upon the range setting for the RTD channel. For Generation 5 modules (RT1), the raw data reading is a 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.
outresistances: (Output) Resistance reading in ohms 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_RTD_GetAllTemperatures()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetAllTemperatures ( int32_t cardIndex,
int32_t module,
int32_t arraysize,
float64_t outtemperatures[] )

Retrieves all the temperature measurement for the specified RTD module. This feature is available only on Generation 5 modules (RT1).

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.
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_RTD_GetAllTemperaturesEx()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetAllTemperaturesEx ( int32_t cardIndex,
int32_t module,
nai_rtd_temperature_type_t tempType,
int32_t arraysize,
float64_t outtemperatures[] )

Retrieves all the temperature measurement in either fahrenheit or celsius for the specified RTD module. This feature is available only on Generation 5 modules (RT1).

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetBusy ( int32_t cardIndex,
int32_t module,
uint32_t * outbusy )

NOTE: This API only applies to the G4 module. Retrieves the busy status indicating whether the RTD module is performing either BIT/open detection or a background calibration. Resistance data is not updated while the busy status is set.

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]).
outbusy: (Output) 0 for not Busy, 1 for Busy
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_SUPPORTED when function is not supported.

◆ naibrd_RTD_GetResistance()

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

Retrieves the resistance measurement for the specified RTD channel. For Generation 2 and Generation 3 modules (G4), the raw data reading is scaled based upon the range setting for the RTD channel. For Generation 5 modules (RT1), the raw data reading is a 32 bits formatted as IEEE 754 Single Precision Floating Point. For Generation 5 modules (TC1) only applies to channel 8 and only in CJC mode. It returns a invalid reading if not in CJC and channel 8.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_rtd_status_type_t type,
uint32_t * outstatus )

Retrieves the status for the specified RTD channel and status type. Module Summary Status: Feature supported in FPGA Version >= X.X.

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_rtd_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_RTD_GetTemperature()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetTemperature ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * outtemperature )

Retrieves the temperature measurement in Celsius for the specified RTD channel. This feature is available only on Generation 5 modules (RT1). For Generation 5 modules (TC1) only applies to channel 8 and only in CJC mode. It returns a invalid reading if not in CJC and channel 8.

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]).
outtemperature: (Output) Temperature reading in celsius.
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_RTD_GetTemperatureEx()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetTemperatureEx ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_rtd_temperature_type_t tempType,
float64_t * outtemperature )

Retrieves the temperature measurement in either fahrenheit or celsius for the specified RTD channel. This feature is available only on Generation 5 modules (RT1). For Generation 5 modules (TC1) only applies to channel 8 and only in CJC mode. It returns a invalid reading if not in CJC and channel 8.

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