Software Library API naibrd 1.62
See all documentation at naii.docs.com
Temperature Threshold Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_SetThreshold (int32_t cardIndex, int32_t module, int32_t channel, nai_rtd_thresh_type_t type, float64_t threshold)
 This function sets the specified RTD channel's temperature threshold represented by the parameter "type." Valid threshold types are Alert Lo, Alarm Lo, Alert Hi, and Alarm Hi. If the specified channel's temperature meets or exceeds the Alarm Hi Threshold, then the bit in the Alarm Hi status register that corresponds to the channel will be set to 1. If the specified channel's temperature meets or goes below the Alarm Lo Threshold, then the bit in the Alarm Lo status register that corresponds to the channel will be set to 1. The Alert Lo register works the same way as the Alarm Lo register except that the Alert Lo threshold should not be as low as the Alarm Lo threshold. The Alert Hi register works the same way as the Alarm Hi register except that the Alert Hi threshold should not be as high as the Alarm Hi threshold.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetThreshold (int32_t cardIndex, int32_t module, int32_t channel, nai_rtd_thresh_type_t type, float64_t *outthreshold)
 This function retrieves the specified RTD channel's temperature threshold represented by the parameter "type." Valid threshold types are Alert Lo, Alarm Lo, Alert Hi, and Alarm Hi. If the specified channel's temperature meets or exceeds the Alarm Hi Threshold, then the bit in the Alarm Hi status register that corresponds to the channel will be set to 1. If the specified channel's temperature meets or goes below the Alarm Lo Threshold, then the bit in the Alarm Lo status register that corresponds to the channel will be set to 1. The Alert Lo register works the same way as the Alarm Lo register except that the Alert Lo threshold should not be as low as the Alarm Lo threshold. The Alert Hi register works the same way as the Alarm Hi register except that the Alert Hi threshold should not be as high as the Alarm Hi threshold.
 

Detailed Description


Function Documentation

◆ naibrd_RTD_GetThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_GetThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_rtd_thresh_type_t type,
float64_t * outthreshold )

This function retrieves the specified RTD channel's temperature threshold represented by the parameter "type." Valid threshold types are Alert Lo, Alarm Lo, Alert Hi, and Alarm Hi. If the specified channel's temperature meets or exceeds the Alarm Hi Threshold, then the bit in the Alarm Hi status register that corresponds to the channel will be set to 1. If the specified channel's temperature meets or goes below the Alarm Lo Threshold, then the bit in the Alarm Lo status register that corresponds to the channel will be set to 1. The Alert Lo register works the same way as the Alarm Lo register except that the Alert Lo threshold should not be as low as the Alarm Lo threshold. The Alert Hi register works the same way as the Alarm Hi register except that the Alert Hi threshold should not be as high as the Alarm Hi threshold.

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) Threshold type: see nai_rtd_thresh_type_t definition.
outthreshold: (Output) Temperature value read from the register in degrees 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_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_RTD_SetThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_RTD_SetThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_rtd_thresh_type_t type,
float64_t threshold )

This function sets the specified RTD channel's temperature threshold represented by the parameter "type." Valid threshold types are Alert Lo, Alarm Lo, Alert Hi, and Alarm Hi. If the specified channel's temperature meets or exceeds the Alarm Hi Threshold, then the bit in the Alarm Hi status register that corresponds to the channel will be set to 1. If the specified channel's temperature meets or goes below the Alarm Lo Threshold, then the bit in the Alarm Lo status register that corresponds to the channel will be set to 1. The Alert Lo register works the same way as the Alarm Lo register except that the Alert Lo threshold should not be as low as the Alarm Lo threshold. The Alert Hi register works the same way as the Alarm Hi register except that the Alert Hi threshold should not be as high as the Alarm Hi threshold.

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) Threshold type: see nai_rtd_thresh_type_t definition.
threshold: (Input) Temperature value to set the threshold to in degrees 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_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.