Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Configuration Functions
NAI Board Library - Module Functions » TC Module Functions

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.
 
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.
 

Detailed Description

Function Documentation

◆ naibrd_TC_GetBackgroundOpSuspend()

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.

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]).
p_outDisable: (Output) 1 when BIT/Open tests and System Calibration are suspended, 0 when enabled.
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_SUPPORTED when function is not supported.

◆ naibrd_TC_GetChanStatusEnable()

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.

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]).
p_outenable: (Output) 0 if channel status reporting is disabled or 1 if channel status reporting is enabled.
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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TC_GetCJCEnable()

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.

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]).
p_outEnable: (Output) 0 = disable CJC block, 1 = enable CJC block.
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_SUPPORTED when function is not supported.

◆ naibrd_TC_GetCompTemperature()

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.

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]).
p_outTemperature: (Output) Compensation temperature 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_SUPPORTED when function is not supported.

◆ naibrd_TC_GetCompType()

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.

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]).
p_outCompType: (Output) Compensation type: refer to nai_tc_comp_type_t definition.
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_SUPPORTED when function is not supported.

◆ naibrd_TC_GetConfiguration()

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.

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]).
p_outConfigType: (Output) Configuration Type RTD/TC, refer to nai_tc_config_type_t definition.
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_SUPPORTED when function is not supported.

◆ naibrd_TC_GetOffsetTemperature()

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.

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]).
p_outOffsetTemperature: (Output) Floating-point offset temperature in degrees Celsius read from module.
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_SUPPORTED when function is not supported.

◆ naibrd_TC_GetSampleRate()

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.

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]).
p_outsampleRate: (Output) Sample rates: 12Hz to 4800 Hz .
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_SUPPORTED when function is not supported.

◆ naibrd_TC_GetThermocoupleType()

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.

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]).
p_outTcType: (Output) Thermocouple type: refer to nai_tc_thermocouple_type_t definition.
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_SUPPORTED when function is not supported.

◆ naibrd_TC_SetBackgroundOpSuspend()

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.

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]). Channel specification of 0 selects all channels.
disable: (Input) 1 to suspend BIT/Open tests and System Calibration, 0 to re-enable.
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_INVALID_VALUE when invalid disable parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TC_SetChanStatusEnable()

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.

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]).
enable: (Input) 0 to disable or 1 to enable status reporting for a channel.
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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid enable parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TC_SetCJCEnable()

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.

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]).
enable: (Input) 0 = disable CJC block, 1 = enable CJC block.
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_VALUE when invalid thermocouple type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TC_SetCompTemperature()

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.

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]).
temperature: (Input) Compensation temperature 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_SUPPORTED when function is not supported.

◆ naibrd_TC_SetCompType()

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.

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]).
compType: (Input) Compensation type: refer to nai_tc_comp_type_t definition.
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_INVALID_VALUE when invalid compensation type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TC_SetConfiguration()

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

  • 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_SUPPORTED when function is not supported.

◆ naibrd_TC_SetOffsetTemperature()

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.

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]).
offsetTemperature: (Input) Floating-point offset temperature to set 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_SUPPORTED when function is not supported.

◆ naibrd_TC_SetSampleRate()

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

  • 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_SUPPORTED when function is not supported.

◆ naibrd_TC_SetThermocoupleType()

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.

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]).
tcType: (Input) Thermocouple type: refer to nai_tc_thermocouple_type_t definition.
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_INVALID_VALUE when invalid thermocouple type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TC_TriggerBackgroundOperation()

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.

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]). 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).
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_INVALID_VALUE when invalid opType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.