#include <yocto_wakeupmonitor.h>
Public Member Functions | |
virtual int | _invokeValueCallback (string value) |
s64 | get_nextWakeUp (void) |
int | get_powerDuration (void) |
s64 | get_rtcTime (void) |
int | get_sleepCountdown (void) |
Y_WAKEUPREASON_enum | get_wakeUpReason (void) |
Y_WAKEUPSTATE_enum | get_wakeUpState (void) |
YWakeUpMonitor * | next (void) |
s64 | nextWakeUp (void) |
YWakeUpMonitor * | nextWakeUpMonitor (void) |
int | powerDuration (void) |
virtual int | registerValueCallback (YWakeUpMonitorValueCallback callback) |
virtual int | resetSleepCountDown (void) |
s64 | rtcTime (void) |
int | set_nextWakeUp (s64 newval) |
int | set_powerDuration (int newval) |
int | set_sleepCountdown (int newval) |
int | set_wakeUpState (Y_WAKEUPSTATE_enum newval) |
int | setNextWakeUp (s64 newval) |
int | setPowerDuration (int newval) |
int | setSleepCountdown (int newval) |
int | setWakeUpState (Y_WAKEUPSTATE_enum newval) |
virtual int | sleep (int secBeforeSleep) |
int | sleepCountdown (void) |
virtual int | sleepFor (int secUntilWakeUp, int secBeforeSleep) |
virtual int | sleepUntil (int wakeUpTime, int secBeforeSleep) |
virtual int | wakeUp (void) |
Y_WAKEUPREASON_enum | wakeUpReason (void) |
Y_WAKEUPSTATE_enum | wakeUpState (void) |
~YWakeUpMonitor () | |
Public Member Functions inherited from YFunction | |
void | _clearDataStreamCache () |
string | _decode_json_string (const string &json) |
string | _download (const string &url) |
YDataStream * | _findDataStream (YDataSet &dataset, const string &def) |
string | _get_json_path (const string &json, const string &path) |
vector< string > | _json_get_array (const string &json) |
string | _json_get_key (const string &json, const string &data) |
string | _json_get_string (const string &json) |
int | _parseEx (yJsonStateMachine &j) |
virtual int | _parserHelper (void) |
string | _parseString (yJsonStateMachine &j) |
string | _request (const string &request) |
string | _requestEx (int tcpchan, const string &request, yapiRequestProgressCallback callback, void *context) |
void | _throw (YRETCODE errType, string errMsg) |
YRETCODE | _upload (const string &path, const string &content) |
YRETCODE | _uploadWithProgress (const string &path, const string &content, yapiRequestProgressCallback callback, void *context) |
string | advertisedValue (void) |
void | clearCache () |
string | describe (void) |
string | errMessage (void) |
string | errorMessage (void) |
YRETCODE | errorType (void) |
YRETCODE | errType (void) |
YFUN_DESCR | functionDescriptor (void) |
string | get_advertisedValue (void) |
string | get_errorMessage (void) |
YRETCODE | get_errorType (void) |
virtual string | get_friendlyName (void) |
YFUN_DESCR | get_functionDescriptor (void) |
string | get_functionId (void) |
string | get_hardwareId (void) |
string | get_hubSerial () |
string | get_logicalName (void) |
YModule * | get_module (void) |
void * | get_userData (void) |
bool | isOnline (void) |
YRETCODE | load (int msValidity) |
virtual string | loadAttribute (string attrName) |
string | logicalName (void) |
YModule * | module (void) |
virtual int | muteValueCallbacks (void) |
YFunction * | next (void) |
YFunction * | nextFunction (void) |
virtual int | registerValueCallback (YFunctionValueCallback callback) |
int | set_advertisedValue (const string &newval) |
int | set_logicalName (const string &newval) |
void | set_userData (void *data) |
int | setAdvertisedValue (const string &newval) |
int | setLogicalName (const string &newval) |
void | setUserData (void *data) |
virtual int | unmuteValueCallbacks (void) |
void * | userData (void) |
virtual | ~YFunction () |
Static Public Member Functions | |
static YWakeUpMonitor * | Find (string func) |
static YWakeUpMonitor * | FindWakeUpMonitor (string func) |
static YWakeUpMonitor * | First (void) |
static YWakeUpMonitor * | FirstWakeUpMonitor (void) |
Static Public Member Functions inherited from YFunction | |
static void | _ClearCache (void) |
static YFunction * | Find (string func) |
static YFunction * | FindFunction (string func) |
static YFunction * | First (void) |
static YFunction * | FirstFunction (void) |
Protected Member Functions | |
virtual int | _parseAttr (YJSONObject *json_val) |
YWakeUpMonitor (const string &func) | |
Protected Member Functions inherited from YFunction | |
YRETCODE | _buildSetRequest (const string &changeattr, const string *changeval, string &request, string &errmsg) |
string | _escapeAttr (const string &changeval) |
YRETCODE | _getDescriptor (YFUN_DESCR &fundescr, string &errMsg) |
YRETCODE | _getDevice (YDevice *&dev, string &errMsg) |
YRETCODE | _load_unsafe (int msValidity) |
YRETCODE | _nextFunction (string &hwId) |
int | _parse (YJSONObject *j) |
YRETCODE | _setAttr (string attrname, string newvalue) |
YFunction (const string &func) | |
Protected Attributes | |
int | _endOfTime |
s64 | _nextWakeUp |
int | _powerDuration |
s64 | _rtcTime |
int | _sleepCountdown |
YWakeUpMonitorValueCallback | _valueCallbackWakeUpMonitor |
Y_WAKEUPREASON_enum | _wakeUpReason |
Y_WAKEUPSTATE_enum | _wakeUpState |
Protected Attributes inherited from YFunction | |
string | _advertisedValue |
u64 | _cacheExpiration |
string | _className |
std::map< string, YDataStream * > | _dataStreams |
string | _func |
YFUN_DESCR | _fundescr |
string | _funId |
string | _hwId |
string | _lastErrorMsg |
YRETCODE | _lastErrorType |
string | _logicalName |
string | _serial |
yCRITICAL_SECTION | _this_cs |
void * | _userData |
YFunctionValueCallback | _valueCallbackFunction |
Friends | |
YWakeUpMonitor * | yFindWakeUpMonitor (const string &func) |
YWakeUpMonitor * | yFirstWakeUpMonitor (void) |
Additional Inherited Members | |
Static Protected Member Functions inherited from YFunction | |
static void | _AddToCache (const string &classname, const string &func, YFunction *obj) |
static YFunction * | _FindFromCache (const string &classname, const string &func) |
static void | _UpdateTimedReportCallbackList (YFunction *func, bool add) |
static void | _UpdateValueCallbackList (YFunction *func, bool add) |
Static Protected Attributes inherited from YFunction | |
static std::map< string, YFunction * > | _cache |
YWakeUpMonitor Class: WakeUpMonitor function interface
The WakeUpMonitor function handles globally all wake-up sources, as well as automated sleep mode.
Definition at line 88 of file yocto_wakeupmonitor.h.
|
protected |
Definition at line 51 of file yocto_wakeupmonitor.cpp.
YWakeUpMonitor::~YWakeUpMonitor | ( | ) |
Definition at line 66 of file yocto_wakeupmonitor.cpp.
|
virtual |
Reimplemented from YFunction.
Definition at line 437 of file yocto_wakeupmonitor.cpp.
|
protectedvirtual |
Reimplemented from YFunction.
Definition at line 74 of file yocto_wakeupmonitor.cpp.
|
inlinestatic |
Definition at line 344 of file yocto_wakeupmonitor.h.
|
static |
Retrieves a monitor for a given identifier. The identifier can be specified using several formats:
This function does not require that the monitor is online at the time it is invoked. The returned object is nevertheless valid. Use the method YWakeUpMonitor.isOnline() to test if the monitor is indeed online at a given time. In case of ambiguity when looking for a monitor by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.
If a call to this object's is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.
func | : a string that uniquely characterizes the monitor |
Definition at line 386 of file yocto_wakeupmonitor.cpp.
|
inlinestatic |
Definition at line 368 of file yocto_wakeupmonitor.h.
|
static |
Starts the enumeration of monitors currently accessible. Use the method YWakeUpMonitor.nextWakeUpMonitor() to iterate on next monitors.
Definition at line 551 of file yocto_wakeupmonitor.cpp.
s64 YWakeUpMonitor::get_nextWakeUp | ( | void | ) |
Returns the next scheduled wake up date/time (UNIX format).
On failure, throws an exception or returns Y_NEXTWAKEUP_INVALID.
Definition at line 214 of file yocto_wakeupmonitor.cpp.
int YWakeUpMonitor::get_powerDuration | ( | void | ) |
Returns the maximal wake up time (in seconds) before automatically going to sleep.
On failure, throws an exception or returns Y_POWERDURATION_INVALID.
Definition at line 105 of file yocto_wakeupmonitor.cpp.
s64 YWakeUpMonitor::get_rtcTime | ( | void | ) |
Definition at line 337 of file yocto_wakeupmonitor.cpp.
int YWakeUpMonitor::get_sleepCountdown | ( | void | ) |
Returns the delay before the next sleep period.
On failure, throws an exception or returns Y_SLEEPCOUNTDOWN_INVALID.
Definition at line 160 of file yocto_wakeupmonitor.cpp.
Y_WAKEUPREASON_enum YWakeUpMonitor::get_wakeUpReason | ( | void | ) |
Returns the latest wake up reason.
On failure, throws an exception or returns Y_WAKEUPREASON_INVALID.
Definition at line 270 of file yocto_wakeupmonitor.cpp.
Y_WAKEUPSTATE_enum YWakeUpMonitor::get_wakeUpState | ( | void | ) |
Returns the current state of the monitor.
On failure, throws an exception or returns Y_WAKEUPSTATE_INVALID.
Definition at line 299 of file yocto_wakeupmonitor.cpp.
|
inline |
Definition at line 355 of file yocto_wakeupmonitor.h.
|
inline |
Definition at line 194 of file yocto_wakeupmonitor.h.
YWakeUpMonitor * YWakeUpMonitor::nextWakeUpMonitor | ( | void | ) |
Continues the enumeration of monitors started using yFirstWakeUpMonitor().
Definition at line 541 of file yocto_wakeupmonitor.cpp.
|
inline |
Definition at line 143 of file yocto_wakeupmonitor.h.
|
virtual |
Registers the callback function that is invoked on every change of advertised value. The callback is invoked only during the execution of ySleep or yHandleEvents. This provides control over the time when the callback is triggered. For good responsiveness, remember to call one of these two functions periodically. To unregister a callback, pass a NULL pointer as argument.
callback | : the callback function to call, or a NULL pointer. The callback function should take two arguments: the function object of which the value has changed, and the character string describing the new advertised value. |
Definition at line 418 of file yocto_wakeupmonitor.cpp.
|
virtual |
Resets the sleep countdown.
Definition at line 534 of file yocto_wakeupmonitor.cpp.
|
inline |
Definition at line 242 of file yocto_wakeupmonitor.h.
int YWakeUpMonitor::set_nextWakeUp | ( | s64 | newval | ) |
Changes the days of the week when a wake up must take place.
newval | : an integer corresponding to the days of the week when a wake up must take place |
On failure, throws an exception or returns a negative error code.
Definition at line 245 of file yocto_wakeupmonitor.cpp.
int YWakeUpMonitor::set_powerDuration | ( | int | newval | ) |
Changes the maximal wake up time (seconds) before automatically going to sleep.
newval | : an integer corresponding to the maximal wake up time (seconds) before automatically going to sleep |
On failure, throws an exception or returns a negative error code.
Definition at line 137 of file yocto_wakeupmonitor.cpp.
int YWakeUpMonitor::set_sleepCountdown | ( | int | newval | ) |
Changes the delay before the next sleep period.
newval | : an integer corresponding to the delay before the next sleep period |
On failure, throws an exception or returns a negative error code.
Definition at line 191 of file yocto_wakeupmonitor.cpp.
int YWakeUpMonitor::set_wakeUpState | ( | Y_WAKEUPSTATE_enum | newval | ) |
Definition at line 321 of file yocto_wakeupmonitor.cpp.
|
inline |
Definition at line 207 of file yocto_wakeupmonitor.h.
|
inline |
Definition at line 157 of file yocto_wakeupmonitor.h.
|
inline |
Definition at line 182 of file yocto_wakeupmonitor.h.
|
inline |
Definition at line 237 of file yocto_wakeupmonitor.h.
|
virtual |
Goes to sleep until the next wake up condition is met, the RTC time must have been set before calling this function.
secBeforeSleep | : number of seconds before going into sleep mode, |
On failure, throws an exception or returns a negative error code.
Definition at line 465 of file yocto_wakeupmonitor.cpp.
|
inline |
Definition at line 169 of file yocto_wakeupmonitor.h.
|
virtual |
Goes to sleep for a specific duration or until the next wake up condition is met, the RTC time must have been set before calling this function. The count down before sleep can be canceled with resetSleepCountDown.
secUntilWakeUp | : number of seconds before next wake up |
secBeforeSleep | : number of seconds before going into sleep mode |
On failure, throws an exception or returns a negative error code.
Definition at line 490 of file yocto_wakeupmonitor.cpp.
|
virtual |
Go to sleep until a specific date is reached or until the next wake up condition is met, the RTC time must have been set before calling this function. The count down before sleep can be canceled with resetSleepCountDown.
wakeUpTime | : wake-up datetime (UNIX format) |
secBeforeSleep | : number of seconds before going into sleep mode |
On failure, throws an exception or returns a negative error code.
Definition at line 515 of file yocto_wakeupmonitor.cpp.
|
virtual |
Forces a wake up.
Definition at line 450 of file yocto_wakeupmonitor.cpp.
|
inline |
Definition at line 221 of file yocto_wakeupmonitor.h.
|
inline |
Definition at line 233 of file yocto_wakeupmonitor.h.
|
friend |
Retrieves a monitor for a given identifier. The identifier can be specified using several formats:
This function does not require that the monitor is online at the time it is invoked. The returned object is nevertheless valid. Use the method YWakeUpMonitor.isOnline() to test if the monitor is indeed online at a given time. In case of ambiguity when looking for a monitor by logical name, no error is notified: the first instance found is returned. The search is performed first by hardware name, then by logical name.
If a call to this object's is_online() method returns FALSE although you are certain that the matching device is plugged, make sure that you did call registerHub() at application initialization time.
func | : a string that uniquely characterizes the monitor |
Definition at line 405 of file yocto_wakeupmonitor.h.
|
friend |
Starts the enumeration of monitors currently accessible. Use the method YWakeUpMonitor.nextWakeUpMonitor() to iterate on next monitors.
Definition at line 416 of file yocto_wakeupmonitor.h.
|
protected |
Definition at line 102 of file yocto_wakeupmonitor.h.
|
protected |
Definition at line 98 of file yocto_wakeupmonitor.h.
|
protected |
Definition at line 96 of file yocto_wakeupmonitor.h.
|
protected |
Definition at line 101 of file yocto_wakeupmonitor.h.
|
protected |
Definition at line 97 of file yocto_wakeupmonitor.h.
|
protected |
Definition at line 103 of file yocto_wakeupmonitor.h.
|
protected |
Definition at line 99 of file yocto_wakeupmonitor.h.
|
protected |
Definition at line 100 of file yocto_wakeupmonitor.h.
|
static |
Definition at line 121 of file yocto_wakeupmonitor.h.
|
static |
Definition at line 119 of file yocto_wakeupmonitor.h.
|
static |
Definition at line 132 of file yocto_wakeupmonitor.h.
|
static |
Definition at line 120 of file yocto_wakeupmonitor.h.
|
static |
Definition at line 124 of file yocto_wakeupmonitor.h.
|
static |
Definition at line 123 of file yocto_wakeupmonitor.h.
|
static |
Definition at line 125 of file yocto_wakeupmonitor.h.
|
static |
Definition at line 128 of file yocto_wakeupmonitor.h.
|
static |
Definition at line 126 of file yocto_wakeupmonitor.h.
|
static |
Definition at line 127 of file yocto_wakeupmonitor.h.
|
static |
Definition at line 122 of file yocto_wakeupmonitor.h.
|
static |
Definition at line 130 of file yocto_wakeupmonitor.h.
|
static |
Definition at line 131 of file yocto_wakeupmonitor.h.
|
static |
Definition at line 129 of file yocto_wakeupmonitor.h.