|
| 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 *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.
|
| |
| 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 *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_SetRange (int32_t cardIndex, int32_t module, int32_t channel, float64_t range) |
| | NOTE: This API applies to the G4 only. Sets the range for the specified RTD channel as follows:
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_GetRange (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outrange) |
| | NOTE: This API applies to the G4 only. Retrieves the range for the specified RTD channel as follows:
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_SetZeroTempResistance (int32_t cardIndex, int32_t module, int32_t channel, nai_rtd_zero_temp_resistance_type_t zeroTempResistance) |
| | NOTE: This API does not apply to the G4 and 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, nai_rtd_zero_temp_resistance_type_t *outZeroTempResistance) |
| | NOTE: This API does not apply to the G4 and 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) |
| | NOTE: This API does not apply to the G4 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 *outZeroTempResistance) |
| | NOTE: This API does not apply to the G4 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, nai_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, nai_rtd_wire_mode_t *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 resistance offset compensation (default 0), and typically used for 2 wire lead resistance nulling, but is applied for all wire modes. This value represents the TOTAL lead resistance and is subtracted from the resistance measurement, and will also affect the computed temperature readings.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_GetCompResistance (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outresistance) |
| | Retrieves the resistance offset compensation (default 0), and typically used for 2 wire lead resistance nulling, but is applied for all wire modes. This value represents the TOTAL lead resistance and is subtracted from the resistance measurement, and will also affect the computed temperature readings.
|
| |
| 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. - 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]). |
| sampleRate | : (Input) Sample rates: 12Hz to 4800 Hz . |
- Returns
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_GetSampleRate (int32_t cardIndex, int32_t module, int32_t channel, float64_t *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, nai_rtd_config_type_t configType) |
| | Sets the configuration for the specified channel as RTD or TC(Thermocouple), only applicable for TR1 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]). |
| channel | : (Input) Channel Number of the channel to access (1 - [max channels for module]). |
| configType | : (Input) Configuration Type RTD/TC, refer to nai_rtd_config_type_t definition. |
. - Returns
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_GetConfiguration (int32_t cardIndex, int32_t module, int32_t channel, nai_rtd_config_type_t *outConfigType) |
| | Retrieves the configuration for the specified channel.
|
| |
| 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 *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 *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, nai_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 60 msec for G4, 1.024 msec for RT1. The minimum G4 BIT/open time interval is 1.2 sec (20 LSBs). Power on default interval is 20 sec. 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 *outbitopeninterval) |
| | Retrieves the time interval between successive BIT/open detection tests. Writing '0' disables BIT/open detection. The time interval LSB is 60 msec. The minimum BIT/open time interval is 1.2 sec (20 LSBs). Default time interval is 20 sec. 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_SetCalInterval (int32_t cardIndex, int32_t module, uint32_t calinterval) |
| | NOTE: This API only applies to the G4 module. Sets the time interval between successive background calibrations. Writing '0' disables background calibration. Writing 'FFFF' forces an immediate background calibration, with the register automatically being set back to '0' upon completion of background calibration. The time interval LSB is 60 msec. The minimum background calibration time interval is 1.2 sec (20 LSBs). Default time interval is 10 min.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_GetCalInterval (int32_t cardIndex, int32_t module, uint32_t *outcalinterval) |
| | NOTE: This API only applies to the G4 module. Retrieves the time interval between successive background calibrations. Writing '0' disables background calibration. Writing 'FFFF' forces an immediate background calibration, with the register automatically being set back to '0' upon completion of background calibration. The time interval LSB is 60 msec. The minimum background calibration time interval is 1.2 sec (20 LSBs). Default time interval is 10 min.
|
| |
| 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_SetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_rtd_status_type_t type, uint32_t statusintenab) |
| | Sets the RTD BIT or Open Status Interrupt Enable state 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_GetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, nai_rtd_status_type_t type, uint32_t *outstatusintenab) |
| | Retrieves the RTD BIT or Open Status Interrupt Enable state 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_SetInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, nai_rtd_status_type_t type, nai_rtd_interrupt_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_GetInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, nai_rtd_status_type_t type, nai_rtd_interrupt_t *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_SetInterruptVector (int32_t cardIndex, int32_t module, nai_rtd_status_type_t type, uint32_t interruptvector) |
| | Sets the RTD BIT or Open Status Interrupt Vector for the specified RTD module. Module Summary Status: Feature supported in FPGA Version >= X.X.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_GetInterruptVector (int32_t cardIndex, int32_t module, nai_rtd_status_type_t type, uint32_t *outinterruptvector) |
| | Retrieves the RTD BIT or Open Status Interrupt Vector for the specified RTD module. Module Summary Status: Feature supported in FPGA Version >= X.X.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_SetInterruptSteering (int32_t cardIndex, int32_t module, nai_rtd_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_GetInterruptSteering (int32_t cardIndex, int32_t module, nai_rtd_status_type_t type, naibrd_int_steering_t *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, 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.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_ConvertToSampleRate (uint32_t modid, uint32_t rawdata, float64_t *outsampleRate) |
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_ConvertToSampleRateRaw (uint32_t modid, float64_t sampleRate, uint32_t *outrawdata) |
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_ConvertToResistanceRange (uint32_t modid, nai_rtd_range_t rawdata, float64_t *outrange) |
| | NOTE: This API only applies to the G4 module. Returns the resistance associated with RTD Module ID and resistance range code.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_ConvertToResistanceRangeRaw (uint32_t modid, float64_t range, nai_rtd_range_t *outrawdata) |
| | NOTE: This API only applies to the G4 module. Returns the range code associated with RTD Module ID and resistance range.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_ConvertToResistance (uint32_t modid, nai_rtd_range_t range, uint32_t rawdata, float64_t *outresistance) |
| | NOTE: This API only applies to the G4 module. Calculates the resistance in ohms associated with the RTD Module ID and given range and raw data.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_ConvertToResistanceRaw (uint32_t modid, nai_rtd_range_t range, float64_t resistance, uint32_t *outrawdata) |
| | NOTE: This API only applies to the G4 module. Returns the raw data code for the resistance value associated with the RTD Module ID and resistance range.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_SetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_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.
|
| |
| NAIBRDFUNC nai_status_t NAIAPI | naibrd_RTD_GetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_rtd_channel_raw_t type, uint32_t *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_GetStatusRaw (int32_t cardIndex, int32_t module, nai_rtd_status_type_t type, uint32_t *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_ClearStatusRaw (int32_t cardIndex, int32_t module, nai_rtd_status_type_t type, uint32_t clearstatusraw) |
| | NOTE: This API does not apply to the G4 module. 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_SetInterruptEnableRaw (int32_t cardIndex, int32_t module, nai_rtd_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_GetInterruptEnableRaw (int32_t cardIndex, int32_t module, nai_rtd_status_type_t type, uint32_t *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.
|
| |
1.11.0