Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Configuration Functions
S/D Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetChanMode (int32_t cardIndex, int32_t module, int32_t channel, nai_sd_format_t mode)
 Sets the SD Configuration Mode for the specified channel.

 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetChanMode (int32_t cardIndex, int32_t module, int32_t channel, nai_sd_format_t *outmode)
 Retrieves the SD Configuration Mode from the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, uint32_t setting)
 Sets the channel status enable bit for the specified channel. When the channel status enable is set to "NAI_SD_CHAN_STATUS_ENABLE_ACTIVE", it will report any bad status in the following module functions: 1. BIT Status,.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outsetting)
 Gets the channel status enable bit for the specified channel. When the channel status enable is set to "NAI_SD_CHAN_STATUS_ENABLE_ACTIVE", it will report any bad status in the following module functions: 1. BIT Status,.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetVelScale (int32_t cardIndex, int32_t module, int32_t channel, uint32_t velscale)
 Sets the Velocity Scale Factor for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetVelScale (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outvelscale)
 Retrieves the Velocity Scale Factor from the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetRatio (int32_t cardIndex, int32_t module, int32_t channel, uint32_t ratio)
 Sets the ratio for the specified channel to be used for a two-speed or multi-speed configuration. When a 'ratio' is programmed, the odd channels provide the 'coarse' angle measurement. The even channels provide the 'combined' angle reading for both the coarse and fine angle measurements (which is a more accurate representation of the coarse channel). Ratio = 1 for single speed (independent channel) operation. 2 <= Ratio <= 255 for even channels for two-speed or multi-speed configuration.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetRatio (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outratio)
 Retrieves the ratio from the specified channel to be used for a two-speed or multi-speed configuration. When a 'ratio' is programmed, the odd channels provide the 'coarse' angle measurement. The even channels provide the 'combined' angle reading for both the coarse and fine angle measurements (which is a more accurate representation of the coarse channel). Ratio = 1 for single speed (independent channel) operation. 2 <= Ratio <= 255 for even channels for two-speed or multi-speed configuration.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_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_SD_GetSigLossThreshold (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outthreshold)
 Retrieves the minimum signal voltage level in volts before indicating a signal loss from the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_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_SD_GetRefLossThreshold (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outthreshold)
 Retrieves the minimum reference voltage level in volts before indicating a reference loss from the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetOpenThreshold (int32_t cardIndex, int32_t module, int32_t channel, float64_t threshold)
 Sets the open circuit threshold of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetOpenThreshold (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outthreshold)
 Retrieves the open threshold of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetShortThreshold (int32_t cardIndex, int32_t module, int32_t channel, float64_t threshold)
 Sets the short threshold of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetShortThreshold (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outthreshold)
 Retrieves the short threshold of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_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_SD_GetBandwidth (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outbandwidth)
 Retrieves the Bandwidth from the specified channel in 2 Hz resolution from 6Hz to 1280Hz.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetBandwidthSelect (int32_t cardIndex, int32_t module, int32_t channel, nai_sd_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_SD_GetBandwidthSelect (int32_t cardIndex, int32_t module, int32_t channel, nai_sd_bandwidth_select_t *outbwselect)
 Retrieves the Bandwidth Select from the specified channel. The BW Select can be set to "Automatic" or "Manual". When in "Automatic BW" mode, the input reference frequency is read and the bandwidth is automatically adjusted to approximately 1/10 of the carrier frequency. The Auto Bandwidth range has a minimum value of 10 Hz and a maximum value of 100 Hz. When in "Manual BW" mode, the user can enter the bandwidth between the range of 6 Hz and 1280 Hz, in 2 Hz increments.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetEncoderResolution (int32_t cardIndex, int32_t module, int32_t channel, nai_sd_enc_or_comm_setting_t resolution)
 Sets the Encoder Output Resolution or Commutation for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetEncoderResolution (int32_t cardIndex, int32_t module, int32_t channel, nai_sd_enc_or_comm_setting_t *outresolution)
 Retrieves the Encoder Output Resolution or Commutation from the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFloatingPointAngleOffset (int32_t cardIndex, int32_t module, int32_t channel, float64_t angleOffset)
 Sets the HW floating point angle offset for the specified S/D 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_SD_GetFloatingPointAngleOffset (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outAngleOffset)
 Retrieves the HW floating point angle offset for the specified S/D 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_SD_SetFloatingPointAngleScale (int32_t cardIndex, int32_t module, int32_t channel, float64_t angleScale)
 Sets the HW floating point angle scale factor for the specified S/D 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_SD_GetFloatingPointAngleScale (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outAngleScale)
 Retrieves the HW floating point angle scale factor for the specified S/D 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_SD_SetFloatingPointVelocityOffset (int32_t cardIndex, int32_t module, int32_t channel, float64_t velocityOffset)
 Sets the HW floating point velocity offset for the specified S/D 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_SD_GetFloatingPointVelocityOffset (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outVelocityOffset)
 Retrieves the HW floating point velocity offset for the specified S/D 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_SD_SetFloatingPointVelocityScale (int32_t cardIndex, int32_t module, int32_t channel, float64_t velocityScale)
 Sets the HW floating point velocity scale factor for the specified S/D 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_SD_GetFloatingPointVelocityScale (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outVelocityScale)
 Retrieves the HW floating point velocity scale factor for the specified S/D 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_SD_SetThreshold (int32_t cardIndex, int32_t module, int32_t channel, naibrd_sd_threshold_t type, float64_t threshold)
 Sets the threshold (depending on the naibrd_sd_threshold_t type specified) for the specified SD channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetThreshold (int32_t cardIndex, int32_t module, int32_t channel, naibrd_sd_threshold_t type, float64_t *p_outthreshold)
 Retrieves threshold (depending on the naibrd_sd_threshold_t type specified) for the specified SD channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetInverse (int32_t cardIndex, int32_t module, int32_t channel, uint32_t value)
 Sets the inverse for the sin, cos, or reference controls. This is only supported on FPGA rev > 9.13.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetInverse (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outvalue)
 Retrieves the inverse for the sin, cos, or reference controls. This is only supported on FPGA rev > 9.13.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_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_SD_SetChanStatusEnable.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetActiveChannel (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outsetting)
 Note: This routine has been deprecated and has been replaced with naibrd_SD_GetChanStatusEnable.
 

Detailed Description


Function Documentation

◆ naibrd_SD_GetActiveChannel()

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

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

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

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outsetting: (Input) Active Channel Setting (0 for inactive, 1 for active).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetBandwidth()

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

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

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outbandwidth: (Input) 2 < Bandwidth <1280 Hz with 2 Hz resolution.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetBandwidthSelect()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetBandwidthSelect ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_sd_bandwidth_select_t * outbwselect )

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

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outbwselect: (Output) NAI_SD_BW_MANUAL or NAI_SD_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_SD_GetChanMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetChanMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_sd_format_t * outmode )

