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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetChanMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_format_t mode)
 Sets the LVDT Configuration Mode (2/3-wires, 4-wries) for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetChanMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_format_t *p_outmode)
 Retrieves the LVDT Configuration Mode (2/3-wires, 4-wries) from the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Sets the channel status enable bit for the specified channel. When the channel status enable is set to "NAIBRD_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, bool_t *p_outenable)
 Gets the channel status enable bit for the specified channel. When the channel status enable is set to "NAIBRD_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_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_lvdt_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_lvdt_threshold_t type specified) for the specified LVDT channel.
 
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_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 *p_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, naibrd_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, naibrd_lvdt_bandwidth_select_t *p_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_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 *p_outscale)
 Retrieves the LVDT scale from a specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetTRValue (int32_t cardIndex, int32_t module, int32_t channel, uint32_t trValue)
 Sets the LVDT transformation ratio value for 2-wire A side of a specified channel (only for 2-Wire mode).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetTRValue (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outTrValue)
 Retrieves the LVDT transformation ratio value for 2-wire A side of a specified channel (only for 2-Wire mode).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetTwoWireTRValue (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 (only for 2-Wire mode). 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_GetTwoWireTRValue (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 (only for 2-Wire mode). 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_SetFloatingPointAttributes (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_floating_point_attributes_t attributeType, float64_t attributeValue)
 Sets the HW floating point position or velocity offset or scale factor (depending on the specified naibrd_lvdt_floating_point_attributes_t type) 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_GetFloatingPointAttributes (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_floating_point_attributes_t attributeType, float64_t *p_outAttributeValue)
 Retrieves the HW floating point position or velocity offset or scale factor (depending on the specified naibrd_lvdt_floating_point_attributes_t type) 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_GetDetectValue (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_detect_t detectType, float64_t *p_outdetect)
 Retrieves the Va/Vb detect value (depending on the naibrd_lvdt_detect_t type specified) for the specified LVDT channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetBITErrorLimit (int32_t cardIndex, int32_t module, int32_t channel, float64_t bitErrorLimit)
 Sets the BIT Test Error Limit for the specified LVDT channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetBITErrorLimit (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outbitErrorLimit)
 Retrieves the BIT Test Error Limit 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.
 
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.
 
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.
 
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 *p_outsetting)
 Note: This routine has been deprecated and has been replaced with naibrd_LVDT_GetChanStatusEnable.
 
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 *p_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 *p_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_SetFloatingPointPositionAttributes (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_position_attributes_t positionAttributeType, float64_t attributeValue)
 Sets the HW floating point position offset or scale factor (depending on the specified naibrd_lvdt_position_attributes_t type) 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_GetFloatingPointPositionAttributes (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_position_attributes_t positionAttributeType, float64_t *p_outAttributeValue)
 Retrieves the HW floating point position offset or scale factor (depending on the specified naibrd_lvdt_position_attributes_t type) 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.
 

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 * p_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]).
p_outsetting: (Output) 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 * p_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]).
p_outbandwidth: (Output) 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,
naibrd_lvdt_bandwidth_select_t * p_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]).
p_outbwSelect: (Output) NAIBRD_LVDT_BW_MANUAL or NAIBRD_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_GetBITErrorLimit()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetBITErrorLimit ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * p_outbitErrorLimit )

Retrieves the BIT Test Error Limit 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]).
p_outbitErrorLimit: (Output) Floating-Point BIT Test Error Limit 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_GetChanMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetChanMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_format_t * p_outmode )

Retrieves the LVDT Configuration Mode (2/3-wires, 4-wries) 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]).
p_outmode: (Output) NAIBRD_LVDT_2WIRE or NAIBRD_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,
bool_t * p_outenable )

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

  1. Ref Fault Status, and 3. Sig Fault Status. When the channel status enable bit is set to NAIBRD_LVDT_CHAN_STATUS_ENABLE_INACTIVE, no bad status will be reported. The channel status enable register is bit-mapped per channel. For example, if the register has a value of 0xC, channel 1 and 2 would not report any bad status while channel 3 and 4 would.
Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
p_outenable: (Output) 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.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetDetectValue ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_detect_t detectType,
float64_t * p_outdetect )

