Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Standard Operation Functions
LVDT Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetPosition (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outposition)
 Retrieves the position from the specified channel. The position value is scaled between -50 to +50.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetTwoWirePosition (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_2_wire_t type, float64_t *p_outposition)
 Retrieves the position in 2 wire A or B side of the specified channel. The position value is scaled between -50 to +50.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetVelocity (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outvelocity)
 Retrieves the velocity from the specified channel. The velocity value is resprented as 1/10th precentage change per second.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetTwoWireVelocity (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_2_wire_t type, float64_t *p_outvelocity)
 Retrieves the velocity in 2 wire A or B side of the specified channel. The velocity value is scaled between -50 to +50.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFrequency (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outfrequency)
 Retrieves the Frequency in Hertz from the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetSignalVoltage (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outsigvolt)
 Retrieves the signal voltage (VLL) in volts from the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetRefVoltage (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outrefvolt)
 Retrieves the reference voltage in volts from the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_lvdt_status_type_t type, uint32_t *outstatus)
 Retrieves the LVDT Status from the specified channel. Feature NAI_LVDT_STATUS_SUMMARY supported in FPGA Version >= 9.28.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetVaSignal (int32_t cardIndex, int32_t module, int32_t channel, nai_lvdt_signal_type_t type, float64_t *outsignal)
 Retrieves Va signal from the module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetVbSignal (int32_t cardIndex, int32_t module, int32_t channel, nai_lvdt_signal_type_t type, float64_t *outsignal)
 Retrieves Va signal from the module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetVaVbSignal (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outsignal)
 Retrieves Va + Vb signal from the module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_ClearStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_lvdt_status_type_t type)
 Clears the latched status for the specified LVDT channel and status type. Feature NAI_LVDT_STATUS_SUMMARY supported in FPGA Version >= 9.28.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetLatch (int32_t cardIndex, int32_t module, int32_t channel, uint32_t latch)
 Sets the Latch Control register to Latch the Position Data for the specified channel. The Latch Control register allows for simultaneously measure inputs. After latching the channel, the position data is latched until it is released by reading the channel's Position Data register or setting the Latch Control register to 0.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetLatch (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outlatch)
 Retrieves the state of the Latch Control bit of the Latch Control Register for the specified channel. The Latch Control register allows simultaneous input measurements. After latching the channel, the position data is latched until it is released by reading the channel's Position Data register or setting the Latch Control register to 0.
 

Detailed Description


Function Documentation

◆ naibrd_LVDT_ClearStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_ClearStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_lvdt_status_type_t type )

Clears the latched status for the specified LVDT channel and status type. Feature NAI_LVDT_STATUS_SUMMARY supported in FPGA Version >= 9.28.

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) Status Type: refer to nai_lvdt_status_type_t definition.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card 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 status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_GetFrequency()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFrequency ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * outfrequency )

Retrieves the Frequency in Hertz 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]).
outfrequency: (Output) Frequency reading in Hertz.
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_GetLatch()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetLatch ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * outlatch )

Retrieves the state of the Latch Control bit of the Latch Control Register for the specified channel. The Latch Control register allows simultaneous input measurements. After latching the channel, the position data is latched until it is released by reading the channel's Position Data register or setting the Latch Control register to 0.

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]).
outlatch: (Output) 0 indicates channel is unlatched. 1 indicates latched.
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_GetPosition()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetPosition ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * outposition )

Retrieves the position from the specified channel. The position value is scaled between -50 to +50. 

At -50, the postion is at the maximum negative Full Scale.
At 0, the position is at the center.
At +50, the postion is at the maximum postive Full Scale.
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]).
outposition: (Output) Position reading scaled between -50 and +50.
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_GetRefVoltage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetRefVoltage ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * outrefvolt )

Retrieves the reference voltage in volts 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]).
outrefvolt: (Output) Reference Voltage reading 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_GetSignalVoltage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetSignalVoltage ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * outsigvolt )

Retrieves the signal voltage (VLL) in volts 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]).
outsigvolt: (Output) VLL reading 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_GetStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_lvdt_status_type_t type,
uint32_t * outstatus )

Retrieves the LVDT Status from the specified channel. Feature NAI_LVDT_STATUS_SUMMARY supported in FPGA Version >= 9.28.

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) Status Type: refer to nai_lvdt_status_type_t definition
outstatus: (Output) 0 for Normal, 1 for Failure.
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_GetTwoWirePosition()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetTwoWirePosition ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_2_wire_t type,
float64_t * p_outposition )

Retrieves the position in 2 wire A or B side of the specified channel. The position value is scaled between -50 to +50. 

* At -50, the postion is at the maximum negative Full Scale.
* At 0, the position is at the center.
* At +50, the postion is at the maximum postive Full Scale.
*
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) Position Type: refer to naibrd_lvdt_2_wire_t definition.
p_outposition: (Output) Position reading scaled between -100 and +100.
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_GetTwoWireVelocity()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetTwoWireVelocity ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_2_wire_t type,
float64_t * p_outvelocity )

Retrieves the velocity in 2 wire A or B side of the specified channel. The velocity value is scaled between -50 to +50. 

* At -50, the velocity is at the maximum negative Full Scale.
* At 0, the velocity is at the center.
* At +50, the velocity is at the maximum postive Full Scale.
*
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) Position Type: refer to naibrd_lvdt_2_wire_t definition.
p_outvelocity: (Output) Velocity reading scaled between -100 and +100.
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_GetVaSignal()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetVaSignal ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_lvdt_signal_type_t type,
float64_t * outsignal )

Retrieves Va signal from the module.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
type: (Input) Status Type: refer to nai_lvdt_signal_type_t definition.
outsignal: (Output) Out value depending on type inputted.
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_GetVaVbSignal()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetVaVbSignal ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * outsignal )

Retrieves Va + Vb signal from the module.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outsignal: (Output) Va signal + Vb signal.
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_GetVbSignal()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetVbSignal ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_lvdt_signal_type_t type,
float64_t * outsignal )

Retrieves Va signal from the module.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
type: (Input) Status Type: refer to nai_lvdt_signal_type_t definition.
outsignal: (Output) Out value depending on type inputted.
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_GetVelocity()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetVelocity ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * outvelocity )

Retrieves the velocity from the specified channel. The velocity value is resprented as 1/10th precentage change per second. 

At -50, the velocity is -5% to the full scale travel in one second.
At 0, the velocity is 0.
At +50, the velocity is 5% to the full scale travel in one second.
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]).
outvelocity: (Output) Velocity 1/10th precentage change per second.
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_SetLatch()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetLatch ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t latch )

Sets the Latch Control register to Latch the Position Data for the specified channel. The Latch Control register allows for simultaneously measure inputs. After latching the channel, the position data is latched until it is released by reading the channel's Position Data register or setting the Latch Control register to 0.

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]).
latch: (Input) 0 to unlatch or release all latched data. Enter 1 to latch the specified channel.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.