Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_SetChanMode (int32_t cardIndex, int32_t module, int32_t channel, nai_lvdt_format_t mode)
	Sets the LVDT Configuration Mode for the specified channel.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_GetChanMode (int32_t cardIndex, int32_t module, int32_t channel, nai_lvdt_format_t *outmode)
	Retrieves the LVDT Configuration Mode from the specified channel.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_SetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, uint32_t setting)
	Sets the channel status enable bit for the specified channel. When the channel status enable is set to "NAI_LVDT_CHAN_STATUS_ENABLE_ACTIVE", it will report any bad status in the following module functions: 1. BIT Status,.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_GetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outsetting)
	Gets the channel status enable bit for the specified channel. When the channel status enable is set to "NAI_LVDT_CHAN_STATUS_ENABLE_ACTIVE", it will report any bad status in the following module functions: 1. BIT Status,.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_SetSigLossThreshold (int32_t cardIndex, int32_t module, int32_t channel, float64_t threshold)
	Sets the minimum signal voltage level in volts before indicating a signal loss for the specified channel.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_GetSigLossThreshold (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outthreshold)
	Retrieves the minimum signal voltage level in volts before indicating a signal loss from the specified channel.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_SetRefLossThreshold (int32_t cardIndex, int32_t module, int32_t channel, float64_t threshold)
	Sets the minimum reference voltage level in volts before indicating a reference loss for the specified channel.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_GetRefLossThreshold (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outthreshold)
	Retrieves the minimum reference voltage level in volts before indicating a reference loss from the specified channel.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_SetSignalInversion (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_signal_inversion_type_t sigType, naibrd_lvdt_signal_inversion_resp_value_type_t sigInvRespType)
	Sets the invert signal selection. The signal inversion control is bit mapped to a register and is defined below: Definition: D0: Inverted Va = 1, Non-inverted Va = 0. D1: Inverted Vb = 1, Non-inverted Vb = 0. D2: Inverted Ref = 1, Non-inverted Ref = 0. D3: Vb-Va = 1, Va-Vb = 0. This function works with LVDT modules that support hardware floating point operation only.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_GetSignalInversion (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_signal_inversion_type_t sigType, naibrd_lvdt_signal_inversion_resp_value_type_t *p_outsigInvRespType)
	Retrieves the invert signal selection. The signal inversion control is bit mapped to a register and is defined below: Definition: D0: Inverted Va = 1, Non-inverted Va = 0. D1: Inverted Vb = 1, Non-inverted Vb = 0. D2: Inverted Ref = 1, Non-inverted Ref = 0. D3: Vb-Va = 1, Va-Vb = 0. This function works with LVDT modules that support hardware floating point operation only.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_SetInverse (int32_t cardIndex, int32_t module, int32_t channel, uint32_t value)
	Sets the inverse for the Va, Vb or reference controls.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_GetInverse (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outvalue)
	Retrieves the inverse for the Va, Vb or reference controls.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_SetOpenThreshold (int32_t cardIndex, int32_t module, int32_t channel, float64_t threshold)
	Sets the minimum open level in volts before indicating a reference loss from the specified channel.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_GetOpenThreshold (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outthreshold)
	Retrieves the minimum open level in volts before indicating a reference loss from the specified channel.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_SetShortThreshold (int32_t cardIndex, int32_t module, int32_t channel, float64_t threshold)
	Sets the minimum threshold for the short status.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_GetShortThreshold (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outthreshold)
	Gets the minimum threshold for the short status.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_SetLVDTScale (int32_t cardIndex, int32_t module, int32_t channel, uint32_t scale)
	Sets the LVDT scale from a specified channel.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_GetLVDTScale (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outScale)
	Gets the LVDT scale from a specified channel.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_SetTRValue (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_2_wire_t type, uint32_t trValue)
	Sets the LVDT transformation ratio value for 2-wire A or B side of the specified channel. Currently independent TR value for B-side is not supported. Use naibrd_lvdt_2_wire_t type with the value NAIBRD_LVDT_TWO_WIRE_A to set the TR ratio for both A and B side of the specific channel.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_GetTRValue (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_2_wire_t type, uint32_t *p_outTrValue)
	Retrieves the LVDT transformation ratio value for 2-wire A or B side of the specified channel. Currently independent TR value for B-side is not supported. Use naibrd_lvdt_2_wire_t type with the value NAIBRD_LVDT_TWO_WIRE_A to set the TR ratio for both A and B side of the specific channel.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_SetBandwidth (int32_t cardIndex, int32_t module, int32_t channel, uint32_t bandwidth)
	Sets the Bandwidth for the specified channel in 2 Hz resolution from 6Hz to 1280Hz.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_GetBandwidth (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outbandwidth)
	Retrieves the Bandwidth from the specified channel in 2 Hz resolution from 6Hz to 1280Hz.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_SetBandwidthSelect (int32_t cardIndex, int32_t module, int32_t channel, nai_lvdt_bandwidth_select_t bwselect)
	Sets the Bandwidth Select for the specified channel. The BW Select can be set to "Automatic" or "Manual". When in "Automatic BW" mode, the input reference frequency is read and the bandwidth is automatically adjusted to approximately 1/10 of the carrier frequency. The Auto Bandwidth range has a minimum value of 10 Hz and a maximum value of 100 Hz. When in "Manual BW" mode, the user can enter the bandwidth between the range of 6 Hz and 1280 Hz, in 2 Hz increments.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_GetBandwidthSelect (int32_t cardIndex, int32_t module, int32_t channel, nai_lvdt_bandwidth_select_t *outbwselect)
	Retrieves the Bandwidth Select from the specified channel. The BW Select can be set to "Automatic" or "Manual". When in "Automatic BW" mode, the input reference frequency is read and the bandwidth is automatically adjusted to approximately 1/10 of the carrier frequency. The Auto Bandwidth range has a minimum value of 10 Hz and a maximum value of 100 Hz. When in "Manual BW" mode, the user can enter the bandwidth between the range of 6 Hz and 1280 Hz, in 2 Hz increments.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_SetActiveChannel (int32_t cardIndex, int32_t module, int32_t channel, uint32_t setting)
	Note: This routine has been deprecated and has been replaced with naibrd_LVDT_SetChanStatusEnable.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_GetActiveChannel (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outsetting)
	Note: This routine has been deprecated and has been replaced with naibrd_LVDT_GetChanStatusEnable.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_SetFloatingPointPositionOffset (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_2_wire_t type, float64_t positionOffset)
	Sets the HW floating point position offset for the specified LVDT channel. This feature is only applicable when the HW floating point conversion mode is enabled (See naibrd_SetFloatingPointModeEnable()). Not all modules support HW floating point conversions, please refer to the module's HW specification for details.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_GetFloatingPointPositionOffset (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_2_wire_t type, float64_t *outpositionOffset)
	Retrieves the HW floating point position offset for the specified LVDT channel. This feature is only applicable when the HW floating point conversion mode is enabled (See naibrd_SetFloatingPointModeEnable()). Not all modules support HW floating point conversions, please refer to the module's HW specification for details.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_SetFloatingPointPositionScale (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_2_wire_t type, float64_t positionScale)
	Sets the HW floating point position scale factor for the specified LVDT channel. This feature is only applicable when the HW floating point conversion mode is enabled (See naibrd_SetFloatingPointModeEnable()). Not all modules support HW floating point conversions, please refer to the module's HW specification for details.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_GetFloatingPointPositionScale (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_2_wire_t type, float64_t *outpositionScale)
	Retrieves the HW floating point position scale factor for the specified LVDT channel. This feature is only applicable when the HW floating point conversion mode is enabled (See naibrd_SetFloatingPointModeEnable()). Not all modules support HW floating point conversions, please refer to the module's HW specification for details.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_SetFloatingPointVelocityOffset (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_2_wire_t type, float64_t velocityOffset)
	Sets the HW floating point velocity offset for the specified LVDT channel. This feature is only applicable when the HW floating point conversion mode is enabled (See naibrd_SetFloatingPointModeEnable()). Not all modules support HW floating point conversions, please refer to the module's HW specification for details.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_GetFloatingPointVelocityOffset (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_2_wire_t type, float64_t *outVelocityOffset)
	Retrieves the HW floating point velocity offset for the specified LVDT channel. This feature is only applicable when the HW floating point conversion mode is enabled (See naibrd_SetFloatingPointModeEnable()). Not all modules support HW floating point conversions, please refer to the module's HW specification for details.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_SetFloatingPointVelocityScale (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_2_wire_t type, float64_t velocityScale)
	Sets the HW floating point velocity scale factor for the specified LVDT channel. This feature is only applicable when the HW floating point conversion mode is enabled (See naibrd_SetFloatingPointModeEnable()). Not all modules support HW floating point conversions, please refer to the module's HW specification for details.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_GetFloatingPointVelocityScale (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_2_wire_t type, float64_t *outVelocityScale)
	Retrieves the HW floating point velocity scale factor for the specified LVDT channel. This feature is only applicable when the HW floating point conversion mode is enabled (See naibrd_SetFloatingPointModeEnable()). Not all modules support HW floating point conversions, please refer to the module's HW specification for details.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_SetThreshold (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_threshold_t type, float64_t threshold)
	Sets the threshold (depending on the naibrd_sd_threshold_t type specified) for the specified LVDT channel.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_GetThreshold (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_threshold_t type, float64_t *p_outthreshold)
	Retrieves threshold (depending on the naibrd_sd_threshold_t type specified) for the specified LVDT channel.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_SetDeltaPosition (int32_t cardIndex, int32_t module, int32_t channel, float64_t deltaPosition)
	Sets the Delta Position Value for the specified LVDT channel. Note: When floating-point mode is disabled, the valid position range is from -50.0 to 50.0. When floating-point mode is enabled, the valid position range is based on the values in the floating-point position scale and offset registers. In floating-point mode, the valid position range goes from (-1.0 * position scale) + position offset to (1.0 * position scale) + position offset. Values in the position scale and offset registers are interpreted as IEEE-754 floating-point values for these calculations.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_GetDeltaPosition (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outDeltaPosition)
	Retrieves the Delta Position Value for the specified LVDT channel. Note: When floating-point mode is disabled, the valid position range is from -50.0 to 50.0. When floating-point mode is enabled, the valid position range is based on the values in the floating-point position scale and offset registers. In floating-point mode, the valid position range goes from (-1.0 * position scale) + position offset to (1.0 * position scale) + position offset. Values in the position scale and offset registers are interpreted as IEEE-754 floating-point values for these calculations.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_LVDT_SetInitDeltaPosition (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
	Sets the Init Delta Position Register Value for the specified LVDT channel.

Detailed Description

Function Documentation

◆ naibrd_LVDT_GetActiveChannel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetActiveChannel	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		uint32_t *	outsetting )

