Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_SetExpectedVoltage (int32_t cardIndex, int32_t module, int32_t channel, nai_ds_expected_voltage_type_t type, float64_t inExpVolt)
	Sets the expected reference and output line-line for a specified channel in a D/S module.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_GetExpectedVoltage (int32_t cardIndex, int32_t module, int32_t channel, nai_ds_expected_voltage_type_t type, float64_t *outExpVolt)
	Sets the expected reference and output line-line for a specified channel in a D/S module.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_SetThresholdVoltage (int32_t cardIndex, int32_t module, int32_t channel, nai_ds_threshold_voltage_type_t type, float64_t inThresVolt)
	Sets the expected reference and output line-line threshold voltatge for a specified channel in a D/S module.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_GetThresholdVoltage (int32_t cardIndex, int32_t module, int32_t channel, nai_ds_threshold_voltage_type_t type, float64_t *outThresVolt)
	Gets the expected reference and output line-line threshold voltatge for a specified channel in a D/S module.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_SetThresholdCurrent (int32_t cardIndex, int32_t module, int32_t channel, nai_ds_expected_current_type_t type, float64_t inThresCurrent)
	Sets the output line-line threshold current(RMS) for a specified channel in a D/S module.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_GetThresholdCurrent (int32_t cardIndex, int32_t module, int32_t channel, nai_ds_expected_current_type_t type, float64_t *outThresCurrent)
	Gets the output line-line threshold current(RMS) for a specified channel in a D/S module.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_SetRatioFixedMode (int32_t cardIndex, int32_t module, int32_t channel, nai_ds_output_ratio_fixed_mode_t inRatioFixMode)
	Sets the D/S channel ratio/fixed mode for a specified D/S channel for the D/S module.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_GetRatioFixedMode (int32_t cardIndex, int32_t module, int32_t channel, nai_ds_output_ratio_fixed_mode_t *outRatioFixMode)
	Gets the D/S Ratio/Fixed selection of a specified D/S channel for the D/S module.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_SetSynRslMode (int32_t cardIndex, int32_t module, int32_t channel, nai_ds_synchro_resolver_t inSynRslMode)
	Sets the Synchro or Resolver mode for a specified channel for the D/S module. Only mixed mode programming module support this function.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_GetSynRslMode (int32_t cardIndex, int32_t module, int32_t channel, nai_ds_synchro_resolver_t *outSynRslMode)
	Gets the Synchro or Resolver mode for a specified channel for the D/S module. Only mixed mode programming module support this function.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_SetActiveChannel (int32_t cardIndex, int32_t module, int32_t channel, bool_t inActiveChan)
	Sets the active channel state for a specified D/S channel for the D/S module.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_GetActiveChannel (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outActChanEnable)
	Gets the active channel state for a specified D/S channel for the D/S module.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_SetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, uint32_t inSetting)
	Sets the channel status enable/disable for the specified D/S channel for the D/S module. When it is set to disable, ref loss, sig loss, bit fault, and phase loss status will not be updated.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_GetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outSetting)
	Gets the channel status enable/disable for the specified D/S channel for the D/S module. When it is set to disable, ref loss, sig loss, bit fault, and phase loss status will not be updated.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_SetRotationCtrl (int32_t cardIndex, int32_t module, int32_t channel, nai_ds_rotation_configuration_type_t type, float64_t inRotationCtrl)
	Sets the Rotation control for a specified D/S channel of a D/S module. Refer to the Operation Manual for information on how to set each rotation control setting.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_GetRotationCtrl (int32_t cardIndex, int32_t module, int32_t channel, nai_ds_rotation_configuration_type_t type, float64_t *outRotCtrl)
	Gets the Rotation control for a specified D/S channel of a D/S module. Refer to the Operation Manual for information on the rotation control settings.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_SetMultiSpeedRatio (int32_t cardIndex, int32_t module, nai_ds_multi_speed_chan_pair_type_t chanPairType, uint32_t inMultSpd)
	Sets the D/S multi-speed ratio for a specified D/S channel in a D/S module.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_GetMultiSpeedRatio (int32_t cardIndex, int32_t module, nai_ds_multi_speed_chan_pair_type_t chanPairType, uint32_t *outMultSpd)
	Gets the D/S multi-speed ratio for a specified D/S channel in a D/S module.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_SetPhaseOffset (int32_t cardIndex, int32_t module, int32_t channel, float64_t inPhase)
	Sets the phase offset of a specified D/S channel in a D/S module.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_GetPhaseOffset (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outPhase)
	Gets the phase offset of a specified D/S channel in a D/S module.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_SetTorqueRxEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t inEnable)
	Sets the Torque receiver on/off state for a specified channel of a D/S module. Currently, this function is available only in single channel D/S module.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_GetTorqueRxEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outEnable)
	Gets the Torque receiver on/off state for a specified channel of a D/S module. Currently, this function is available only in single channel D/S module.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_SetWrapIntExt (int32_t cardIndex, int32_t module, uint32_t channel, nai_ds_wrap_int_ext_sel_t inWrapAngleIntExtSelect)
	Sets the measured angle internal/external selection for a specified channel of a D/S module. This function is supported by single channel D/S only.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_GetWrapIntExt (int32_t cardIndex, int32_t module, int32_t channel, nai_ds_wrap_int_ext_sel_t *outWrapIntExt)
	Gets the measured angle internal/external selection for a specified channel of a D/S module. This function is supported by single channel D/S only.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_SetMultiSpeedViaMultiBoard (int32_t multiBoardPairIdx, int32_t coarseCardIdx, int32_t coarseModuleNo, int32_t coarseChan, int32_t fineCardIdx, int32_t fineModuleNo, int32_t fineChan, nai_ds_multSpeedViaMultiBoad_config_type_t dsMSVMBConfigType, float64_t value)
	Set the multi-speed via multi-board propety for the selected D/S channel. This function assigns the coarse and the fine angles for multi-speed operation via the selected channel on two seperate boards.

