Software Library API naibrd 1.62
See all documentation at naii.docs.com
|
Functions | |||||||||
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. Feature supported in FPGA Version >= 1.9. | |||||||||
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_GetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outenable) | ||||||||
Retrieves the enabled/disabled state of status reporting for the specified TC channel. Feature supported in FPGA Version >= 1.9. | |||||||||
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_SetThermocoupleType (int32_t cardIndex, int32_t module, int32_t channel, nai_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, nai_tc_thermocouple_type_t *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 *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.
| |||||||||
NAIBRDFUNC nai_status_t NAIAPI | naibrd_TC_GetSampleRate (int32_t cardIndex, int32_t module, int32_t channel, float64_t *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 *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, nai_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, nai_tc_comp_type_t *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, nai_tc_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_TC_GetConfiguration (int32_t cardIndex, int32_t module, int32_t channel, nai_tc_config_type_t *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 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_TC_GetOffsetTemperature (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outOffsetTemperature) | ||||||||
Retrieves the TC offset temperature for the specified TC 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_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 *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, nai_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_GetBackgroundOpSuspend | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
bool_t * | 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.
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]). |
outDisable | : (Output) 1 when BIT/Open tests and System Calibration are suspended, 0 when enabled. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetChanStatusEnable | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
bool_t * | outenable ) |
Retrieves the enabled/disabled state of status reporting for the specified TC channel. Feature supported in FPGA Version >= 1.9.
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]). |
outenable | : (Output) 0 if channel status reporting is disabled or 1 if channel status reporting is enabled. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetCJCEnable | ( | int32_t | cardIndex, |
int32_t | module, | ||
bool_t * | outEnable ) |
Retrieves the cold junction compensation block state for the specified TC module.
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]). |
outEnable | : (Output) returns CJC block state (0 = disable CJC block, 1 = enable CJC block). |
NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetCompTemperature | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
float64_t * | outTemperature ) |
Retrieves the compensation temperature for the specified TC channel. This value represents the compensation temperature that is added to the temperature reading.
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) Compensation temperature in degrees celsius. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetCompType | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
nai_tc_comp_type_t * | outCompType ) |
Retrieves the TC thermocouple compensation type configuration for the specified TC channel.
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]). |
outCompType | : (Output) Compensation type: refer to nai_tc_comp_type_t definition. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetConfiguration | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
nai_tc_config_type_t * | outConfigType ) |
Retrieves the configuration for the specified channel.
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]). |
outConfigType | : (Output) Configuration Type RTD/TC, refer to nai_tc_config_type_t definition. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetOffsetTemperature | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
float64_t * | outOffsetTemperature ) |
Retrieves the TC offset temperature for the specified TC 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.
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]). |
outOffsetTemperature | : (Output) Floating-point offset temperature in degrees Celsius read from module. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetSampleRate | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
float64_t * | outsampleRate ) |
Retrieves the measurement sample rate for the specified TC channel.
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]). |
outsampleRate | : (Output) Sample rates: 12Hz to 4800 Hz . |
NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_GetThermocoupleType | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
nai_tc_thermocouple_type_t * | outTcType ) |
Retrieves the TC thermocouple type configuration for the specified TC channel.
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]). |
outTcType | : (Output) Thermocouple type: refer to nai_tc_thermocouple_type_t definition. |
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.
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]). Channel specification of 0 selects all channels. |
disable | : (Input) 1 to suspend BIT/Open tests and System Calibration, 0 to re-enable. |
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. Feature supported in FPGA Version >= 1.9.
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]). |
enable | : (Input) 0 to disable or 1 to enable status reporting for a 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.
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]). |
enable | : (Input) 0 = disable CJC block, 1 = enable CJC block. |
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.
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]). |
temperature | : (Input) Compensation temperature in degrees celsius. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_SetCompType | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
nai_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.
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]). |
compType | : (Input) Compensation type: refer to nai_tc_comp_type_t definition. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_SetConfiguration | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
nai_tc_config_type_t | configType ) |
Sets the configuration for the specified channel as RTD or TC(Thermocouple), only applicable for TR1 module.
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. |
.
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 output temperature degrees Celsius reading. The result of the subtraction is also reflected in the output temperature degrees Fahrenheit reading.
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]). |
offsetTemperature | : (Input) Floating-point offset temperature to set in degrees Celsius. |
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.
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 . |
NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_SetThermocoupleType | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
nai_tc_thermocouple_type_t | tcType ) |
Sets the TC thermocouple type for the specified TC channel.
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]). |
tcType | : (Input) Thermocouple type: refer to nai_tc_thermocouple_type_t definition. |
NAIBRDFUNC nai_status_t NAIAPI naibrd_TC_TriggerBackgroundOperation | ( | int32_t | cardIndex, |
int32_t | module, | ||
int32_t | channel, | ||
nai_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.
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]). A channel specification of 0 will trigger operation on all channels. |
opType | : (Input) Background operation type to trigger (refer to nai_tc_background_op_type_t definition). |