Note: This routine has been deprecated and has been replaced with naibrd_LVDT_GetChanStatusEnable.

Retrieves the Active Channel bit from the specified channel. Setting the active channel bit to "inactive" for unused channels prevents false alarms from being generated for unused channels.

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]).
outsetting	: (Input) Active Channel Setting (0 for inactive, 1 for active).

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetBandwidth	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		uint32_t *	outbandwidth )

Retrieves the Bandwidth from the specified channel in 2 Hz resolution from 6Hz to 1280Hz.

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]).
outbandwidth	: (Input) 2 < Bandwidth <1280 Hz with 2 Hz resolution.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetBandwidthSelect	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_lvdt_bandwidth_select_t *	outbwselect )

Retrieves the Bandwidth Select from the specified channel. The BW Select can be set to "Automatic" or "Manual". When in "Automatic BW" mode, the input reference frequency is read and the bandwidth is automatically adjusted to approximately 1/10 of the carrier frequency. The Auto Bandwidth range has a minimum value of 10 Hz and a maximum value of 100 Hz. When in "Manual BW" mode, the user can enter the bandwidth between the range of 6 Hz and 1280 Hz, in 2 Hz increments.

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]).
outbwselect	: (Output) NAI_LVDT_BW_MANUAL or NAI_LVDT_BW_AUTOMATIC.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetChanMode	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_lvdt_format_t *	outmode )

