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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_SetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Enables/disables status reporting for the specified VR channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outEnable)
 Retrieves the enabled/disabled state of status reporting for the specified VR channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_SetConfigValue (int32_t cardIndex, int32_t module, int32_t channel, nai_vr_config_value_type_t configValueType, float64_t configValue)
 Sets the configuration value of the specified VR module and channel, based on the nai_vr_config_value_type_t configuration value type specified. NOTE: For FPGA Revision 2.2 and greater, the maximum input is 100V. For FPGA Revisions less than 2.2, the maximum input is 65V.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetConfigValue (int32_t cardIndex, int32_t module, int32_t channel, nai_vr_config_value_type_t configValueType, float64_t *p_outConfigValue)
 Retrieves the configuration value from the specified VR module and channel, based on the nai_vr_config_value_type_t configuration value type specified. NOTE: For FPGA Revision 2.2 and greater, the maximum input is 100V. For FPGA Revisions less than 2.2, the maximum input is 65V.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_SetChanMappedControl (int32_t cardIndex, int32_t module, int32_t channel, nai_vr_chan_mapped_control_type_t controlType, bool_t enable)
 Sets the channel-mapped control bit of the specified VR module and channel, based on the nai_vr_chan_mapped_control_type_t channel-mapped control type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetChanMappedControl (int32_t cardIndex, int32_t module, int32_t channel, nai_vr_chan_mapped_control_type_t controlType, bool_t *p_outEnable)
 Retrieves the channel-mapped control bit from the specified VR module and channel, based on the nai_vr_chan_mapped_control_type_t channel-mapped control type specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_SetPowerSupplyEnable (int32_t cardIndex, int32_t module, bool_t enable)
 Sets the enabled/disabled state of the power supply for the specified VR module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetPowerSupplyEnable (int32_t cardIndex, int32_t module, bool_t *p_outEnable)
 Retrieves the enabled/disabled state of the power supply for the specified VR module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_SetRangeSelect (int32_t cardIndex, int32_t module, int32_t channel, nai_vr_range_select_type_t range)
 Sets the signal gain, which sets the effective measurement range, for the specified VR module and channel. For the list of valid range selections, refer to nai_vr_range_select_type_t definition.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetRangeSelect (int32_t cardIndex, int32_t module, int32_t channel, nai_vr_range_select_type_t *p_outRange)
 Retrieves the signal gain, which sets the effective measurement range, for the specified VR module and channel. For the list of valid range selections, refer to nai_vr_range_select_type_t definition.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_SetZeroTorqueSignalPhaseToPhaseReading (int32_t cardIndex, int32_t module, int32_t channel)
 Sets the zero torque signal phase to the current phase reading for the specified VR module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetZeroTorqueSignalPhaseToPhaseReading (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outEnable)
 Retrieves the state of the bit corresponding to the specified VR channel in the register that sets the zero torque signal phase to the current phase reading for the specified VR module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_ResetCycleCount (int32_t cardIndex, int32_t module, int32_t channel)
 Resets the cycle counter for the specified VR module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_SetAutoDownRangeTime (int32_t cardIndex, int32_t module, int32_t channel, nai_vr_auto_down_range_time_type_t autoDownRangeTime)
 Sets the auto down-range time for the specified VR module and channel. For the list of valid auto down-range time selections, refer to nai_vr_auto_down_range_time_type_t definition.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetAutoDownRangeTime (int32_t cardIndex, int32_t module, int32_t channel, nai_vr_auto_down_range_time_type_t *p_outAutoDownRangeTime)
 Retrieves the auto down-range time for the specified VR module and channel. For the list of valid auto down-range time selections, refer to nai_vr_auto_down_range_time_type_t definition.
 

Detailed Description


Function Documentation

◆ naibrd_VR_GetAutoDownRangeTime()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetAutoDownRangeTime ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_vr_auto_down_range_time_type_t * p_outAutoDownRangeTime )

Retrieves the auto down-range time for the specified VR module and channel. For the list of valid auto down-range time selections, refer to nai_vr_auto_down_range_time_type_t definition.

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_outAutoDownRangeTime: (Output) Auto Down-Range Time Type: refer to nai_vr_auto_down_range_time_type_t definition.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_VR_GetChanMappedControl()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetChanMappedControl ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_vr_chan_mapped_control_type_t controlType,
bool_t * p_outEnable )

Retrieves the channel-mapped control bit from the specified VR module and channel, based on the nai_vr_chan_mapped_control_type_t channel-mapped control type specified.

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]).
controlType: (Input) Channel-mapped control type: refer to nai_vr_chan_mapped_control_type_t definition.
p_outEnable: (Output) Channel-mapped control bit state read from module (0 or 1).
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 controlType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_VR_GetChanStatusEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetChanStatusEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * p_outEnable )

