Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DA_SetUseMemory (int32_t cardIndex, int32_t module, int32_t channel, bool_t usememory)
	Sets the use memory setting for the DA module and channel specified. The use memory register is bitmapped per channel, with the LSB corresponding to channel 1, and the MSB corresponding to the max channel. Writing a �1� to Use Memory will allow the DAC output to come from the memory. Writing a �0� to Use Memory will not utilize the memory space and the DAC output will reflect the value written in DAC Value.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DA_GetUseMemory (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outusememory)
	Retrieves the use memory setting for the DA module and channel specified. The use memory register is bitmapped per channel, with the LSB corresponding to channel 1, and the MSB corresponding to the max channel. Writing a �1� to Use Memory will allow the DAC output to come from the memory. Writing a �0� to Use Memory will not utilize the memory space and the DAC output will reflect the value written in DAC Value.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DA_SetRAMFIFOMode (int32_t cardIndex, int32_t module, int32_t channel, bool_t ramfifomode)
	Sets the RAM/FIFO Mode setting for the DA module and channel specified. The RAM/FIFO Mode register is bitmapped per channel, with the LSB corresponding to channel 1, and the MSB corresponding to the max channel. If a �1� is written in the RAM/FIFO Mode register, the memory will be used as a FIFO; otherwise it is used as RAM.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DA_GetRAMFIFOMode (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outramfifomode)
	Retrieves the RAM/FIFO Mode setting for the DA module and channel specified. The RAM/FIFO Mode register is bitmapped per channel, with the LSB corresponding to channel 1, and the MSB corresponding to the max channel. If a �1� is written in the RAM/FIFO Mode register, the memory will be used as a FIFO; otherwise it is used as RAM.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DA_SetUseFifo (int32_t cardIndex, int32_t module, int32_t channel, bool_t usefifo)
	Sets the channels bit in the using fifo register to 1(true) or 0(false). This function is only for DA2. When set to true the fifo for that channel is active. When set to false it is not.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DA_GetUseFifo (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outusefifo)
	Gets the channels bit in the using fifo register to 1(true) or 0(false). This function is only for DA2. When set to true the fifo for that channel is active. When set to false it is not.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DA_SetFifoLoopMode (int32_t cardIndex, int32_t module, int32_t channel, uint32_t loopmode)
	Sets the channel's bit in the fifo loop mode register to 1(true) or 0(false). This function is only for DA2. When set to true, the fifo for that channel is in loop mode. When set to false it is not.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DA_GetFifoLoopMode (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *outloopmode)
	Retrieves the channel's bit in the fifo loop mode register (1 = true, 0 = false). This function is only for DA2. When set to true, the fifo for that channel is in loop mode. When set to false it is not.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DA_GetExtPowerMeasurement (int32_t cardIndex, int32_t module, int32_t channel, nai_da_extpwr_measure_t measType, float64_t *outmeasurement)
	Retrieves the external power supply's measurement for the type and channel specified.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DA_SetCurrentLimit (int32_t cardIndex, int32_t module, int32_t channel, float64_t currentLimit)
	Set the channel's current limit (mAmps) for the overcurrent status. An overcurrent status will be set when the channel's current exceeds this limit.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DA_GetCurrentLimit (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outcurrentLimit)
	Retrieves the channel's current limit (mAmps) for the overcurrent status. An overcurrent status will be set when the channel's current exceeds this limit.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DA_SetFullBridgeMode (int32_t cardIndex, int32_t module, int32_t channel, bool_t fullBridgeMode)
	Sets Full-Bridge mode on the DA5. Half-Bridge is set by default where each channel works independently. Full-Bridge pairs two channels together and the output is the differential between them. Full-Bridge pairs an odd and even channel together, using the odd channels controls to control the output. For example, setting Full-Bridge mode on channel 1 bridges channel 1 and channel 2 together where the output is the differential between channels 1 and 2 and controlled by channel 1.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DA_GetFullBridgeMode (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outfullBridgeMode)
	Retrieves the Full-Bridge mode for the channel. Half-Bridge is set by default where each channel works independently. Full-Bridge pairs two channels together and the output is the differential between them. Full-Bridge pairs an odd and even channel together, using the odd channels controls to control the output. For example, setting Full-Bridge mode on channel 1 bridges channel 1 and channel 2 together where the output is the differential between channels 1 and 2 and controlled by channel 1.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DA_SetControlLoop (int32_t cardIndex, int32_t module, int32_t channel, nai_control_loop_t controlLoopCfg, float64_t controlLoopValue)
	Sets the value for the control loop parameter and channel specified.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DA_GetControlLoop (int32_t cardIndex, int32_t module, int32_t channel, nai_control_loop_t controlLoopCfg, float64_t *outcontrolLoopValue)
	Retrieves the value for the control loop parameter and channel specified.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DA_GetDriveTemperature (int32_t cardIndex, int32_t module, int32_t channel, float64_t *outtempC)
	Retrieves the drive circuits temperature (in Celsius) for the channel specified.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DA_SetExtPowerThreshold (int32_t cardIndex, int32_t module, int32_t channel, nai_da_extpwr_threshold_t thresType, float64_t threshold)
	Sets the external power threshold of the type and channel specified. When the module detects a level outside the threshold defined, the External Power status (UnderVoltage or OVerVoltage) will be set.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DA_GetExtPowerThreshold (int32_t cardIndex, int32_t module, int32_t channel, nai_da_extpwr_threshold_t thresType, float64_t *outthreshold)
	Retrieves the external power threshold of the type and channel specified. When the module detects a level outside the threshold defined, the External Power status (UnderVoltage or OVerVoltage) will be set.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DA_SetWriteThroughMode (int32_t cardIndex, int32_t module, bool_t writeThroughEnable)
	Sets the state of the write-through mode to enabled or disabled.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DA_GetWriteThroughMode (int32_t cardIndex, int32_t module, bool_t *outwriteThroughEnable)
	Retrieves the state of the write-through mode.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_DA_UpdateStrobe (int32_t cardIndex, int32_t module)
	Strobes (updates) all outputs to the value stored in the data registers. The outputs will update once per call.

