Mode

Enumerations
enum	peak_afl_controller_automode { PEAK_AFL_CONTROLLER_AUTOMODE_OFF , PEAK_AFL_CONTROLLER_AUTOMODE_CONTINUOUS , PEAK_AFL_CONTROLLER_AUTOMODE_ONCE }
	controller automode More...

Functions
PEAK_AFL_API_STATUS	peak_afl_AutoController_Mode_IsSupported (peak_afl_controller_handle controller, peak_afl_BOOL8 *supported)
	Check if auto mode is supported for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_Mode_Set (peak_afl_controller_handle controller, peak_afl_controller_automode mode)
	Set the autofeature mode for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_Mode_Get (peak_afl_controller_handle controller, peak_afl_controller_automode *mode)
	Get the current autofeature 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.

Enumeration Type Documentation

peak_afl_controller_automode

enum peak_afl_controller_automode

controller automode

Enumerator
PEAK_AFL_CONTROLLER_AUTOMODE_OFF	Automode off.
PEAK_AFL_CONTROLLER_AUTOMODE_CONTINUOUS	Automode continuous.
PEAK_AFL_CONTROLLER_AUTOMODE_ONCE	Automode once.

Function Documentation

peak_afl_AutoController_Mode_Get()

PEAK_AFL_API_STATUS peak_afl_AutoController_Mode_Get	(	peak_afl_controller_handle	controller,
		peak_afl_controller_automode *	mode )

Get the current autofeature mode for a controller.

Parameters

[in]	controller	controller handle
[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.0

peak_afl_AutoController_Mode_IsSupported()

PEAK_AFL_API_STATUS peak_afl_AutoController_Mode_IsSupported	(	peak_afl_controller_handle	controller,
		peak_afl_BOOL8 *	supported )

Check if auto mode is supported for a controller.

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

Parameters

[in]	controller	controller handle
[out]	supported	boolean if controller 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.0

peak_afl_AutoController_Mode_Set()

PEAK_AFL_API_STATUS peak_afl_AutoController_Mode_Set	(	peak_afl_controller_handle	controller,
		peak_afl_controller_automode	mode )

Set the autofeature mode for a controller.

Will set the controller mode to mode. See peak_afl_controller_automode for a list of valid values.

Parameters

[in]	controller	controller handle
[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.0