Retrieves the enabled/disabled state of status reporting for the specified VR 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_outEnable: (Output) 0 if channel status reporting is disabled or 1 if channel status reporting is enabled.
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_VR_GetConfigValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetConfigValue ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_vr_config_value_type_t configValueType,
float64_t * p_outConfigValue )

Retrieves the configuration value from the specified VR module and channel, based on the nai_vr_config_value_type_t configuration value type specified. NOTE: For FPGA Revision 2.2 and greater, the maximum input is 100V. For FPGA Revisions less than 2.2, the maximum input is 65V.

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]).
configValueType: (Input) Configuration value type: refer to nai_vr_config_value_type_t definition.
p_outConfigValue: (Output) Configuration 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_INVALID_VALUE when invalid configValueType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_VR_GetPowerSupplyEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetPowerSupplyEnable ( int32_t cardIndex,
int32_t module,
bool_t * p_outEnable )

Retrieves the enabled/disabled state of the power supply for the specified VR 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]).
p_outEnable: (Output) 1 if power supply for module is enabled, 0 if power supply for module is disabled.
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_SUPPORTED when function is not supported.

◆ naibrd_VR_GetRangeSelect()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetRangeSelect ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_vr_range_select_type_t * p_outRange )

Retrieves the signal gain, which sets the effective measurement range, for the specified VR module and channel. For the list of valid range selections, refer to nai_vr_range_select_type_t definition.

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_outRange: (Output) Range Select Type read from module: refer to nai_vr_range_select_type_t definition.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_VR_GetZeroTorqueSignalPhaseToPhaseReading()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetZeroTorqueSignalPhaseToPhaseReading ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * p_outEnable )

Retrieves the state of the bit corresponding to the specified VR channel in the register that sets the zero torque signal phase to the current phase reading for the specified VR 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]).
p_outEnable: (Output) 1 if setting zero torque signal phase to phase reading is in progress, 0 if done.
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_VR_ResetCycleCount()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_ResetCycleCount ( int32_t cardIndex,
int32_t module,
int32_t channel )

Resets the cycle counter for the specified VR 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]).
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_VR_SetAutoDownRangeTime()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_SetAutoDownRangeTime ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_vr_auto_down_range_time_type_t autoDownRangeTime )

Sets the auto down-range time for the specified VR module and channel. For the list of valid auto down-range time selections, refer to nai_vr_auto_down_range_time_type_t definition.

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]).
autoDownRangeTime: (Input) Auto Down-Range Time Type: refer to nai_vr_auto_down_range_time_type_t definition.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid autoDownRangeTime parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_VR_SetChanMappedControl()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_SetChanMappedControl ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_vr_chan_mapped_control_type_t controlType,
bool_t enable )

Sets the channel-mapped control bit of the specified VR module and channel, based on the nai_vr_chan_mapped_control_type_t channel-mapped control type specified.

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]).
controlType: (Input) Channel-mapped control type: refer to nai_vr_chan_mapped_control_type_t definition.
enable: (Input) State to set channel-mapped control bit to (0 or 1).
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 controlType or enable parameters are specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_VR_SetChanStatusEnable()

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

Enables/disables status reporting for the specified VR 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) 0 to disable or 1 to enable status reporting for a 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 enable parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_VR_SetConfigValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_SetConfigValue ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_vr_config_value_type_t configValueType,
float64_t configValue )

Sets the configuration value of the specified VR module and channel, based on the nai_vr_config_value_type_t configuration value type specified. NOTE: For FPGA Revision 2.2 and greater, the maximum input is 100V. For FPGA Revisions less than 2.2, the maximum input is 65V.

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]).
configValueType: (Input) Configuration value type: refer to nai_vr_config_value_type_t definition.
configValue: (Input) Configuration 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 configValueType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_VR_SetPowerSupplyEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_SetPowerSupplyEnable ( int32_t cardIndex,
int32_t module,
bool_t enable )

Sets the enabled/disabled state of the power supply for the specified VR 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]).
enable: (Input) 1 to enable power supply for module, 0 to disable power supply for 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_VALUE when invalid enable parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_VR_SetRangeSelect()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_SetRangeSelect ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_vr_range_select_type_t range )

Sets the signal gain, which sets the effective measurement range, for the specified VR module and channel. For the list of valid range selections, refer to nai_vr_range_select_type_t definition.

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]).
range: (Input) Range Select Type: refer to nai_vr_range_select_type_t definition.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid range parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_VR_SetZeroTorqueSignalPhaseToPhaseReading()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_SetZeroTorqueSignalPhaseToPhaseReading ( int32_t cardIndex,
int32_t module,
int32_t channel )

Sets the zero torque signal phase to the current phase reading for the specified VR 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]).
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.