Detailed Description

Function Documentation

◆ naibrd_DA_GetControlLoop()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetControlLoop	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_control_loop_t	controlLoopCfg,
		float64_t *	outcontrolLoopValue )

Retrieves the value for the control loop parameter and channel 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]).
controlLoopCfg	: (Input) either NAI_DA_CTRL_LOOP_KP or NAI_DA_CTRL_LOOP_KI.
outcontrolLoopValue	: (Input) TRUE = FullBridge, FALSE = HalfBridge (normal mode).

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 mode parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_GetCurrentLimit()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetCurrentLimit	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t *	outcurrentLimit )

Retrieves the channel's current limit (mAmps) for the overcurrent status. An overcurrent status will be set when the channel's current exceeds this limit.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connect 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]).
outcurrentLimit	: (Output) Current limit in mAmps.

Returns

NAI_SUCCESS when the function is completed successfully.
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_DA_GetDriveTemperature()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetDriveTemperature	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t *	outtempC )

Retrieves the drive circuits temperature (in Celsius) for the channel 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]).
outtempC	: (Output) Circuits drive temp in Celsius.

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 mode parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_GetExtPowerMeasurement()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetExtPowerMeasurement	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_da_extpwr_measure_t	measType,
		float64_t *	outmeasurement )

Retrieves the external power supply's measurement for the type and channel specified.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connect 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]).
measType	: (Input) measurement type to access (1 - [max channels for module]).
outmeasurement	: (Output) External Power measurement.

Returns

NAI_SUCCESS when the function is completed successfully.
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_DA_GetExtPowerThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetExtPowerThreshold	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_da_extpwr_threshold_t	thresType,
		float64_t *	outthreshold )

Retrieves the external power threshold of the type and channel specified. When the module detects a level outside the threshold defined, the External Power status (UnderVoltage or OVerVoltage) will be set.

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]).
thresType	: (Input) threshold type to access.
outthreshold	: (Output) minimum external power threshold.

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 mode parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_GetFifoLoopMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetFifoLoopMode	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		uint32_t *	outloopmode )