Retrieves the LVDT Configuration Mode from 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]).
outmode	: (Output) NAI_LVDT_2WIRE or NAI_LVDT_4WIRE.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetChanStatusEnable	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		uint32_t *	outsetting )

Gets the channel status enable bit for the specified channel. When the channel status enable is set to "NAI_LVDT_CHAN_STATUS_ENABLE_ACTIVE", it will report any bad status in the following module functions: 1. BIT Status,.

Ref Loss Status, and 3. Sig Loss Status. When the channel status enable bit is set to NAI_LVDT_CHAN_STATUS_ENABLE_INACTIVE, no bad status will be reported. The channel status enable is bit-mapped to the register. If the register has a value of 0xC, channel 1 and 2 will not report any bad status.

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]).
outsetting	: (Output) Chan Status Enable (0 for inactive, 1 for active).

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 setting parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_GetDeltaPosition()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetDeltaPosition	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t *	p_outDeltaPosition )

Retrieves the Delta Position Value for the specified LVDT channel. Note: When floating-point mode is disabled, the valid position range is from -50.0 to 50.0. When floating-point mode is enabled, the valid position range is based on the values in the floating-point position scale and offset registers. In floating-point mode, the valid position range goes from (-1.0 * position scale) + position offset to (1.0 * position scale) + position offset. Values in the position scale and offset registers are interpreted as IEEE-754 floating-point values for these calculations.

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_outDeltaPosition	: (Output) Delta Position Value 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_LVDT_GetFloatingPointPositionOffset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFloatingPointPositionOffset	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_lvdt_2_wire_t	type,
		float64_t *	outpositionOffset )

