Hysteresis

Functions
PEAK_AFL_API_STATUS	peak_afl_AutoController_Hysteresis_IsSupported (peak_afl_controller_handle controller, peak_afl_BOOL8 *supported)
	Check if hysteresis is supported for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_Hysteresis_Default (peak_afl_controller_handle controller, uint8_t *hysteresis)
	Get the autofeature hysteresis default.
PEAK_AFL_API_STATUS	peak_afl_AutoController_Hysteresis_Set (peak_afl_controller_handle controller, uint8_t hysteresis)
	Set the autofeature hysteresis for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_Hysteresis_Get (peak_afl_controller_handle controller, uint8_t *hysteresis)
	Get the autofeature hysteresis for a controller.
PEAK_AFL_API_STATUS	peak_afl_AutoController_Hysteresis_GetRange (peak_afl_controller_handle controller, uint8_t *min, uint8_t *max, uint8_t *inc)
	Get autofeature hysteresis range for a controller.

Detailed Description

Defines the size of the interval range after which the algorithm terminates the search.

Function Documentation

peak_afl_AutoController_Hysteresis_Default()

PEAK_AFL_API_STATUS peak_afl_AutoController_Hysteresis_Default	(	peak_afl_controller_handle	controller,
		uint8_t *	hysteresis )

Get the autofeature hysteresis default.

Parameters

[in]	controller	controller handle
[out]	hysteresis	the default hysteresis

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

PEAK_AFL_API_STATUS peak_afl_AutoController_Hysteresis_Get	(	peak_afl_controller_handle	controller,
		uint8_t *	hysteresis )

Get the autofeature hysteresis for a controller.

Parameters

[in]	controller	controller handle
[out]	hysteresis	the hysteresis

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

PEAK_AFL_API_STATUS peak_afl_AutoController_Hysteresis_GetRange	(	peak_afl_controller_handle	controller,
		uint8_t *	min,
		uint8_t *	max,
		uint8_t *	inc )

Get autofeature hysteresis range for a controller.

Parameters

[in]	controller	controller handle
[out]	min	minimum number of hysteresis
[out]	max	maximum number of hysteresis
[out]	inc	increment number of hysteresis

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

PEAK_AFL_API_STATUS peak_afl_AutoController_Hysteresis_IsSupported	(	peak_afl_controller_handle	controller,
		peak_afl_BOOL8 *	supported )

Check if hysteresis is supported for a controller.

If supported is PEAK_AFL_TRUE hysteresis is supported, otherwise it is unsupported.

Parameters

[in]	controller	controller handle
[out]	supported	boolean if controller supports hysteresis

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

PEAK_AFL_API_STATUS peak_afl_AutoController_Hysteresis_Set	(	peak_afl_controller_handle	controller,
		uint8_t	hysteresis )

Set the autofeature hysteresis for a controller.

Set the hysteresis for the algorithm set by peak_afl_AutoController_Algorithm_Set

Parameters

[in]	controller	controller handle
[in]	hysteresis	the hysteresis to set

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