Detailed Description

Function Documentation

◆ naibrd_DS_GetActiveChannel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetActiveChannel	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		bool_t *	outActChanEnable )

Gets the active channel state for a specified D/S channel for 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]).
outActChanEnable	: (Output) Returns the active channel state(Active=1, Not Active=0) from a specified channel of a 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_GetChanStatusEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetChanStatusEnable	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		uint32_t *	outSetting )

Gets the channel status enable/disable for the specified D/S channel for the D/S module. When it is set to disable, ref loss, sig loss, bit fault, and phase loss status will not be updated.

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	: Returns the channel status enable (enable=1, disable=0) of a specified channel of a 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_GetExpectedVoltage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetExpectedVoltage	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ds_expected_voltage_type_t	type,
		float64_t *	outExpVolt )

Sets the expected reference and output line-line for a specified channel in a 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 nai_ds_expected_voltage_type_t definitions.
outExpVolt	: (Output) Returns the expected voltage for a specified channel for a 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_GetMultiSpeedRatio()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetMultiSpeedRatio	(	int32_t	cardIndex,
		int32_t	module,
		nai_ds_multi_speed_chan_pair_type_t	chanPairType,
		uint32_t *	outMultSpd )

Gets the D/S multi-speed ratio for a specified D/S channel in a 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]).
chanPairType	: (Input) Refer to nai_ds_multi_speed_chan_pair_type_t for type definition.
outMultSpd	: (Output) Returns the multi-speed ratio from a 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_VALUE when invalid chanPairType parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_GetPhaseOffset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetPhaseOffset	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t *	outPhase )

Gets the phase offset of a specified D/S channel in a 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]).
outPhase	: (Output) Returns the phase offset value from a specified channel in a 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_GetRatioFixedMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetRatioFixedMode	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ds_output_ratio_fixed_mode_t *	outRatioFixMode )

Gets the D/S Ratio/Fixed selection of a specified D/S channel for 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]).
outRatioFixMode	: (Output) Returns the ratio(0)/fixed(1) mode setting.

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_GetRotationCtrl()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetRotationCtrl	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ds_rotation_configuration_type_t	type,
		float64_t *	outRotCtrl )

Gets the Rotation control for a specified D/S channel of a D/S module. Refer to the Operation Manual for information on the rotation control settings.

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) Rotation Type: Refer to nai_ds_rotation_configuration_type_t definitions.
outRotCtrl	: (Output) Reads the rotation properties of a specified channel from a 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_GetSynRslMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetSynRslMode	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ds_synchro_resolver_t *	outSynRslMode )

Gets the Synchro or Resolver mode for a specified channel for the D/S module. Only mixed mode programming module support this function.

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]).
outSynRslMode	: (Output) Returns Synchro(3)/Resolver(0) mode from a specified channel of a 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_RANGE when invalid outSynRslMode is read from the register.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_GetThresholdCurrent()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetThresholdCurrent	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ds_expected_current_type_t	type,
		float64_t *	outThresCurrent )