Retrieves the HW floating point position offset for the specified LVDT channel. This feature is only applicable when the HW floating point conversion mode is enabled (See naibrd_SetFloatingPointModeEnable()). Not all modules support HW floating point conversions, please refer to the module's HW specification for details.

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]).
type	: (Input) Wire Type (2 wire or 4 wire) .
outpositionOffset	: (Output) Floating-point position offset read from register.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFloatingPointPositionScale	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_lvdt_2_wire_t	type,
		float64_t *	outpositionScale )

Retrieves the HW floating point position scale factor for the specified LVDT channel. This feature is only applicable when the HW floating point conversion mode is enabled (See naibrd_SetFloatingPointModeEnable()). Not all modules support HW floating point conversions, please refer to the module's HW specification for details.

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]).
type	: (Input) Wire Type (2 wire or 4 wire) .
outpositionScale	: (Output) Floating-point position scale factor setting read from register.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFloatingPointVelocityOffset	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_lvdt_2_wire_t	type,
		float64_t *	outVelocityOffset )

Retrieves the HW floating point velocity offset for the specified LVDT channel. This feature is only applicable when the HW floating point conversion mode is enabled (See naibrd_SetFloatingPointModeEnable()). Not all modules support HW floating point conversions, please refer to the module's HW specification for details.

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]).
type	: (Input) Wire Type (2 wire or 4 wire) .
outVelocityOffset	: (Output) Floating-point velocity offset read from register.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFloatingPointVelocityScale	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_lvdt_2_wire_t	type,
		float64_t *	outVelocityScale )

Retrieves the HW floating point velocity scale factor for the specified LVDT channel. This feature is only applicable when the HW floating point conversion mode is enabled (See naibrd_SetFloatingPointModeEnable()). Not all modules support HW floating point conversions, please refer to the module's HW specification for details.

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]).
type	: (Input) Wire Type (2 wire or 4 wire) .
outVelocityScale	: (Output) Floating-point velocity scale factor setting read from register.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetInverse	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		uint32_t *	outvalue )

Retrieves the inverse for the Va, Vb or reference controls.

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]).
outvalue	: (Output) D0: Inverts Va, D1: Inverts Vb, D2: Inverts the Reference, D3: Changes algorithm from (Va � Vb) / (Va + Vb) to (Vb � Va) / (Va + Vb).

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetLVDTScale	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		uint32_t *	outScale )

Gets the LVDT scale from a 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]).
outScale	: (Output) Scale received.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetOpenThreshold	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t *	outthreshold )

Retrieves the minimum open level in volts before indicating a reference loss from 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]).
outthreshold	: (Output) Threshold received.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetRefLossThreshold	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t *	outthreshold )

Retrieves the minimum reference voltage level in volts before indicating a reference loss from 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]).
outthreshold	: (Output) 0.0 <= threshold <= 115.000 Volts.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetShortThreshold	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t *	outthreshold )

Gets the minimum threshold for the short status.

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]).
outthreshold	: (Output) Threshold received.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetSigLossThreshold	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t *	outthreshold )

Retrieves the minimum signal voltage level in volts before indicating a signal loss from 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]).
outthreshold	: (Output) 0.0 <= threshold <= 90.000 Volts.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetSignalInversion	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_lvdt_signal_inversion_type_t	sigType,
		naibrd_lvdt_signal_inversion_resp_value_type_t *	p_outsigInvRespType )

