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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetAngle (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ds_angle_info_type_t type, float64_t inAngle)
 Sets various angle properties on a D/S module for a specified channel. Use naibrd_ds_angle_info_type_t to select the specified angle properties to be written to the D/S module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetAngle (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ds_angle_info_type_t type, float64_t *p_outAngle)
 Gets various angle properties on a D/S module from a specified channel. Use naibrd_ds_angle_info_type_t to select the specified angle properties to be read from the D/S module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetPowerEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t inPwrEnable)
 Sets a specified D/S channel output state on/off.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetPowerEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outPowerEnable)
 Gets a specified D/S channel output state.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetMeasuredValue (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ds_measured_Info_type_t type, float64_t *p_outMeasValue)
 Gets internally measured values from the D/S module for their specified channels. Internally measured value types include: angle, reference, output line-to-line voltage, reference frequency, signal current, and velocity.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetAllWrapAngles (int32_t cardIndex, int32_t module, int32_t arraySize, float64_t *p_outAngle)
 Gets all internally measured angles from the D/S module. Use this function for single speed operations only.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ds_chan_mapped_status_type_t type, naibrd_ds_module_status_t *p_outStatus)
 Gets the module status for a specific channel from the D/S module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_ClearChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ds_chan_mapped_status_type_t type)
 Clears latched status for a specific D/S channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetRotationStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ds_rotation_status_t *p_outStatus)
 Gets the latched rotation status for a specific channel from the D/S module. For Gen5 D/S modules, to unlatch a latched channel, write a one to the bit mask value for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetRealTimeRotationStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ds_rotation_status_t *p_outStatus)
 Gets the real time rotation status for a specific channel from the D/S module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetRotationEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t inRotEnable)
 Sets the start or stop rotation command for a specified channel in the D/S module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetRotationEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outRotEnable)
 Gets the start or stop rotation command for a specified channel in the D/S module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ds_status_type_t type, nai_ds_module_status_t *p_outStatus)
 Gets the module status for a specific channel from the D/S module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_ClearStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ds_status_type_t type)
 Clears latched status for a specific D/S channel.
 

Detailed Description

Function Documentation

◆ naibrd_DS_ClearChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_ClearChanMappedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ds_chan_mapped_status_type_t type )

Clears latched status for a specific D/S channel.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
type: (Input) Status Type: refer to naibrd_ds_chan_mapped_status_type_t definitions.
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_DS_ClearStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_ClearStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ds_status_type_t type )

Clears latched status for a specific D/S channel.

Parameters
cardIndex: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module: (Input) Module Number of the module to access (1 - [max modules for board]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
type: (Input) Status Type: refer to naibrd_ds_chan_mapped_status_type_t definitions.
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_DS_GetAllWrapAngles()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetAllWrapAngles ( int32_t cardIndex,
int32_t module,
int32_t arraySize,
float64_t * p_outAngle )

Gets all internally measured angles from the D/S module. Use this function for single speed operations only.

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]).
arraySize: (Input) The number of channels requested.
p_outAngle: (Output) Internally measured angles reported from the D/S 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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_SIZE when arraySize is greater than max channel allowed by the module.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_GetAngle()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetAngle ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ds_angle_info_type_t type,
float64_t * p_outAngle )

Gets various angle properties on a D/S module from a specified channel. Use naibrd_ds_angle_info_type_t to select the specified angle properties to be read from the D/S 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) Angle Type: refer to naibrd_ds_angle_info_type_t definitions.
p_outAngle: (Output) float64_t: Returns angle values in degree from a specified channel of D/S 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_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_DS_GetChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetChanMappedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ds_chan_mapped_status_type_t type,
naibrd_ds_module_status_t * p_outStatus )

Gets the module status for a specific channel from the D/S 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 naibrd_ds_chan_mapped_status_type_t definitions.
p_outStatus: (Output) naibrd_ds_module_status_t: Return module status (0=good, 1=bad).
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_DS_GetMeasuredValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetMeasuredValue ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ds_measured_Info_type_t type,
float64_t * p_outMeasValue )

Gets internally measured values from the D/S module for their specified channels. Internally measured value types include: angle, reference, output line-to-line voltage, reference frequency, signal current, and velocity.

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) Measured Info Type: refer to naibrd_ds_measured_Info_type_t definitions.
p_outMeasValue: (Output) Internally measured values for a specified channel from the D/S 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_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_DS_GetPowerEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetPowerEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * p_outPowerEnable )

Gets a specified D/S channel output state.

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_outPowerEnable: (Output) bool_t: 0(NAI_FALSE) = Module power off, 1(NAI_TRUE) = Module power on.
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_DS_GetRealTimeRotationStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetRealTimeRotationStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ds_rotation_status_t * p_outStatus )

Gets the real time rotation status for a specific channel from the D/S 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_outStatus: (Output) naibrd_ds_rotation_status_t: Return D/S channel rotation status (0=rotating, 1=not rotating).
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_DS_GetRotationEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetRotationEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * p_outRotEnable )

Gets the start or stop rotation command for a specified channel in the D/S 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_outRotEnable: (Output) bool_t: Returns the current rotation start/stop state of a specified channel from the D/S 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_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_DS_GetRotationStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetRotationStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ds_rotation_status_t * p_outStatus )

Gets the latched rotation status for a specific channel from the D/S module. For Gen5 D/S modules, to unlatch a latched channel, write a one to the bit mask value 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]).
p_outStatus: (Output) naibrd_ds_rotation_status_t: Return D/S channel rotation status (0=rotating, 1=not rotating).
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_DS_GetStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ds_status_type_t type,
nai_ds_module_status_t * p_outStatus )

Gets the module status for a specific channel from the D/S 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 naibrd_ds_chan_mapped_status_type_t definitions.
p_outStatus: (Output) naibrd_ds_module_status_t: Return module status (0=good, 1=bad).
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_DS_SetAngle()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetAngle ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ds_angle_info_type_t type,
float64_t inAngle )

Sets various angle properties on a D/S module for a specified channel. Use naibrd_ds_angle_info_type_t to select the specified angle properties to be written to the D/S 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) Angle Type: refer to naibrd_ds_angle_info_type_t definitions.
inAngle: (Input) float64_t: Value used to set various angle properties for a specified channel of D/S 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_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_INVALID_RANGE when inAngle parameter is out of range.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_SetPowerEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetPowerEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t inPwrEnable )

Sets a specified D/S channel output state on/off.

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]).
inPwrEnable: (Input) bool_t: Write 1(NAI_TRUE) or 0(NAI_FALSE) to the D/S module channel power 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 inPwrEnable parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_SetRotationEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetRotationEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t inRotEnable )

Sets the start or stop rotation command for a specified channel in the D/S 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]).
inRotEnable: (Input) bool_t: Write 1(Start) or 0(Stop) to the channel rotation 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 inRotEnable parameter specified is not 0 or 1.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.