Gets the output line-line threshold current(RMS) for a specified channel in a 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 nai_ds_expected_current_type_t definitions.
outThresCurrent	: (Output) Returns the threshold current for a specified channel for a 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_GetThresholdVoltage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetThresholdVoltage	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ds_threshold_voltage_type_t	type,
		float64_t *	outThresVolt )

Gets the expected reference and output line-line threshold voltatge for a specified channel in a 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 nai_ds_expected_voltage_type_t definitions.
outThresVolt	: (Output) Returns the threshold voltage for a specified channel for a 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_GetTorqueRxEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetTorqueRxEnable	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		bool_t *	outEnable )

Gets the Torque receiver on/off state for a specified channel of a D/S module. Currently, this function is available only in single channel 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]).
outEnable	: (Output) bool_t: Returns torqueRx(Off = 0, On = 1) from a specified channel of a 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_GetWrapIntExt()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetWrapIntExt	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ds_wrap_int_ext_sel_t *	outWrapIntExt )

Gets the measured angle internal/external selection for a specified channel of a D/S module. This function is supported by single channel D/S 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]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
outWrapIntExt	: (Output) Returns measured angle (internal = 0, external = 1) selection for a specified channel of a 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_SetActiveChannel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetActiveChannel	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		bool_t	inActiveChan )

Sets the active channel state for a specified D/S channel for 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]).
inActiveChan	: (Input) Writes the active channel state(Active=1, Not Active=0) to a specified channel of a 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 inActiveChan parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_SetChanStatusEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetChanStatusEnable	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		uint32_t	inSetting )

Sets the channel status enable/disable for the specified D/S channel for the D/S module. When it is set to disable, ref loss, sig loss, bit fault, and phase loss status will not be updated.

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]).
inSetting	: (Input) Writes the channel status enable (enable=1, disable=0) to a specified channel of a 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 inSetting parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_SetExpectedVoltage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetExpectedVoltage	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ds_expected_voltage_type_t	type,
		float64_t	inExpVolt )

Sets the expected reference and output line-line for a specified channel in a 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 nai_ds_expected_voltage_type_t definitions.
inExpVolt	: (Input) Write the expected voltage for a specified channel for a 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_SetMultiSpeedRatio()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetMultiSpeedRatio	(	int32_t	cardIndex,
		int32_t	module,
		nai_ds_multi_speed_chan_pair_type_t	chanPairType,
		uint32_t	inMultSpd )

Sets the D/S multi-speed ratio for a specified D/S channel in a 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]).
chanPairType	: (Input) Refer to nai_ds_multi_speed_chan_pair_type_t for type definition.
inMultSpd	: (Input) Write the multi-speed ratio to a 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_VALUE when invalid chanPairType parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_SetMultiSpeedViaMultiBoard()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetMultiSpeedViaMultiBoard	(	int32_t	multiBoardPairIdx,
		int32_t	coarseCardIdx,
		int32_t	coarseModuleNo,
		int32_t	coarseChan,
		int32_t	fineCardIdx,
		int32_t	fineModuleNo,
		int32_t	fineChan,
		nai_ds_multSpeedViaMultiBoad_config_type_t	dsMSVMBConfigType,
		float64_t	value )

Set the multi-speed via multi-board propety for the selected D/S channel. This function assigns the coarse and the fine angles for multi-speed operation via the selected channel on two seperate boards.

Parameters

multiBoardPairIdx	: (Input) Array Index to the structure naiDsMSVMB where the MSVMB properties are are kept. (0 - MAX_MULTI_SPD_VIA_MULIT_BOARD_COUNT-1).
coarseCardIdx	: (Input) Card Index for the coarse function. (0 - NAI_MAX_CARDS-1).
coarseModuleNo	: (Input) Module number for the coarse function. (1 - [max modules for board]).
coarseChan	: (Input) Channel number for the coarse function. (1 - [max channels for board]).

Parameters

fineCardIdx	: (Input) Card Index for the fine function. (0 - NAI_MAX_CARDS-1).
fineModuleNo	: (Input) Module number for the fine function. (1 - [max modules for board]).
fineChan	: (Input) Channel number for the fine function. (1 - [max channels for board]).
dsMSVMBConfigType	: (Input) Multi-Spd Via Multi-Board Property tyep. See nai_ds_multSpeedViaMultiBoad_config_type_t for definition.
value	: (Input) Value for the selected Multi-Spd Via Multi-Board Property.

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_SetPhaseOffset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetPhaseOffset	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t	inPhase )

