|
static int32_t | GetChannelCount (uint32_t modid) |
|
static float64_t | GetMaxResistance (uint32_t modid) |
|
static nai_status_t | naibrd_RTD_VerifyChannel (uint32_t modid, int32_t channel) |
|
static nai_status_t | naibrd_RTD_VerifyWireMode (naibrd_rtd_wire_mode_t wiremode) |
|
static nai_status_t | naibrd_RTD_VerifyZeroTempType (naibrd_rtd_zero_temp_resistance_type_t zerotemptype) |
|
static nai_status_t | naibrd_RTD_VerifyTemperatureType (naibrd_rtd_temperature_type_t temperatureType) |
|
static nai_status_t | naibrd_RTD_VerifyChanMappedStatusType (naibrd_rtd_chan_mapped_status_type_t statusType) |
|
static nai_status_t | naibrd_RTD_VerifyBoolean (bool_t enable) |
|
static nai_status_t | naibrd_RTD_VerifyConfigurationType (naibrd_rtd_config_type_t configType) |
|
static nai_status_t | naibrd_RTD_VerifyBackgroundOpType (naibrd_rtd_background_op_type_t opType) |
|
static nai_status_t | naibrd_RTD_VerifyInterruptTriggerType (naibrd_int_trigger_type_t interruptType) |
|
static nai_status_t | naibrd_RTD_VerifyInterruptSteeringType (naibrd_int_steering_t steeringType) |
|
static nai_status_t | naibrd_RTD_VerifyThresholdType (naibrd_rtd_thresh_type_t thresholdType) |
|
static nai_status_t | naibrd_RTD_VerifyChannelRawWriteableType (naibrd_rtd_channel_raw_t chanRawType) |
|
static nai_status_t | naibrd_RTD_VerifyChannelRawType (naibrd_rtd_channel_raw_t chanRawType) |
|
NAIBRDFUNC int32_t NAIAPI | naibrd_RTD_GetChannelCount (uint32_t modid) |
| Returns the number of channels for the specified RTD Module ID.
|
|
NAIBRDFUNC float64_t NAIAPI | naibrd_RTD_GetMaxResistance (uint32_t modid) |
| Returns the maximum resistance value in ohms for the specified RTD Module ID.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_GetResistance (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outresistance) |
| Retrieves the resistance measurement for the specified 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 p_outresistances[]) |
| Retrieves all the resistance measurement for the specified RTD module. 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 *p_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, naibrd_rtd_temperature_type_t tempType, float64_t *p_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 p_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, naibrd_rtd_temperature_type_t tempType, int32_t arraysize, float64_t p_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_GetChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_rtd_chan_mapped_status_type_t type, nai_status_bit_t *p_outstatusBit) |
| 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_ClearChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_rtd_chan_mapped_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_SetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| Enables/disables status reporting for the specified RTD channel. Feature supported in FPGA Version >= X.X.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_GetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable) |
| Retrieves the enabled/disabled state of status reporting for the specified RTD channel. Feature supported in FPGA Version >= X.X.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_SetZeroTempResistance (int32_t cardIndex, int32_t module, int32_t channel, naibrd_rtd_zero_temp_resistance_type_t zeroTempResistance) |
| NOTE: This API is deprecated for RT1, please use extended function naibrd_RTD_SetZeroTempResistanceEx instead. Sets the transducer's 0 degree Celsius resistance (in ohms) setting for the specified channel as follows:
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_GetZeroTempResistance (int32_t cardIndex, int32_t module, int32_t channel, naibrd_rtd_zero_temp_resistance_type_t *p_outZeroTempResistance) |
| NOTE: This API is deprecated for RT1, please use extended function naibrd_RTD_GetZeroTempResistanceEx instead. Retrieves the transducer's 0 degree Celsius resistance (in ohms) setting for the specified channel as follows:
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_SetZeroTempResistanceEx (int32_t cardIndex, int32_t module, int32_t channel, float64_t zeroTempResistance) |
| Sets the transducer's 0 degree Celsius resistance (in ohms) setting for the specified channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_GetZeroTempResistanceEx (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outZeroTempResistance) |
| Retrieves the transducer's 0 degree Celsius resistance (in ohms) setting for the specified channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_SetWireMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_rtd_wire_mode_t wiremode) |
| Sets the RTD wire mode configuration for the specified RTD channel as follows:
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_GetWireMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_rtd_wire_mode_t *p_outwiremode) |
| Retrieves the RTD wire mode configuration for the specified RTD channel as follows:
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_SetCompResistance (int32_t cardIndex, int32_t module, int32_t channel, float64_t resistance) |
| Sets the 2-wire resistance compensation. Used only when the specified RTD channel is set for 2-wire mode. This value represents the TOTAL lead resistance and is subtracted from the resistance measurement when the channel is set for 2-wire mode.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_GetCompResistance (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outresistance) |
| Retrieves the 2-wire resistance compensation. Used only when the specified RTD channel is set for 2-wire mode. This value represents the TOTAL lead resistance and is subtracted from the resistance measurement when the channel is set for 2-wire mode.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_SetSampleRate (int32_t cardIndex, int32_t module, int32_t channel, float64_t sampleRate) |
| Sets the measurement sample rate for the specified RTD channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_GetSampleRate (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outsampleRate) |
| Retrieves the measurement sample rate for the specified RTD channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_SetConfiguration (int32_t cardIndex, int32_t module, int32_t channel, naibrd_rtd_config_type_t configType) |
| Sets the configuration for the specified channel as RTD or TC(Thermocouple), only applicable for TR1 module.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_GetConfiguration (int32_t cardIndex, int32_t module, int32_t channel, naibrd_rtd_config_type_t *p_outConfigType) |
| Retrieves the configuration for the specified channel, only applicable for TR1 module.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_SetOffsetTemperature (int32_t cardIndex, int32_t module, int32_t channel, float64_t offsetTemperature) |
| Sets the RTD offset temperature for the specified RTD channel. The offset temperature is in degrees Celsius and is subtracted from the output temperature degrees Celsius reading. The result of the subtraction is also reflected in the output temperature degrees Fahrenheit reading.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_GetOffsetTemperature (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outOffsetTemperature) |
| Retrieves the RTD offset temperature for the specified RTD channel. The offset temperature is in degrees Celsius and is subtracted from the output temperature degrees Celsius reading. The result of the subtraction is also reflected in the output temperature degrees Fahrenheit reading.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_SetBackgroundOpSuspend (int32_t cardIndex, int32_t module, int32_t channel, bool_t disable) |
| Sets the bit corresponding to the specified RTD channel in the suspend background operation register. Writing a 1 to the bit suspends the BIT and Open-Line tests, and writing a 0 re-enables them to run at the regular 30 second intervals.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_GetBackgroundOpSuspend (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outDisable) |
| Retrieves the bit corresponding to the specified RTD channel in the suspend background operation register. 1 indicates that the BIT and Open-Line tests are suspended, while 0 indicates that they are enabled to run at the regular 30 second intervals.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_TriggerBackgroundOperation (int32_t cardIndex, int32_t module, int32_t channel, naibrd_rtd_background_op_type_t opType) |
| Sets the bit corresponding to the specified RTD channel in the register corresponding to the specified background operation type. The bit is set to a 1, which triggers a single execution of the operation. Valid operation types are BIT Test and Open-Line Test. Bit is cleared upon completion of the operation.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_SetBitOpenInterval (int32_t cardIndex, int32_t module, uint32_t bitopeninterval) |
| Sets the time interval between successive BIT/open detection tests. Writing '0' disables BIT/open detection. The time interval LSB is 1.024 msec for RT1. For Gen 5 modules, this function applies to X1 modules only and is not supported for Gen 5 X2 modules. For Gen 5 X2 modules, the BIT/Open interval is fixed at 30 seconds, or optionally suspended.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_GetBitOpenInterval (int32_t cardIndex, int32_t module, uint32_t *p_outbitopeninterval) |
| Retrieves the time interval between successive BIT/open detection tests. Writing '0' disables BIT/open detection. The time interval LSB is 1.024 msec for RT1. For Gen 5 modules, this function applies to X1 modules only and is not supported for Gen 5 X2 modules. For Gen 5 X2 modules, the BIT/Open interval is fixed at 30 seconds.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_CheckPowerOnBITComplete (int32_t cardIndex, int32_t module, bool_t *p_outpbitComplete) |
| Retrieves the Power-On BIT (PBIT) status (complete or incomplete) for the specified channel. The PBIT result will be in the BIT status register. Feature supported in FPGA Version >= X.X.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_SetChanMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_rtd_chan_mapped_status_type_t type, bool_t statusintenab) |
| Sets the RTD Interrupt Enable state corresponding to the specified RTD Status type for the specified RTD channel. BIT Status and Open Status are part of the background testing. When the interrupt is enabled, a non-compliant channel will trigger an interrupt. By default, interrupts are disabled. Module Summary Status: Feature supported in FPGA Version >= X.X.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_GetChanMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_rtd_chan_mapped_status_type_t type, bool_t *p_outstatusintenab) |
| Retrieves the RTD Interrupt Enable state corresponding to the specified RTD Status type for the specified RTD channel. BIT Status and Open Status are part of the background testing. When the interrupt is enabled, a non-compliant channel will trigger an interrupt. By default, interrupts are disabled. Module Summary Status: Feature supported in FPGA Version >= X.X.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_SetChanMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_rtd_chan_mapped_status_type_t type, naibrd_int_trigger_type_t interruptType) |
| Sets the Interrupt Edge/Level property for the specified channel and interrupt status type. Module Summary Status: Feature supported in FPGA Version >= X.X.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_GetChanMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_rtd_chan_mapped_status_type_t type, naibrd_int_trigger_type_t *p_outinterruptType) |
| Retrieves the Interrupt Edge/Level property for the specified channel and interrupt status type. Module Summary Status: Feature supported in FPGA Version >= X.X.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_SetChanMappedInterruptVector (int32_t cardIndex, int32_t module, naibrd_rtd_chan_mapped_status_type_t type, uint32_t interruptvector) |
| Sets the RTD Interrupt Vector for the specified RTD module and RTD Status type. Module Summary Status: Feature supported in FPGA Version >= X.X.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_GetChanMappedInterruptVector (int32_t cardIndex, int32_t module, naibrd_rtd_chan_mapped_status_type_t type, uint32_t *p_outinterruptvector) |
| Retrieves the RTD Interrupt Vector for the specified RTD module and RTD Status type. Module Summary Status: Feature supported in FPGA Version >= X.X.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_SetChanMappedInterruptSteering (int32_t cardIndex, int32_t module, naibrd_rtd_chan_mapped_status_type_t type, naibrd_int_steering_t steering) |
| Sets the Interrupt Steering, which indicates the interrupt direction, for the specified interrupt status type. Module Summary Status: Feature supported in FPGA Version >= X.X.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_GetChanMappedInterruptSteering (int32_t cardIndex, int32_t module, naibrd_rtd_chan_mapped_status_type_t type, naibrd_int_steering_t *p_outsteering) |
| Retrieves the Interrupt Steering, which indicates the interrupt direction, for the specified interrupt status type. Module Summary Status: Feature supported in FPGA Version >= X.X.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_SetThreshold (int32_t cardIndex, int32_t module, int32_t channel, naibrd_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, naibrd_rtd_thresh_type_t type, float64_t *p_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.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_ConvertToSampleRate (uint32_t modid, uint32_t rawdata, float64_t *p_outsampleRate) |
| Calculates the sample rate in Hz from the given raw data.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_ConvertToSampleRateRaw (uint32_t modid, float64_t sampleRate, uint32_t *p_outrawdata) |
| Calculates the raw data code corresponding to the given sample rate.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_SetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_rtd_channel_raw_t type, uint32_t rawdata) |
| Sets the raw data value in the register associated with the channel and channel register type specified. Note: The registers corresponding to the channel register types NAIBRD_RTD_RAW_RESISTANCE and NAIBRD_RTD_RAW_TEMPERATURE are read-only, and NAI_ERROR_INVALID_VALUE will be returned by this function if either of those types are passed in as the type parameter.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_GetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_rtd_channel_raw_t type, uint32_t *p_outrawdata) |
| Retrieves the raw data value in the register associated with the channel and channel register type specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_GetChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_rtd_chan_mapped_status_type_t type, uint32_t *p_outstatusraw) |
| Retrieves the raw status value in the register associated with the status type specified. Module Summary Status: Feature supported in FPGA Version >= X.X.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_ClearChanMappedStatusRaw (int32_t cardIndex, int32_t module, naibrd_rtd_chan_mapped_status_type_t type, uint32_t clearstatusraw) |
| Clears the status for the channels specified (bit-masked) of the status type specified. Module Summary Status: Feature supported in FPGA Version >= X.X.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_SetChanMappedInterruptEnableRaw (int32_t cardIndex, int32_t module, naibrd_rtd_chan_mapped_status_type_t type, uint32_t statusintenab) |
| Sets the raw interrupt enable data value in the register associated with the status type specified. Module Summary Status: Feature supported in FPGA Version >= X.X.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_GetChanMappedInterruptEnableRaw (int32_t cardIndex, int32_t module, naibrd_rtd_chan_mapped_status_type_t type, uint32_t *p_outstatusintenab) |
| Retrieves the raw interrupt enable data value in the register associated with the status type specified. Module Summary Status: Feature supported in FPGA Version >= X.X.
|
|