Retrieves the SD Configuration Mode from the specified channel.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outmode: (Output) NAI_SD_RESOLVER or NAI_SD_SYNCHRO
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_GetChanStatusEnable()

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

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

  1. Ref Loss Status, 3. Sig Loss Status, 4. Interlock Status, and 5. Delta angle Status. When the channel status enable bit is set to NAI_SD_CHAN_STATUS_ENABLE_INACTIVE, no bad status will be reported. The channel status enable is bit-mapped to the register. If the register has a value of 0xC, channel 1 and 2 will not report any bad status.
Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outsetting: (Output) Chan Status Enable (0 for inactive, 1 for active).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid setting parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetEncoderResolution()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetEncoderResolution ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_sd_enc_or_comm_setting_t * outresolution )

Retrieves the Encoder Output Resolution or Commutation 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]).
outresolution: (Output) Encoder Resolution Type: refer to nai_sd_enc_or_comm_setting_t definition.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_ENCODER_RES when the returned resolution value is invalid or the device is not set to encoder mode.
  • NAI_ERROR_INVALID_VALUE when the device is not set to encoder mode.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetFloatingPointAngleOffset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFloatingPointAngleOffset ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * outAngleOffset )

Retrieves the HW floating point angle offset for the specified S/D 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]).
outAngleOffset: (Output) Floating-point angle 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_SD_GetFloatingPointAngleScale()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFloatingPointAngleScale ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * outAngleScale )

