Overload Operation Functions

Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DA_RetryOverload (int32_t cardIndex, int32_t module, bool_t enable)
	When Retry Overload is enabled, the module will attempt to recover from an over-current condition once a second. While the over-current conditions exist, the channel will be set to zero output.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DA_ResetOverload (int32_t cardIndex, int32_t module)
	Note: This is the 'Reset Overcurrent' API for DA2,DA3 and DA4 Resets all D/A channels on the specified module that had been disabled following an over-load condition. When the reset process is complete, the processor will write a "0" back to the Reset Overload register when all over-current conditions are removed and all outputs are enabled.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DA_OvercurrentOverride (int32_t cardIndex, int32_t module, bool_t enable)
	When Over Current Override is set to "1" the over-current protection is turned off. By default, the value is set to "0" to enable over-current protection. Note, disabling the over-current protection should only be used for a short time period. Extended periods of over-current exposure will damage the D/A circuit.

Detailed Description

Function Documentation

naibrd_DA_OvercurrentOverride()

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

When Over Current Override is set to "1" the over-current protection is turned off. By default, the value is set to "0" to enable over-current protection. Note, disabling the over-current protection should only be used for a short time period. Extended periods of over-current exposure will damage the D/A circuit.

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 , 0 to disable override overcurrent protection.

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

NAIBRDFUNC nai_status_t NAIAPI naibrd_DA_ResetOverload	(	int32_t	cardIndex,
		int32_t	module )

Note: This is the 'Reset Overcurrent' API for DA2,DA3 and DA4 Resets all D/A channels on the specified module that had been disabled following an over-load condition. When the reset process is complete, the processor will write a "0" back to the Reset Overload register when all over-current conditions are removed and all outputs are enabled.

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.

naibrd_DA_RetryOverload()

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

When Retry Overload is enabled, the module will attempt to recover from an over-current condition once a second. While the over-current conditions exist, the channel will be set to zero output.

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) 0 to disable, 1 to enable retry.

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.