Retrieves the channel's bit in the fifo loop mode register (1 = true, 0 = false). This function is only for DA2. When set to true, the fifo for that channel is in loop mode. When set to false it is not.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connect 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]).
outloopmode	: (Output) FIFO Loop Mode.

Returns

NAI_SUCCESS when the function is completed successfully.
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_DA_GetFullBridgeMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetFullBridgeMode	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		bool_t *	outfullBridgeMode )

Retrieves the Full-Bridge mode for the channel. Half-Bridge is set by default where each channel works independently. Full-Bridge pairs two channels together and the output is the differential between them. Full-Bridge pairs an odd and even channel together, using the odd channels controls to control the output. For example, setting Full-Bridge mode on channel 1 bridges channel 1 and channel 2 together where the output is the differential between channels 1 and 2 and controlled by channel 1.

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]).
outfullBridgeMode	: (Output) TRUE = FullBridge, FALSE = HalfBridge (normal mode).

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 mode parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_GetRAMFIFOMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetRAMFIFOMode	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		bool_t *	outramfifomode )

Retrieves the RAM/FIFO Mode setting for the DA module and channel specified. The RAM/FIFO Mode register is bitmapped per channel, with the LSB corresponding to channel 1, and the MSB corresponding to the max channel. If a �1� is written in the RAM/FIFO Mode register, the memory will be used as a FIFO; otherwise it is used as RAM.

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]).
outramfifomode	: (Output) RAM/FIFO Mode setting read from register. 1 for FIFO Mode, 0 for RAM mode.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetUseFifo	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		bool_t *	outusefifo )

Gets the channels bit in the using fifo register to 1(true) or 0(false). This function is only for DA2. When set to true the fifo for that channel is active. When set to false it is not.

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]).
outusefifo	: (Output) Value read from using fifo register. 1(true) , 0(false)

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetUseMemory	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		bool_t *	outusememory )

Retrieves the use memory setting for the DA module and channel specified. The use memory register is bitmapped per channel, with the LSB corresponding to channel 1, and the MSB corresponding to the max channel. Writing a �1� to Use Memory will allow the DAC output to come from the memory. Writing a �0� to Use Memory will not utilize the memory space and the DAC output will reflect the value written in DAC Value.

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]).
outusememory	: (Output) Use memory setting read from register. 1 = using memory space, 0 = using register values

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_GetWriteThroughMode	(	int32_t	cardIndex,
		int32_t	module,
		bool_t *	outwriteThroughEnable )

Retrieves the state of the write-through mode.

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]).
outwriteThroughEnable	: (Output) TRUE = enabled, FALSE = 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_OPEN when handle to board is invalid.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_SetControlLoop()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetControlLoop	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_control_loop_t	controlLoopCfg,
		float64_t	controlLoopValue )

Sets the value for the control loop parameter and channel 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]).
controlLoopCfg	: (Input) either NAI_DA_CTRL_LOOP_KP or NAI_DA_CTRL_LOOP_KI.
controlLoopValue	: (Input) TRUE = FullBridge, FALSE = HalfBridge (normal mode).

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 mode parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_SetCurrentLimit()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetCurrentLimit	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t	currentLimit )

Set the channel's current limit (mAmps) for the overcurrent status. An overcurrent status will be set when the channel's current exceeds this limit.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connect 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]).
currentLimit	: (Input) Current limit in mAmps.

Returns

NAI_SUCCESS when the function is completed successfully.
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_DA_SetExtPowerThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetExtPowerThreshold	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_da_extpwr_threshold_t	thresType,
		float64_t	threshold )

Sets the external power threshold of the type and channel specified. When the module detects a level outside the threshold defined, the External Power status (UnderVoltage or OVerVoltage) will be set.

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]).
thresType	: (Input) threshold type to access.
threshold	: (Input) external power threshold.

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 mode parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_SetFifoLoopMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetFifoLoopMode	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		uint32_t	loopmode )