Retrieves the HW floating point angle scale factor for the specified S/D 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]).
outAngleScale: (Output) Floating-point angle 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_SD_GetFloatingPointVelocityOffset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFloatingPointVelocityOffset ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * outVelocityOffset )

Retrieves the HW floating point velocity offset for the specified S/D 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]).
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_SD_GetFloatingPointVelocityScale()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetFloatingPointVelocityScale ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * outVelocityScale )

Retrieves the HW floating point velocity scale factor for the specified S/D 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]).
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_SD_GetInverse()

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

Retrieves the inverse for the sin, cos, or reference controls. This is only supported on FPGA rev > 9.13.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outvalue: (Output) D0: Inverts SIN, D1: Inverts COS, D2: Inverts the Reference.
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_GetOpenThreshold()

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

Retrieves the open threshold of the specified channel.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outthreshold: (Output) Open threshold setting retrieved.
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_GetRatio()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetRatio ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * outratio )

Retrieves the ratio from the specified channel to be used for a two-speed or multi-speed configuration. When a 'ratio' is programmed, the odd channels provide the 'coarse' angle measurement. The even channels provide the 'combined' angle reading for both the coarse and fine angle measurements (which is a more accurate representation of the coarse channel). Ratio = 1 for single speed (independent channel) operation. 2 <= Ratio <= 255 for even channels for two-speed or multi-speed configuration.

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]).
outratio: (Output) 1 <= Ratio <= 255.
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_GetRefLossThreshold()

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

Retrieves the minimum reference voltage level in volts before indicating a reference loss from the specified channel.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outthreshold: (Output) 0.0 <= threshold <= 115.000 Volts.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetShortThreshold()

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

Retrieves the short threshold of the specified channel.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outthreshold: (Output) Short threshold setting retrieved.
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_GetSigLossThreshold()

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

Retrieves the minimum signal voltage level in volts before indicating a signal loss from the specified channel.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outthreshold: (Output) 0.0 <= threshold <= 90.000 Volts.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_sd_threshold_t type,
float64_t * p_outthreshold )

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

The following threshold types are only supported on FPGA rev > 9.13: NAIBRD_SD_SIG_FAULT_HI_THRESHOLD, NAIBRD_SD_REF_FAULT_HI_THRESHOLD,

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
type: (Input) Threshold type to read (see naibrd_sd_threshold_t definition).
p_outthreshold: (Output) Threshold value read from register.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_GetVelScale()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_GetVelScale ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * outvelscale )

Retrieves the Velocity Scale Factor from the specified channel. 

Vel Scale = 4095 * 190.7348 (RPS) / Full Scale Vel Rate (RPS) 

If Vel Scale =  4095 (0x0FFF) then Velocity Word = 32767(0x7FFF) at 190.7348 RPS Clockwise
If Vel Scale = 12288 (0x3000) then Velocity Word = 32767(0x7FFF) at  63.5783 RPS Clockwise
If Vel Scale = 65535 (0xFFFF) then Velocity Word = 32767(0x7FFF) at  11.9209 RPS Clockwise
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]).
outvelscale: (Output) Velocity scale
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_SetActiveChannel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_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_SD_SetChanStatusEnable.

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

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
setting: (Input) Active Channel Setting (0 for inactive, 1 for active).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid setting parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetBandwidth()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_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_SD_SetBandwidthSelect()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetBandwidthSelect ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_sd_bandwidth_select_t bwselect )

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

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
bwselect: (Input) NAI_SD_BW_MANUAL or NAI_SD_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_SD_SetChanMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetChanMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_sd_format_t mode )

