Auto tolerance

Functions
PEAK_AFL_API_STATUS	peak_afl_AutoController_AutoTolerance_IsSupported (peak_afl_controller_handle controller, peak_afl_BOOL8 *supported)
	check if auto tolerance is supported for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_AutoTolerance_Set (peak_afl_controller_handle controller, uint32_t tolerance)
	Set the auto tolerance for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_AutoTolerance_Get (peak_afl_controller_handle controller, uint32_t *tolerance)
	Get the current auto tolerance for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_AutoTolerance_GetRange (peak_afl_controller_handle controller, uint32_t *min, uint32_t *max, uint32_t *inc)
	Get the auto tolerance range for a controller.

Detailed Description

The automatic control feature uses a tolerance function for stabilization. Automatic control is stopped when the actual value is within a range between (setpoint - tolerance value) and (setpoint + tolerance value). The control algorithm continues if the actual brightness value drops below (setpoint - tolerance value) or exceeds the desired target value (setpoint + tolerance value). If the tolerance value is increased, the control function will stop sooner. This can be useful in some situations.

Function Documentation

peak_afl_AutoController_AutoTolerance_Get()

PEAK_AFL_API_STATUS peak_afl_AutoController_AutoTolerance_Get	(	peak_afl_controller_handle	controller,
		uint32_t *	tolerance )

Get the current auto tolerance for a controller.

Parameters

[in]	controller	controller handle
[out]	tolerance	auto tolerance value

Returns

PEAK_AFL_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_AFL_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_AFL_STATUS_INVALID_PARAMETER The argument is invalid.

PEAK_AFL_STATUS_NOT_SUPPORTED The function is not supported.

PEAK_AFL_STATUS_ERROR An unexpected internal error occurred.

Since

1.0

peak_afl_AutoController_AutoTolerance_GetRange()

PEAK_AFL_API_STATUS peak_afl_AutoController_AutoTolerance_GetRange	(	peak_afl_controller_handle	controller,
		uint32_t *	min,
		uint32_t *	max,
		uint32_t *	inc )

Get the auto tolerance range for a controller.

Call this function to get the range of valid values which can be set by a call to peak_afl_AutoController_AutoTolerance_Set.

Parameters

[in]	controller	controller handle
[out]	min	auto tolerance minimum value
[out]	max	auto tolerance maximum value
[out]	inc	auto tolerance increment value

Returns

PEAK_AFL_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_AFL_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_AFL_STATUS_INVALID_PARAMETER The argument is invalid.

PEAK_AFL_STATUS_NOT_SUPPORTED The function is not supported.

PEAK_AFL_STATUS_ERROR An unexpected internal error occurred.

Since

1.0

peak_afl_AutoController_AutoTolerance_IsSupported()

PEAK_AFL_API_STATUS peak_afl_AutoController_AutoTolerance_IsSupported	(	peak_afl_controller_handle	controller,
		peak_afl_BOOL8 *	supported )

check if auto tolerance is supported for a controller.

If supported is PEAK_AFL_TRUE auto tolerance is supported, otherwise it is unsupported.

Parameters

[in]	controller	controller handle
[out]	supported	boolean if controller supports auto tolerance

Returns

PEAK_AFL_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_AFL_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_AFL_STATUS_INVALID_PARAMETER The argument is invalid.

PEAK_AFL_STATUS_ERROR An unexpected internal error occurred.

Since

1.0

peak_afl_AutoController_AutoTolerance_Set()

PEAK_AFL_API_STATUS peak_afl_AutoController_AutoTolerance_Set	(	peak_afl_controller_handle	controller,
		uint32_t	tolerance )

Set the auto tolerance for a controller.

Sets the +/- tolerance for the auto target value.

Parameters

[in]	controller	controller handle
[in]	tolerance	auto target value

Returns

PEAK_AFL_STATUS_SUCCESS Operation was successful; no error occurred.

PEAK_AFL_STATUS_NOT_INITIALIZED The library is not initialized.

PEAK_AFL_STATUS_INVALID_PARAMETER The argument is invalid.

PEAK_AFL_STATUS_NOT_SUPPORTED The function is not supported.

PEAK_AFL_STATUS_ERROR An unexpected internal error occurred.

Since

1.0