Sets the Display timeout of the screen
setting
is display timeout param. Five different timeouts can be set using this parameter.
0x03 DisplayTimeout_3S (sets display timeout to 3 seconds)
0x06 DisplayTimeout_6S (sets display timeout to 6 seconds)
0x0C DisplayTimeout_12S (sets display timeout to 12 seconds)
0x12 DisplayTimeout_18S (sets display timeout to 18 seconds)
0x00 DisplayTimeout_NoTimeout (display timeout will not be set)
permanent
is a Boolean flag which can either be
true
or
false
. It should be set to true if the new settings have to be stored to flash.
Return value:
uint8_t status
CONFIG_SETTING_SUCCESS
– When setting is success.
CONFIG_SETTING_FAIL
– When setting is failed/not allowed.
Example
: To set display timeout to 3 seconds, API can be called in one of the following ways:
CST_APIsetDisplayTimeout (0x03, true);
or
CST_APIsetDisplayTimeout (DisplayTimeout_3S, true);