Retrieves the Va/Vb detect value (depending on the naibrd_lvdt_detect_t type specified) 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]).
detectType: (Input) Detect value type to read (see naibrd_lvdt_detect_t definition).
p_outdetect: (Output) Detect 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 detectType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_GetFloatingPointAttributes()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFloatingPointAttributes ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_floating_point_attributes_t attributeType,
float64_t * p_outAttributeValue )

Retrieves the HW floating point position or velocity offset or scale factor (depending on the specified naibrd_lvdt_floating_point_attributes_t type) 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]).
attributeType: (Input) Attribute Type to read (see naibrd_lvdt_floating_point_attributes_t definition).
p_outAttributeValue: (Output) Floating-point attribute 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 attributeType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_GetFloatingPointPositionAttributes()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFloatingPointPositionAttributes ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_position_attributes_t positionAttributeType,
float64_t * p_outAttributeValue )

Retrieves the HW floating point position offset or scale factor (depending on the specified naibrd_lvdt_position_attributes_t type) 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]).
positionAttributeType: (Input) Position Attribute Type to read (see naibrd_lvdt_position_attributes_t definition).
p_outAttributeValue: (Output) Floating-point position attribute 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 positionAttributeType 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_GetLVDTScale()

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

Retrieves 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]).
p_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_GetRefLossThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetRefLossThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * p_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]).
p_outthreshold: (Output) Reference threshold in 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_GetSigLossThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetSigLossThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * p_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]).
p_outthreshold: (Output) signal threshold in 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_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_lvdt_threshold_t type specified) 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]).
type: (Input) Threshold type to read (see naibrd_lvdt_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,
uint32_t * p_outTrValue )

Retrieves the LVDT transformation ratio value for 2-wire A side of a specified channel (only for 2-Wire mode).

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_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_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_GetTwoWireTRValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetTwoWireTRValue ( 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 (only for 2-Wire mode). 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) Specify the 2-wire configuration (naibrd_lvdt_2_wire_t).
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 wire 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.

These functions are deprecated and replaced by API functions in naibrd_lvdt.c

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,
naibrd_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) NAIBRD_LVDT_BW_MANUAL or NAIBRD_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_SetBITErrorLimit()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetBITErrorLimit ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t bitErrorLimit )

Sets the BIT Test Error Limit 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]).
bitErrorLimit: (Input) Floating-Point BIT Test Error Limit 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_SetChanMode()

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

Sets the LVDT Configuration Mode (2/3-wires, 4-wries) 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) NAIBRD_LVDT_2WIRE or NAIBRD_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,
bool_t enable )

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

  1. Ref Fault Status, and 3. Sig Fault Status. When the channel status enable bit is set to NAIBRD_LVDT_CHAN_STATUS_ENABLE_INACTIVE, no bad status will be reported. The channel status enable register is bit-mapped per channel. For example, if the register has a value of 0xC, channel 1 and 2 would not report any bad status while channel 3 and 4 would.
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) 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.

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

◆ naibrd_LVDT_SetFloatingPointAttributes()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetFloatingPointAttributes ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_floating_point_attributes_t attributeType,
float64_t attributeValue )

Sets the HW floating point position or velocity offset or scale factor (depending on the specified naibrd_lvdt_floating_point_attributes_t type) 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]).
attributeType: (Input) Attribute Type to set (see naibrd_lvdt_floating_point_attributes_t definition).
attributeValue: (Input) Floating-point attribute 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_INVALID_VALUE when invalid attributeType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_SetFloatingPointPositionAttributes()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetFloatingPointPositionAttributes ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_position_attributes_t positionAttributeType,
float64_t attributeValue )

Sets the HW floating point position offset or scale factor (depending on the specified naibrd_lvdt_position_attributes_t type) 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]).
positionAttributeType: (Input) Position Attribute Type to set (see naibrd_lvdt_position_attributes_t definition).
attributeValue: (Input) Floating-point position attribute 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_INVALID_VALUE when invalid positionAttributeType 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_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_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) Reference threshold in 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_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) Signal threshold in 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_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_lvdt_threshold_t type specified) 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]).
type: (Input) Threshold type to set (see naibrd_lvdt_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,
uint32_t trValue )

Sets the LVDT transformation ratio value for 2-wire A side of a specified channel (only for 2-Wire mode).

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]).
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_SetTwoWireTRValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetTwoWireTRValue ( 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 (only for 2-Wire mode). 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) Specify the 2-wire configuration (naibrd_lvdt_2_wire_t).
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 wire type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.