Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Standard Operation Functions
NAI Board Library - Module Functions » SD Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetAngle (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outAngle)
 Retrieves the angle reading from the specified channel. The angle value is scaled between 0 - 359.9954 Deg.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetVelocity (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outVelocity)
 Retrieves velocity reading from the specified channel. The Velocity Scale register is read and used to scale the returned value between +/- 190.7348 RPS.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFrequency (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outFrequency)
 Retrieves the Frequency in Hertz from the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetSignalVoltage (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outSigVolt)
 Retrieves the signal voltage (VLL) in volts from the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetRefVoltage (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outRefVolt)
 Retrieves the reference voltage in volts from the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetSine (int32_t cardIndex, int32_t module, int32_t channel, float32_t *p_outSine)
 Retrieves the Sine from the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetCosine (int32_t cardIndex, int32_t module, int32_t channel, float32_t *p_outCosine)
 Retrieves the Cosine from the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_sd_chan_mapped_status_type_t type, nai_status_bit_t *p_outStatusBit)
 Retrieves the SD Status from the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_ClearChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_sd_chan_mapped_status_type_t type)
 Clears the latched status for the specified SD channel and status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetLatch (int32_t cardIndex, int32_t module, int32_t channel, uint32_t latch)
 Sets the Latch Control register to Latch the Angle Data for the specified channel. The Latch Control register allows for simultaneously measured inputs. After latching the channel, the angle data is latched until it is released by reading the channel's Angle Data register or setting the Latch Control register to 0.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetLatch (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outLatch)
 Retrieves the Latch Control register to Latch the Angle Data for the specified channel. The Latch Control register allows for simultaneously measured inputs. After latching the channel, the angle data is latched until is release released by reading the channel's Angle Data register or setting the Latch Control register to 0.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_sd_status_type_t type, uint32_t *p_outStatus)
 Retrieves the SD Status from the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_ClearStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_sd_status_type_t type)
 Clears the latched status for the specified SD channel and status type.
 

Detailed Description

Function Documentation

◆ naibrd_SD_ClearChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_ClearChanMappedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_sd_chan_mapped_status_type_t type )

Clears the latched status for the specified SD channel and status type.

The following status types are only supported on FPGA rev > 9.13: NAIBRD_SD_CHAN_MAPPED_STATUS_REF_FAULT_HIGH_LATCHED NAIBRD_SD_CHAN_MAPPED_STATUS_REF_FAULT_HIGH_REALTIME NAIBRD_SD_CHAN_MAPPED_STATUS_SIG_FAULT_HIGH_LATCHED NAIBRD_SD_CHAN_MAPPED_STATUS_SIG_FAULT_HIGH_REALTIME NAIBRD_SD_CHAN_MAPPED_STATUS_SUMMARY_LATCHED and NAIBRD_SD_CHAN_MAPPED_STATUS_SUMMARY_REALTIME 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 naibrd_sd_chan_mapped_status_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_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_SD_ClearStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_ClearStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_sd_status_type_t type )

Clears the latched status for the specified SD channel and status type.

The following status types are only supported on FPGA rev > 9.13: NAIBRD_SD_CHAN_MAPPED_STATUS_REF_FAULT_HIGH_LATCHED NAIBRD_SD_CHAN_MAPPED_STATUS_REF_FAULT_HIGH_REALTIME NAIBRD_SD_CHAN_MAPPED_STATUS_SIG_FAULT_HIGH_LATCHED NAIBRD_SD_CHAN_MAPPED_STATUS_SIG_FAULT_HIGH_REALTIME NAIBRD_SD_CHAN_MAPPED_STATUS_SUMMARY_LATCHED and NAIBRD_SD_CHAN_MAPPED_STATUS_SUMMARY_REALTIME 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 naibrd_sd_chan_mapped_status_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_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_SD_GetAngle()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetAngle ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * p_outAngle )

Retrieves the angle reading from the specified channel. The angle value is scaled between 0 - 359.9954 Deg.

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_outAngle: (Output) Angle reading in degrees.
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_SD_GetChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetChanMappedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_sd_chan_mapped_status_type_t type,
nai_status_bit_t * p_outStatusBit )

Retrieves the SD Status from the specified channel.

The following status types are only supported on FPGA rev > 9.13: NAIBRD_SD_CHAN_MAPPED_STATUS_REF_FAULT_HIGH_LATCHED NAIBRD_SD_CHAN_MAPPED_STATUS_REF_FAULT_HIGH_REALTIME NAIBRD_SD_CHAN_MAPPED_STATUS_SIG_FAULT_HIGH_LATCHED NAIBRD_SD_CHAN_MAPPED_STATUS_SIG_FAULT_HIGH_REALTIME NAIBRD_SD_CHAN_MAPPED_STATUS_SUMMARY_LATCHED and NAIBRD_SD_CHAN_MAPPED_STATUS_SUMMARY_REALTIME 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 naibrd_sd_chan_mapped_status_type_t definition.
p_outStatusBit: (Output) 0 for Normal, 1 for Failure or Alert.
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_SD_GetCosine()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetCosine ( int32_t cardIndex,
int32_t module,
int32_t channel,
float32_t * p_outCosine )

Retrieves the Cosine 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_outCosine: (Output) Cosine reading.
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_SD_GetFrequency()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFrequency ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * p_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]).
p_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_SD_GetLatch()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetLatch ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outLatch )

Retrieves the Latch Control register to Latch the Angle Data for the specified channel. The Latch Control register allows for simultaneously measured inputs. After latching the channel, the angle data is latched until is release released by reading the channel's Angle 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]).
p_outLatch: (Output) 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.

◆ naibrd_SD_GetRefVoltage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetRefVoltage ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * p_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]).
p_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_SD_GetSignalVoltage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetSignalVoltage ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * p_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]).
p_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_SD_GetSine()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetSine ( int32_t cardIndex,
int32_t module,
int32_t channel,
float32_t * p_outSine )

Retrieves the Sine 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_outSine: (Output) Sine reading.
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_SD_GetStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_sd_status_type_t type,
uint32_t * p_outStatus )

Retrieves the SD Status from the specified channel.

The following status types are only supported on FPGA rev > 9.13: NAIBRD_SD_CHAN_MAPPED_STATUS_REF_FAULT_HIGH_LATCHED NAIBRD_SD_CHAN_MAPPED_STATUS_REF_FAULT_HIGH_REALTIME NAIBRD_SD_CHAN_MAPPED_STATUS_SIG_FAULT_HIGH_LATCHED NAIBRD_SD_CHAN_MAPPED_STATUS_SIG_FAULT_HIGH_REALTIME NAIBRD_SD_CHAN_MAPPED_STATUS_SUMMARY_LATCHED and NAIBRD_SD_CHAN_MAPPED_STATUS_SUMMARY_REALTIME 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 naibrd_sd_chan_mapped_status_type_t definition.
p_outStatus: (Output) 0 for Normal, 1 for Failure or Alert.
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_SD_GetVelocity()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetVelocity ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * p_outVelocity )

Retrieves velocity reading from the specified channel. The Velocity Scale register is read and used to scale the returned value between +/- 190.7348 RPS.

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_outVelocity: (Output) Velocity reading in RPS.
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_SD_SetLatch()

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

Sets the Latch Control register to Latch the Angle Data for the specified channel. The Latch Control register allows for simultaneously measured inputs. After latching the channel, the angle data is latched until it is released by reading the channel's Angle 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_INVALID_VALUE when invalid latch parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.