Retrieves the invert signal selection. The signal inversion control is bit mapped to a register and is defined below: Definition: D0: Inverted Va = 1, Non-inverted Va = 0. D1: Inverted Vb = 1, Non-inverted Vb = 0. D2: Inverted Ref = 1, Non-inverted Ref = 0. D3: Vb-Va = 1, Va-Vb = 0. This function works with LVDT modules that support hardware floating point operation only.

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]).
sigType	: (Input) Signal inversion type: refer to naibrd_lvdt_signal_inversion_type_t definition.
p_outsigInvRespType	: (Output) Signal response type: refer to naibrd_lvdt_signal_inversion_resp_value_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 sigType parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_GetThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetThreshold	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_lvdt_threshold_t	type,
		float64_t *	p_outthreshold )

Retrieves threshold (depending on the naibrd_sd_threshold_t type specified) for the specified LVDT channel.

The following threshold types are only supported on FPGA rev > 9.13: NAIBRD_LVDT_SIG_FAULT_HI_THRESHOLD, NAIBRD_LVDT_REF_FAULT_HI_THRESHOLD,

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]).
type	: (Input) Threshold type to read (see naibrd_sd_threshold_t definition).
p_outthreshold	: (Output) Threshold value read from register.

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 type parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_GetTRValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetTRValue	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_lvdt_2_wire_t	type,
		uint32_t *	p_outTrValue )

Retrieves the LVDT transformation ratio value for 2-wire A or B side of the specified channel. Currently independent TR value for B-side is not supported. Use naibrd_lvdt_2_wire_t type with the value NAIBRD_LVDT_TWO_WIRE_A to set the TR ratio for both A and B side of the specific 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]).
type	: (Input) 2-wire type: refer to naibrd_lvdt_2_wire_t definition.
p_outTrValue	: (Output) Transformation Ratio raw value read from register.

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 type parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_SetActiveChannel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetActiveChannel	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		uint32_t	setting )

Note: This routine has been deprecated and has been replaced with naibrd_LVDT_SetChanStatusEnable.

Sets the Active Channel bit for the specified channel. Setting the active channel bit to "inactive" for unused channels prevents false alarms from being generated for unused channels.

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]).
setting	: (Input) Active Channel Setting (0 for inactive, 1 for active).

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 setting parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_SetBandwidth()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetBandwidth	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		uint32_t	bandwidth )

Sets the Bandwidth for the specified channel in 2 Hz resolution from 6Hz to 1280Hz.

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]).
bandwidth	: (Input) 2 < Bandwidth <1280 Hz with 2 Hz resolution.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetBandwidthSelect	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_lvdt_bandwidth_select_t	bwselect )

Sets the Bandwidth Select for the specified channel. The BW Select can be set to "Automatic" or "Manual". When in "Automatic BW" mode, the input reference frequency is read and the bandwidth is automatically adjusted to approximately 1/10 of the carrier frequency. The Auto Bandwidth range has a minimum value of 10 Hz and a maximum value of 100 Hz. When in "Manual BW" mode, the user can enter the bandwidth between the range of 6 Hz and 1280 Hz, in 2 Hz increments.

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]).
bwselect	: (Input) NAI_LVDT_BW_MANUAL or NAI_LVDT_BW_AUTOMATIC.

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 bwselect parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_SetChanMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetChanMode	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_lvdt_format_t	mode )

Sets the LVDT Configuration Mode 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]).
mode	: (Input) NAI_LVDT_2WIRE or NAI_LVDT_4WIRE.

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_MODE when invalid mode parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_SetChanStatusEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetChanStatusEnable	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		uint32_t	setting )

Sets the channel status enable bit for the specified channel. When the channel status enable is set to "NAI_LVDT_CHAN_STATUS_ENABLE_ACTIVE", it will report any bad status in the following module functions: 1. BIT Status,.

Ref Loss Status, and 3. Sig Loss Status. When the channel status enable bit is set to NAI_LVDT_CHAN_STATUS_ENABLE_INACTIVE, no bad status will be reported. The channel status enable is bit-mapped to the register. If the register has a value of 0xC, channel 1 and 2 will not report any bad status.

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]).
setting	: (Input) Chan Status Enable (0 for inactive, 1 for active).

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 setting parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_SetDeltaPosition()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetDeltaPosition	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t	deltaPosition )

