Functions

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.

Detailed Description

Function Documentation

◆ naibrd_RTD_GetBackgroundOpSuspend()

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.

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]).
outDisable	: (Output) 1 when BIT/Open tests 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_RTD_GetChanStatusEnable()

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.

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]).
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_RTD_GetCompResistance()

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.

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]).
outresistance	: (Output) Two-wire lead compensation resistance in ohms.

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_RTD_GetConfiguration()

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.

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]).
outConfigType	: (Output) Configuration Type RTD/TC, refer to nai_rtd_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_RTD_GetOffsetTemperature()

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.

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]).
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_RTD_GetRange()

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:

      G4                     Range
Resistance Range            Register Value              LSB (ohm)
______________________________________________________________________
0-200 ohm                          0                      0.005
0-400 ohm                          1                      0.01
0-800 ohm                          2                      0.02
0-2000 ohm                         3                      0.04
0-4000 ohm                         4                      0.08
0-6500 ohm                         5                      0.16

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]).
outrange	: (Output) Resistance range in ohms.

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_RTD_GetSampleRate()

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.

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]).
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_RTD_GetWireMode()

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:

                         Gen3 (G4)                    Gen5 (RT1)
Wire Mode              wiremode value               wiremode Value
________________________________________________________________________
2-wire             NAI_RTD_GEN3_WIRE_MODE_2     NAI_RTD_GEN5_WIRE_MODE_2
3-wire             NAI_RTD_GEN3_WIRE_MODE_3     NAI_RTD_GEN5_WIRE_MODE_3
4-wire             NAI_RTD_GEN3_WIRE_MODE_4     NAI_RTD_GEN5_WIRE_MODE_4

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]).
outwiremode	: (Output) RTD wire mode

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_RTD_GetZeroTempResistance()

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:

Resistance Range           RTD Type                ZeroTempResistance
______________________________________________________________________________
18-400 ohms                PT-100             NAI_RTD_ZERO_TEMP_RESISTANCE_100
90-2000 ohms               PT-500             NAI_RTD_ZERO_TEMP_RESISTANCE_500
180-4000 ohms              Pt-1000            NAI_RTD_ZERO_TEMP_RESISTANCE_1000
0-8000 ohms                Pt-2000            NAI_RTD_ZERO_TEMP_RESISTANCE_2000

Note: The Pt-2000 setting only applies to Gen5 RTD modules with FPGA Revision 2.3 or later.

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]).
outZeroTempResistance	: (Output) Transducer's 0 degree Celsius setting.

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_RTD_GetZeroTempResistanceEx()

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.

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]).
outZeroTempResistance	: (Output) Transducer's 0 degree Celsius setting.

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_RTD_SetBackgroundOpSuspend()

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.

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 selects all channels.
disable	: (Input) 1 to suspend BIT/Open tests, 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_RTD_SetChanStatusEnable()

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.

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_RTD_SetCompResistance()

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.

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]).
resistance	: (Input) Two-wire lead compensation resistance in ohms.

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_RTD_SetConfiguration()

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

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_RTD_SetOffsetTemperature()

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.

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_RTD_SetRange()

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:

      G4                     Range
Resistance Range            Register Value              LSB (ohm)
______________________________________________________________________
0-200 ohm                          0                      0.005
0-400 ohm                          1                      0.01
0-800 ohm                          2                      0.02
0-2000 ohm                         3                      0.04
0-4000 ohm                         4                      0.08
0-6500 ohm                         5                      0.16

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]).
range	: (Input) Resistance range in ohms.

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_RTD_SetSampleRate()

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

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_RTD_SetWireMode()

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:

                         Gen3 (G4)                    Gen5 (RT1)
Wire Mode              wiremode value               wiremode Value
________________________________________________________________________
2-wire             NAI_RTD_GEN3_WIRE_MODE_2     NAI_RTD_GEN5_WIRE_MODE_2
3-wire             NAI_RTD_GEN3_WIRE_MODE_3     NAI_RTD_GEN5_WIRE_MODE_3
4-wire             NAI_RTD_GEN3_WIRE_MODE_4     NAI_RTD_GEN5_WIRE_MODE_4

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]).
wiremode	: (Input) RTD wire mode

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_RTD_SetZeroTempResistance()

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:

Resistance Range           RTD Type                ZeroTempResistance
______________________________________________________________________________
18-400 ohms                PT-100             NAI_RTD_ZERO_TEMP_RESISTANCE_100
90-2000 ohms               PT-500             NAI_RTD_ZERO_TEMP_RESISTANCE_500
180-4000 ohms              Pt-1000            NAI_RTD_ZERO_TEMP_RESISTANCE_1000
0-8000 ohms                Pt-2000            NAI_RTD_ZERO_TEMP_RESISTANCE_2000

Note: The Pt-2000 setting only applies to Gen5 RTD modules with FPGA Revision 2.3 or later.

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]).
zeroTempResistance	: (Input) Transducer's 0 degree Celsius setting.

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_RTD_SetZeroTempResistanceEx()

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.

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]).
zeroTempResistance	: (Input) Transducer's 0 degree Celsius setting.

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_RTD_TriggerBackgroundOperation()

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.

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