|
static int32_t | GetChannelCount (uint32_t modid) |
|
static nai_status_t | naibrd_TC_VerifyChannel (uint32_t modid, int32_t channel) |
|
static nai_status_t | naibrd_TC_VerifyChanMappedStatusType (naibrd_tc_chan_mapped_status_type_t type) |
|
static nai_status_t | naibrd_TC_VerifyChanMappedLatchStatusType (naibrd_tc_chan_mapped_status_type_t type) |
|
static nai_status_t | naibrd_TC_VerifyThermocoupleType (naibrd_tc_thermocouple_type_t tcType) |
|
static nai_status_t | naibrd_TC_VerifyTemperatureType (naibrd_tc_temperature_type_t tempType) |
|
static nai_status_t | naibrd_TC_VerifyCompType (naibrd_tc_comp_type_t tempType) |
|
static nai_status_t | naibrd_TC_VerifyConfigType (naibrd_tc_config_type_t configType) |
|
static nai_status_t | naibrd_TC_VerifyThresholdType (naibrd_tc_thresh_type_t type) |
|
static nai_status_t | naibrd_TC_VerifyChannelRawType (naibrd_tc_channel_raw_t type) |
|
static nai_status_t | naibrd_TC_VerifyBackgroundOpType (naibrd_tc_background_op_type_t opType) |
|
static nai_status_t | naibrd_TC_VerifyBoolean (bool_t enable) |
|
static nai_status_t | naibrd_TC_VerifyInterruptTriggerType (naibrd_int_trigger_type_t triggerType) |
|
static nai_status_t | naibrd_TC_VerifyInterruptSteeringType (naibrd_int_steering_t steeringType) |
|
NAIBRDFUNC int32_t NAIAPI | naibrd_TC_GetChannelCount (uint32_t modid) |
| Returns the number of channels for the specified TC Module ID.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_GetVoltage (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_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, naibrd_tc_temperature_type_t tempType, float64_t *p_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, naibrd_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_GetChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_tc_chan_mapped_status_type_t type, nai_status_bit_t *p_outStatus) |
| Retrieves the status for the specified TC channel and status type.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_ClearChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_tc_chan_mapped_status_type_t type) |
| Clears the latched status for the specified channel and status type.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_SetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable) |
| Enables/disables status reporting for the specified TC channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_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 TC channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_SetThermocoupleType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_tc_thermocouple_type_t tcType) |
| Sets the TC thermocouple type for the specified TC channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_GetThermocoupleType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_tc_thermocouple_type_t *p_outTcType) |
| Retrieves the TC thermocouple type configuration for the specified TC channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_SetCJCEnable (int32_t cardIndex, int32_t module, bool_t enable) |
| Enables or disables cold junction compensation block for the specified TC module.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_GetCJCEnable (int32_t cardIndex, int32_t module, bool_t *p_outEnable) |
| Retrieves the cold junction compensation block state for the specified TC module.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_SetSampleRate (int32_t cardIndex, int32_t module, int32_t channel, float64_t sampleRate) |
| Sets the measurement sample rate 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]). |
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_TC_GetSampleRate (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outsampleRate) |
| Retrieves the measurement sample rate for the specified TC channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_SetCompTemperature (int32_t cardIndex, int32_t module, int32_t channel, float64_t temperature) |
| Sets the compensation temperature for the specified TC channel. This value is added to the temperature reading.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_GetCompTemperature (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outTemperature) |
| Retrieves the compensation temperature for the specified TC channel. This value represents the compensation temperature that is added to the temperature reading.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_SetCompType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_tc_comp_type_t compType) |
| Sets the TC thermocouple compensation type for the specified TC channel. If set for manual, compensation is based off value set by naibrd_TC_SetCompTemperature, otherwise compensation is autoset by internal temperature reading.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_GetCompType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_tc_comp_type_t *p_outCompType) |
| Retrieves the TC thermocouple compensation type configuration for the specified TC channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_SetConfiguration (int32_t cardIndex, int32_t module, int32_t channel, naibrd_tc_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_tc_config_type_t definition. |
. - Returns
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_GetConfiguration (int32_t cardIndex, int32_t module, int32_t channel, naibrd_tc_config_type_t *p_outConfigType) |
| Retrieves the configuration for the specified channel.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_SetOffsetTemperature (int32_t cardIndex, int32_t module, int32_t channel, float64_t offsetTemperature) |
| Sets the TC offset temperature for the specified TC channel. The offset temperature is in degrees Celsius and is subtracted from the p_output temperature degrees Celsius reading. The result of the subtraction is also reflected in the p_output temperature degrees Fahrenheit reading.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_GetOffsetTemperature (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outOffsetTemperature) |
| Retrieves the TC offset temperature for the specified TC channel. The offset temperature is in degrees Celsius and is subtracted from the p_output temperature degrees Celsius reading. The result of the subtraction is also reflected in the p_output temperature degrees Fahrenheit reading.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_SetBackgroundOpSuspend (int32_t cardIndex, int32_t module, int32_t channel, bool_t disable) |
| Sets the bit corresponding to the specified TC channel in the suspend background operation register. Writing a 1 to the bit suspends the BIT and Open-Line tests and System Calibration, and writing a 0 re-enables them to run at the regular 30 second intervals.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_GetBackgroundOpSuspend (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outDisable) |
| Retrieves the bit corresponding to the specified TC channel in the suspend background operation register. 1 indicates that the BIT and Open-Line tests and System Calibration are suspended, while 0 indicates that they are enabled to run at the regular 30 second intervals.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_TriggerBackgroundOperation (int32_t cardIndex, int32_t module, int32_t channel, naibrd_tc_background_op_type_t opType) |
| Sets the bit corresponding to the specified TC 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, Open-Line Test, and System Calibration. Bit is cleared upon completion of the operation.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_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.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_SetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_tc_chan_mapped_status_type_t type, bool_t enable) |
| Sets the TC BIT or Open Status Interrupt Enable state for the specified TC 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.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_GetInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_tc_chan_mapped_status_type_t type, bool_t *p_outenable) |
| Retrieves the TC BIT or Open Status Interrupt Enable state for the specified TC 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.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_SetInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, naibrd_tc_chan_mapped_status_type_t type, naibrd_int_trigger_type_t triggerType) |
| Sets the Interrupt Edge/Level property for the specified channel and interrupt status type.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_GetInterruptEdgeLevel (int32_t cardIndex, int32_t module, int32_t channel, naibrd_tc_chan_mapped_status_type_t type, naibrd_int_trigger_type_t *p_outtriggerType) |
| Retrieves the Interrupt Edge/Level property for the specified channel and interrupt status type.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_SetInterruptVector (int32_t cardIndex, int32_t module, naibrd_tc_chan_mapped_status_type_t type, uint32_t interruptvector) |
| Sets the TC BIT or Open Status Interrupt Vector for the specified TC module.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_GetInterruptVector (int32_t cardIndex, int32_t module, naibrd_tc_chan_mapped_status_type_t type, uint32_t *p_outinterruptvector) |
| Retrieves the TC BIT or Open Status Interrupt Vector for the specified TC module.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_SetInterruptSteering (int32_t cardIndex, int32_t module, naibrd_tc_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.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_GetInterruptSteering (int32_t cardIndex, int32_t module, naibrd_tc_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.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_SetThreshold (int32_t cardIndex, int32_t module, int32_t channel, naibrd_tc_thresh_type_t type, float64_t threshold) |
| This function sets the specified TC 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_TC_GetThreshold (int32_t cardIndex, int32_t module, int32_t channel, naibrd_tc_thresh_type_t type, float64_t *p_outthreshold) |
| This function retrieves the specified TC 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_TC_ConvertToSampleRate (uint32_t modid, uint32_t rawdata, float64_t *p_outsampleRate) |
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_ConvertToSampleRateRaw (uint32_t modid, float64_t sampleRate, uint32_t *p_outrawdata) |
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_SetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_tc_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_TC_GetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_tc_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_TC_GetStatusRaw (int32_t cardIndex, int32_t module, naibrd_tc_chan_mapped_status_type_t type, uint32_t *p_outstatusraw) |
| Retrieves the raw status value in the register associated with the status type specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_ClearStatusRaw (int32_t cardIndex, int32_t module, naibrd_tc_chan_mapped_status_type_t type, uint32_t clearstatusraw) |
| Clears the status for the channels specified (bit-masked) of the status type specified.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_SetInterruptEnableRaw (int32_t cardIndex, int32_t module, naibrd_tc_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.
|
|
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_GetInterruptEnableRaw (int32_t cardIndex, int32_t module, naibrd_tc_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.
|
|