Sets the Delta Position Value for the specified LVDT channel. Note: When floating-point mode is disabled, the valid position range is from -50.0 to 50.0. When floating-point mode is enabled, the valid position range is based on the values in the floating-point position scale and offset registers. In floating-point mode, the valid position range goes from (-1.0 * position scale) + position offset to (1.0 * position scale) + position offset. Values in the position scale and offset registers are interpreted as IEEE-754 floating-point values for these calculations.

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]).
deltaPosition	: (Input) Delta Position Value to set.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetFloatingPointPositionOffset	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_lvdt_2_wire_t	type,
		float64_t	positionOffset )

Sets the HW floating point position offset for the specified LVDT channel. This feature is only applicable when the HW floating point conversion mode is enabled (See naibrd_SetFloatingPointModeEnable()). Not all modules support HW floating point conversions, please refer to the module's HW specification for details.

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]).
type	: (Input) Wire Type (2 wire or 4 wire) .
positionOffset	: (Input) Floating-point position offset setting to set.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetFloatingPointPositionScale	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_lvdt_2_wire_t	type,
		float64_t	positionScale )

Sets the HW floating point position scale factor for the specified LVDT channel. This feature is only applicable when the HW floating point conversion mode is enabled (See naibrd_SetFloatingPointModeEnable()). Not all modules support HW floating point conversions, please refer to the module's HW specification for details.

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]).
type	: (Input) Wire Type (2 wire or 4 wire) .
positionScale	: (Input) Floating-point position scale factor setting to set.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetFloatingPointVelocityOffset	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_lvdt_2_wire_t	type,
		float64_t	velocityOffset )

Sets the HW floating point velocity offset for the specified LVDT channel. This feature is only applicable when the HW floating point conversion mode is enabled (See naibrd_SetFloatingPointModeEnable()). Not all modules support HW floating point conversions, please refer to the module's HW specification for details.

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]).
type	: (Input) Wire Type (2 wire or 4 wire) .
velocityOffset	: (Input) Floating-point velocity offset setting to set.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetFloatingPointVelocityScale	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_lvdt_2_wire_t	type,
		float64_t	velocityScale )

Sets the HW floating point velocity scale factor for the specified LVDT channel. This feature is only applicable when the HW floating point conversion mode is enabled (See naibrd_SetFloatingPointModeEnable()). Not all modules support HW floating point conversions, please refer to the module's HW specification for details.

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]).
type	: (Input) Wire Type (2 wire or 4 wire) .
velocityScale	: (Input) Floating-point velocity scale factor setting to set.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetInitDeltaPosition	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		bool_t	enable )

Sets the Init Delta Position Register Value for the specified LVDT 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) 1 to enable Delta Position Status reporting, 0 to disable Delta Position Status reporting.

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 enable parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_SetInverse()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetInverse	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		uint32_t	value )

Sets the inverse for the Va, Vb or reference controls.

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]).
value	: (Output) D0: Inverts Va, D1: Inverts Vb, D2: Inverts the Reference, D3: Changes algorithm from (Va � Vb) / (Va + Vb) to (Vb � Va) / (Va + Vb).

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetLVDTScale	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		uint32_t	scale )

Sets the LVDT scale from a 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]).
scale	: (Input) Scale to be set.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetOpenThreshold	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t	threshold )

Sets the minimum open level in volts before indicating a reference loss from 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]).
threshold	: Threshold set.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetRefLossThreshold	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t	threshold )

Sets the minimum reference voltage level in volts before indicating a reference loss 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]).
threshold	: (Input) 0.0 <= threshold <= 115.000 Volts.

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 threshold parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_SetShortThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetShortThreshold	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t	threshold )

Sets the minimum threshold for the short status.

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]).
threshold	: (Output) Threshold set.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetSigLossThreshold	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t	threshold )

Sets the minimum signal voltage level in volts before indicating a signal loss 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]).
threshold	: (Input) 0.0 <= threshold <= 90.000 Volts.

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 threshold parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_SetSignalInversion()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetSignalInversion	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_lvdt_signal_inversion_type_t	sigType,
		naibrd_lvdt_signal_inversion_resp_value_type_t	sigInvRespType )