Sets the SD Configuration Mode for the specified channel.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
mode: (Input) NAI_SD_RESOLVER or NAI_SD_SYNCHRO.
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_SD_SetChanStatusEnable()

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

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

  1. Ref Loss Status, 3. Sig Loss Status, 4. Interlock Status, and 5. Delta angle Status. When the channel status enable bit is set to NAI_SD_CHAN_STATUS_ENABLE_INACTIVE, no bad status will be reported. The channel status enable is bit-mapped to the register. If the register has a value of 0xC, channel 1 and 2 will not report any bad status.
Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
setting: (Input) Chan Status Enable (0 for inactive, 1 for active).
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid setting parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetEncoderResolution()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetEncoderResolution ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_sd_enc_or_comm_setting_t resolution )

Sets the Encoder Output Resolution or Commutation 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]).
resolution: (Input) Encoder Resolution Type: refer to nai_sd_enc_or_comm_setting_t definition.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_ENCODER_RES when invalid encoder resultion is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetFloatingPointAngleOffset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFloatingPointAngleOffset ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t angleOffset )

Sets the HW floating point angle offset for the specified S/D 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]).
angleOffset: (Input) Floating-point angle 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_SD_SetFloatingPointAngleScale()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFloatingPointAngleScale ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t angleScale )

Sets the HW floating point angle scale factor for the specified S/D 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]).
angleScale: (Input) Floating-point angle 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_SD_SetFloatingPointVelocityOffset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFloatingPointVelocityOffset ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t velocityOffset )

Sets the HW floating point velocity offset for the specified S/D 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]).
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_SD_SetFloatingPointVelocityScale()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetFloatingPointVelocityScale ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t velocityScale )

Sets the HW floating point velocity scale factor for the specified S/D 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]).
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_SD_SetInverse()

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

Sets the inverse for the sin, cos, or reference controls. This is only supported on FPGA rev > 9.13.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
value: (Output) D0: Inverts Sin, D1: Inverts Cos, D2: Inverts the Reference.
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_SetOpenThreshold()

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

Sets the open circuit threshold of 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) Open threshold 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_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetRatio()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetRatio ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t ratio )

Sets the ratio for the specified channel to be used for a two-speed or multi-speed configuration. When a 'ratio' is programmed, the odd channels provide the 'coarse' angle measurement. The even channels provide the 'combined' angle reading for both the coarse and fine angle measurements (which is a more accurate representation of the coarse channel). Ratio = 1 for single speed (independent channel) operation. 2 <= Ratio <= 255 for even channels for two-speed or multi-speed configuration.

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]).
ratio: (Input) 1 <= Ratio <= 255.
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_RATIO when invalid ratio parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetRefLossThreshold()

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

Sets the minimum reference voltage level in volts before indicating a reference loss for the specified channel.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
threshold: (Input) 0.0 <= threshold <= 115.000 Volts.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid threshold parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetShortThreshold()

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

Sets the short threshold of 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) Short threshold 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_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetSigLossThreshold()

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

Sets the minimum signal voltage level in volts before indicating a signal loss for the specified channel.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
threshold: (Input) 0.0 <= threshold <= 90.000 Volts.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid threshold parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_sd_threshold_t type,
float64_t threshold )

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

The following threshold types are only supported on FPGA rev > 9.13: NAIBRD_SD_SIG_FAULT_HI_THRESHOLD, NAIBRD_SD_REF_FAULT_HI_THRESHOLD

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
type: (Input) Threshold type to set (see naibrd_sd_threshold_t definition).
threshold: (Input) Threshold value to set.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_SD_SetVelScale()

NAIBRDFUNC nai_status_t NAIAPI naibrd_SD_SetVelScale ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t velscale )

Sets the Velocity Scale Factor for the specified channel. 

Vel Scale = 4095 * 190.7348 (RPS) / Full Scale Vel Rate (RPS) 

If Vel Scale =  4095 (0x0FFF) then Velocity Word = 32767(0x7FFF) at 190.7348 RPS Clockwise
If Vel Scale = 12288 (0x3000) then Velocity Word = 32767(0x7FFF) at  63.5783 RPS Clockwise
If Vel Scale = 65535 (0xFFFF) then Velocity Word = 32767(0x7FFF) at  11.9209 RPS Clockwise
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]).
velscale: (Input) 4095 <= Vel Scale <= 65535.
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.