Sets the phase offset of a specified D/S channel in a 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]).
inPhase	: (Input) Writes the phase offset value to a specified channel in a 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_SetRatioFixedMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetRatioFixedMode	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ds_output_ratio_fixed_mode_t	inRatioFixMode )

Sets the D/S channel ratio/fixed mode for a specified D/S channel for 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]).
inRatioFixMode	: (Input) Write ratio(0)/fixed(1) mode to a specified channel of 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 inRatioFixMode parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_SetRotationCtrl()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetRotationCtrl	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ds_rotation_configuration_type_t	type,
		float64_t	inRotationCtrl )

Sets the Rotation control for a specified D/S channel of a D/S module. Refer to the Operation Manual for information on how to set each rotation control setting.

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) Rotation Type: Refer to nai_ds_rotation_configuration_type_t definitions.
inRotationCtrl	: (Input) Writes the rotation properties to a specified channel of a 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_SetSynRslMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetSynRslMode	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ds_synchro_resolver_t	inSynRslMode )

Sets the Synchro or Resolver mode for a specified channel for the D/S module. Only mixed mode programming module support this function.

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]).
inSynRslMode	: (Input) Writes Synchro(3)/Resolver(0) mode to a specified channel of a 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 inSynRslMode parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_SetThresholdCurrent()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetThresholdCurrent	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ds_expected_current_type_t	type,
		float64_t	inThresCurrent )

Sets the output line-line threshold current(RMS) for a specified channel in a 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 nai_ds_expected_current_type_t definitions.
inThresCurrent	: (Input) Write the threshold current for a specified channel for a 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_SetThresholdVoltage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetThresholdVoltage	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ds_threshold_voltage_type_t	type,
		float64_t	inThresVolt )

Sets the expected reference and output line-line threshold voltatge for a specified channel in a 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 nai_ds_expected_voltage_type_t definitions.
inThresVolt	: (Input) Write the threshold voltage voltage for a specified channel for a 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_SetTorqueRxEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetTorqueRxEnable	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		bool_t	inEnable )

Sets the Torque receiver on/off state for a specified channel of a D/S module. Currently, this function is available only in single channel 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]).
inEnable	: (Input) bool_t: Write torqueRx(Off = 0, On = 1) to a specified channel of a 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_SetWrapIntExt()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetWrapIntExt	(	int32_t	cardIndex,
		int32_t	module,
		uint32_t	channel,
		nai_ds_wrap_int_ext_sel_t	inWrapAngleIntExtSelect )

Sets the measured angle internal/external selection for a specified channel of a D/S module. This function is supported by single channel D/S 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]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
inWrapAngleIntExtSelect	: (Input) Write measured angle (internal = 0, external = 1) selection for a specified channel of a 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.

Functions

Detailed Description

Function Documentation

◆ naibrd_DS_GetActiveChannel()

◆ naibrd_DS_GetChanStatusEnable()

◆ naibrd_DS_GetExpectedVoltage()

◆ naibrd_DS_GetMultiSpeedRatio()

◆ naibrd_DS_GetPhaseOffset()

◆ naibrd_DS_GetRatioFixedMode()

◆ naibrd_DS_GetRotationCtrl()

◆ naibrd_DS_GetSynRslMode()

◆ naibrd_DS_GetThresholdCurrent()

◆ naibrd_DS_GetThresholdVoltage()

◆ naibrd_DS_GetTorqueRxEnable()

◆ naibrd_DS_GetWrapIntExt()

◆ naibrd_DS_SetActiveChannel()

◆ naibrd_DS_SetChanStatusEnable()

◆ naibrd_DS_SetExpectedVoltage()

◆ naibrd_DS_SetMultiSpeedRatio()

◆ naibrd_DS_SetMultiSpeedViaMultiBoard()

◆ naibrd_DS_SetPhaseOffset()

◆ naibrd_DS_SetRatioFixedMode()

◆ naibrd_DS_SetRotationCtrl()

◆ naibrd_DS_SetSynRslMode()

◆ naibrd_DS_SetThresholdCurrent()

◆ naibrd_DS_SetThresholdVoltage()

◆ naibrd_DS_SetTorqueRxEnable()

◆ naibrd_DS_SetWrapIntExt()