Sets the invert signal selection. The signal inversion control is bit mapped to a register and is defined below: Definition: D0: Inverted Va = 1, Non-inverted Va = 0. D1: Inverted Vb = 1, Non-inverted Vb = 0. D2: Inverted Ref = 1, Non-inverted Ref = 0. D3: Vb-Va = 1, Va-Vb = 0. This function works with LVDT modules that support hardware floating point operation only.

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]).
sigType	: (Input) Signal inversion type: refer to naibrd_lvdt_signal_inversion_type_t definition.
sigInvRespType	: (Input) Signal response type: refer to naibrd_lvdt_signal_inversion_resp_value_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 sigType parameter or invalid sigInvRespType parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_SetThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetThreshold	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_lvdt_threshold_t	type,
		float64_t	threshold )

Sets the threshold (depending on the naibrd_sd_threshold_t type specified) for the specified LVDT channel.

The following threshold types are only supported on FPGA rev > 9.13: NAIBRD_LVDT_SIG_FAULT_HI_THRESHOLD, NAIBRD_LVDT_REF_FAULT_HI_THRESHOLD

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]).
type	: (Input) Threshold type to set (see naibrd_sd_threshold_t definition).
threshold	: (Input) Threshold value to set.

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 type parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_SetTRValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetTRValue	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_lvdt_2_wire_t	type,
		uint32_t	trValue )

Sets the LVDT transformation ratio value for 2-wire A or B side of the specified channel. Currently independent TR value for B-side is not supported. Use naibrd_lvdt_2_wire_t type with the value NAIBRD_LVDT_TWO_WIRE_A to set the TR ratio for both A and B side of the specific 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]).
type	: (Input) 2-wire type: refer to naibrd_lvdt_2_wire_t definition.
trValue	: (Input) Transformation Ratio raw value to write to register.

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 type parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

Functions

Detailed Description

Function Documentation

◆ naibrd_LVDT_GetActiveChannel()

◆ naibrd_LVDT_GetBandwidth()

◆ naibrd_LVDT_GetBandwidthSelect()

◆ naibrd_LVDT_GetChanMode()

◆ naibrd_LVDT_GetChanStatusEnable()

◆ naibrd_LVDT_GetDeltaPosition()

◆ naibrd_LVDT_GetFloatingPointPositionOffset()

◆ naibrd_LVDT_GetFloatingPointPositionScale()

◆ naibrd_LVDT_GetFloatingPointVelocityOffset()

◆ naibrd_LVDT_GetFloatingPointVelocityScale()

◆ naibrd_LVDT_GetInverse()

◆ naibrd_LVDT_GetLVDTScale()

◆ naibrd_LVDT_GetOpenThreshold()

◆ naibrd_LVDT_GetRefLossThreshold()

◆ naibrd_LVDT_GetShortThreshold()

◆ naibrd_LVDT_GetSigLossThreshold()

◆ naibrd_LVDT_GetSignalInversion()

◆ naibrd_LVDT_GetThreshold()

◆ naibrd_LVDT_GetTRValue()

◆ naibrd_LVDT_SetActiveChannel()

◆ naibrd_LVDT_SetBandwidth()

◆ naibrd_LVDT_SetBandwidthSelect()

◆ naibrd_LVDT_SetChanMode()

◆ naibrd_LVDT_SetChanStatusEnable()

◆ naibrd_LVDT_SetDeltaPosition()

◆ naibrd_LVDT_SetFloatingPointPositionOffset()

◆ naibrd_LVDT_SetFloatingPointPositionScale()

◆ naibrd_LVDT_SetFloatingPointVelocityOffset()

◆ naibrd_LVDT_SetFloatingPointVelocityScale()

◆ naibrd_LVDT_SetInitDeltaPosition()

◆ naibrd_LVDT_SetInverse()

◆ naibrd_LVDT_SetLVDTScale()

◆ naibrd_LVDT_SetOpenThreshold()

◆ naibrd_LVDT_SetRefLossThreshold()

◆ naibrd_LVDT_SetShortThreshold()

◆ naibrd_LVDT_SetSigLossThreshold()

◆ naibrd_LVDT_SetSignalInversion()

◆ naibrd_LVDT_SetThreshold()

◆ naibrd_LVDT_SetTRValue()