Mode

Functions
PEAK_AFL_API_STATUS	peak_afl_AutoController_BrightnessComponent_Mode_IsSupported (peak_afl_controller_handle controller, peak_afl_BOOL8 *supported)
	Check if brightness component mode is supported for a controller component.
PEAK_AFL_API_STATUS	peak_afl_AutoController_BrightnessComponent_Mode_Set (peak_afl_controller_handle controller, peak_afl_controller_brightness_component component, peak_afl_controller_automode mode)
	Set the autofeature mode for a brightness component.
PEAK_AFL_API_STATUS	peak_afl_AutoController_BrightnessComponent_Mode_Get (peak_afl_controller_handle controller, peak_afl_controller_brightness_component component, peak_afl_controller_automode *mode)
	Get the current brightness component mode for a controller.

Detailed Description

For ongoing adaptations the Continuous mode has to be used so that it responds to deviations from the target value. To disable the control functionality automatically once the target value has been reached, (approximately) use the Once mode.

Function Documentation

peak_afl_AutoController_BrightnessComponent_Mode_Get()

PEAK_AFL_API_STATUS peak_afl_AutoController_BrightnessComponent_Mode_Get	(	peak_afl_controller_handle	controller,
		peak_afl_controller_brightness_component	component,
		peak_afl_controller_automode *	mode )

Get the current brightness component mode for a controller.

Parameters

[in]	controller	controller handle
[out]	component	brightness component
[out]	mode	autofeature mode

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.2

peak_afl_AutoController_BrightnessComponent_Mode_IsSupported()

PEAK_AFL_API_STATUS peak_afl_AutoController_BrightnessComponent_Mode_IsSupported	(	peak_afl_controller_handle	controller,
		peak_afl_BOOL8 *	supported )

Check if brightness component mode is supported for a controller component.

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

Parameters

[in]	controller	controller handle
[out]	supported	boolean if controller component supports auto mode

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.2

peak_afl_AutoController_BrightnessComponent_Mode_Set()

PEAK_AFL_API_STATUS peak_afl_AutoController_BrightnessComponent_Mode_Set	(	peak_afl_controller_handle	controller,
		peak_afl_controller_brightness_component	component,
		peak_afl_controller_automode	mode )

Set the autofeature mode for a brightness component.

Will set the controller component to component. See peak_afl_controller_brightness_component for a list of valid values.

Parameters

[in]	controller	controller handle
[in]	component	brightness component
[in]	mode	autofeature mode

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.2