Sets the channel's bit in the fifo loop mode register to 1(true) or 0(false). This function is only for DA2. When set to true, the fifo for that channel is in loop mode. When set to false it is not.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connect 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]).
loopmode	: (Input) FIFO Loop Mode.

Returns

NAI_SUCCESS when the function is completed successfully.
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_DA_SetFullBridgeMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetFullBridgeMode	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		bool_t	fullBridgeMode )

Sets Full-Bridge mode on the DA5. Half-Bridge is set by default where each channel works independently. Full-Bridge pairs two channels together and the output is the differential between them. Full-Bridge pairs an odd and even channel together, using the odd channels controls to control the output. For example, setting Full-Bridge mode on channel 1 bridges channel 1 and channel 2 together where the output is the differential between channels 1 and 2 and controlled by channel 1.

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]).
fullBridgeMode	: (Input) TRUE = FullBridge, FALSE = HalfBridge (normal mode).

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 mode parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_SetRAMFIFOMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetRAMFIFOMode	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		bool_t	ramfifomode )

Sets the RAM/FIFO Mode setting for the DA module and channel specified. The RAM/FIFO Mode register is bitmapped per channel, with the LSB corresponding to channel 1, and the MSB corresponding to the max channel. If a �1� is written in the RAM/FIFO Mode register, the memory will be used as a FIFO; otherwise it is used as RAM.

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]).
ramfifomode	: (Input) RAM/FIFO Mode setting to set. 1 for FIFO, 0 for RAM.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetUseFifo	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		bool_t	usefifo )

Sets the channels bit in the using fifo register to 1(true) or 0(false). This function is only for DA2. When set to true the fifo for that channel is active. When set to false it is not.

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]).
usefifo	: (input) true = using channels fifo. False = not using channels fifo.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetUseMemory	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		bool_t	usememory )

Sets the use memory setting for the DA module and channel specified. The use memory register is bitmapped per channel, with the LSB corresponding to channel 1, and the MSB corresponding to the max channel. Writing a �1� to Use Memory will allow the DAC output to come from the memory. Writing a �0� to Use Memory will not utilize the memory space and the DAC output will reflect the value written in DAC Value.

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]).
usememory	: (Input) Use memory setting to set. 1 to use memory space, 0 to use register values

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_SetWriteThroughMode	(	int32_t	cardIndex,
		int32_t	module,
		bool_t	writeThroughEnable )

Sets the state of the write-through mode to enabled or disabled.

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]).
writeThroughEnable	: (Input) TRUE to enable, FALSE to disable.

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_NOT_SUPPORTED when function is not supported.

◆ naibrd_DA_UpdateStrobe()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_UpdateStrobe	(	int32_t	cardIndex,
		int32_t	module )

Strobes (updates) all outputs to the value stored in the data registers. The outputs will update once per call.

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]).

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_NOT_SUPPORTED when function is not supported.

Functions

Detailed Description

Function Documentation

◆ naibrd_DA_GetControlLoop()

◆ naibrd_DA_GetCurrentLimit()

◆ naibrd_DA_GetDriveTemperature()

◆ naibrd_DA_GetExtPowerMeasurement()

◆ naibrd_DA_GetExtPowerThreshold()

◆ naibrd_DA_GetFifoLoopMode()

◆ naibrd_DA_GetFullBridgeMode()

◆ naibrd_DA_GetRAMFIFOMode()

◆ naibrd_DA_GetUseFifo()

◆ naibrd_DA_GetUseMemory()

◆ naibrd_DA_GetWriteThroughMode()

◆ naibrd_DA_SetControlLoop()

◆ naibrd_DA_SetCurrentLimit()

◆ naibrd_DA_SetExtPowerThreshold()

◆ naibrd_DA_SetFifoLoopMode()

◆ naibrd_DA_SetFullBridgeMode()

◆ naibrd_DA_SetRAMFIFOMode()

◆ naibrd_DA_SetUseFifo()

◆ naibrd_DA_SetUseMemory()

◆ naibrd_DA_SetWriteThroughMode()

◆ naibrd_DA_UpdateStrobe()