public class YWakeUpSchedule extends YFunction
| Modifier and Type | Class and Description |
|---|---|
static interface |
YWakeUpSchedule.TimedReportCallback
TimedReportCallback for WakeUpSchedule
|
static interface |
YWakeUpSchedule.UpdateCallback
Deprecated UpdateCallback for WakeUpSchedule
|
| Modifier and Type | Field and Description |
|---|---|
protected int |
_hours |
protected int |
_minutesA |
protected int |
_minutesB |
protected int |
_monthDays |
protected int |
_months |
protected long |
_nextOccurence |
protected int |
_secondsBefore |
protected YWakeUpSchedule.UpdateCallback |
_valueCallbackWakeUpSchedule |
protected int |
_weekDays |
static int |
HOURS_INVALID
invalid hours value
|
static int |
MINUTESA_INVALID
invalid minutesA value
|
static int |
MINUTESB_INVALID
invalid minutesB value
|
static int |
MONTHDAYS_INVALID
invalid monthDays value
|
static int |
MONTHS_INVALID
invalid months value
|
static long |
NEXTOCCURENCE_INVALID
invalid nextOccurence value
|
static int |
SECONDSBEFORE_INVALID
invalid secondsBefore value
|
static int |
WEEKDAYS_INVALID
invalid weekDays value
|
_advertisedValue, _cacheExpiration, _className, _dataStreams, _func, _funId, _hwId, _lastErrorMsg, _lastErrorType, _logicalName, _serial, _userData, _valueCallbackFunction, _yapi, ADVERTISEDVALUE_INVALID, FUNCTIONDESCRIPTOR_INVALID, LOGICALNAME_INVALID| Modifier | Constructor and Description |
|---|---|
protected |
YWakeUpSchedule(String func) |
protected |
YWakeUpSchedule(YAPIContext ctx,
String func) |
| Modifier and Type | Method and Description |
|---|---|
int |
_invokeValueCallback(String value) |
protected void |
_parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val) |
static YWakeUpSchedule |
FindWakeUpSchedule(String func)
Retrieves a wake up schedule for a given identifier.
|
static YWakeUpSchedule |
FindWakeUpScheduleInContext(YAPIContext yctx,
String func)
Retrieves a wake up schedule for a given identifier in a YAPI context.
|
static YWakeUpSchedule |
FirstWakeUpSchedule()
Starts the enumeration of wake up schedules currently accessible.
|
static YWakeUpSchedule |
FirstWakeUpScheduleInContext(YAPIContext yctx)
Starts the enumeration of wake up schedules currently accessible.
|
int |
get_hours()
Returns the hours scheduled for wake up.
|
long |
get_minutes()
Returns all the minutes of each hour that are scheduled for wake up.
|
int |
get_minutesA()
Returns the minutes in the 00-29 interval of each hour scheduled for wake up.
|
int |
get_minutesB()
Returns the minutes in the 30-59 interval of each hour scheduled for wake up.
|
int |
get_monthDays()
Returns the days of the month scheduled for wake up.
|
int |
get_months()
Returns the months scheduled for wake up.
|
long |
get_nextOccurence()
Returns the date/time (seconds) of the next wake up occurrence.
|
int |
get_secondsBefore()
Returns the number of seconds to anticipate wake-up time to allow
the system to power-up.
|
int |
get_weekDays()
Returns the days of the week scheduled for wake up.
|
int |
getHours()
Returns the hours scheduled for wake up.
|
int |
getMinutesA()
Returns the minutes in the 00-29 interval of each hour scheduled for wake up.
|
int |
getMinutesB()
Returns the minutes in the 30-59 interval of each hour scheduled for wake up.
|
int |
getMonthDays()
Returns the days of the month scheduled for wake up.
|
int |
getMonths()
Returns the months scheduled for wake up.
|
long |
getNextOccurence()
Returns the date/time (seconds) of the next wake up occurrence.
|
int |
getSecondsBefore()
Returns the number of seconds to anticipate wake-up time to allow
the system to power-up.
|
int |
getWeekDays()
Returns the days of the week scheduled for wake up.
|
YWakeUpSchedule |
nextWakeUpSchedule()
Continues the enumeration of wake up schedules started using yFirstWakeUpSchedule().
|
int |
registerValueCallback(YWakeUpSchedule.UpdateCallback callback)
Registers the callback function that is invoked on every change of advertised value.
|
int |
set_hours(int newval)
Changes the hours when a wake up must take place.
|
int |
set_minutes(long bitmap)
Changes all the minutes where a wake up must take place.
|
int |
set_minutesA(int newval)
Changes the minutes in the 00-29 interval when a wake up must take place.
|
int |
set_minutesB(int newval)
Changes the minutes in the 30-59 interval when a wake up must take place.
|
int |
set_monthDays(int newval)
Changes the days of the month when a wake up must take place.
|
int |
set_months(int newval)
Changes the months when a wake up must take place.
|
int |
set_secondsBefore(int newval)
Changes the number of seconds to anticipate wake-up time to allow
the system to power-up.
|
int |
set_weekDays(int newval)
Changes the days of the week when a wake up must take place.
|
int |
setHours(int newval)
Changes the hours when a wake up must take place.
|
int |
setMinutesA(int newval)
Changes the minutes in the 00-29 interval when a wake up must take place.
|
int |
setMinutesB(int newval)
Changes the minutes in the 30-59 interval when a wake up must take place.
|
int |
setMonthDays(int newval)
Changes the days of the month when a wake up must take place.
|
int |
setMonths(int newval)
Changes the months when a wake up must take place.
|
int |
setSecondsBefore(int newval)
Changes the number of seconds to anticipate wake-up time to allow
the system to power-up.
|
int |
setWeekDays(int newval)
Changes the days of the week when a wake up must take place.
|
_AddToCache, _clearDataStreamCache, _decode_json_int, _decode_json_string, _download, _escapeAttr, _FindFromCache, _FindFromCacheInContext, _get_json_path_struct, _get_json_path, _is_valid_pass, _json_get_array, _json_get_key, _json_get_string, _parse, _parserHelper, _setAttr, _throw, _UpdateTimedReportCallbackList, _UpdateValueCallbackList, _upload, _upload, _uploadEx, clearCache, describe, errMessage, errorMessage, errorType, errType, FindFunction, FindFunctionInContext, FirstFunction, FirstFunctionInContext, functionDescriptor, get_advertisedValue, get_errorMessage, get_errorType, get_friendlyName, get_functionDescriptor, get_functionId, get_hardwareId, get_logicalName, get_module, get_serialNumber, get_userData, getAdvertisedValue, getErrorMessage, getErrorType, getFriendlyName, getFunctionDescriptor, getFunctionId, getHardwareId, getLogicalName, getModule, getUserData, isOnline, isReadOnly, load, loadAttribute, module, muteValueCallbacks, nextFunction, registerValueCallback, set_advertisedValue, set_logicalName, set_userData, setLogicalName, setUserData, toString, unmuteValueCallbacks, userDatapublic static final int MINUTESA_INVALID
public static final int MINUTESB_INVALID
public static final int HOURS_INVALID
public static final int WEEKDAYS_INVALID
public static final int MONTHDAYS_INVALID
public static final int MONTHS_INVALID
public static final int SECONDSBEFORE_INVALID
public static final long NEXTOCCURENCE_INVALID
protected int _minutesA
protected int _minutesB
protected int _hours
protected int _weekDays
protected int _monthDays
protected int _months
protected int _secondsBefore
protected long _nextOccurence
protected YWakeUpSchedule.UpdateCallback _valueCallbackWakeUpSchedule
protected YWakeUpSchedule(YAPIContext ctx, String func)
func - : functionidprotected YWakeUpSchedule(String func)
func - : functionidprotected void _parseAttr(com.yoctopuce.YoctoAPI.YJSONObject json_val)
throws Exception
_parseAttr in class YFunctionExceptionpublic int get_minutesA()
throws YAPI_Exception
YAPI_Exception - on errorpublic int getMinutesA()
throws YAPI_Exception
YAPI_Exception - on errorpublic int set_minutesA(int newval)
throws YAPI_Exception
newval - : an integer corresponding to the minutes in the 00-29 interval when a wake up must take placeYAPI_Exception - on errorpublic int setMinutesA(int newval)
throws YAPI_Exception
newval - : an integer corresponding to the minutes in the 00-29 interval when a wake up must take placeYAPI_Exception - on errorpublic int get_minutesB()
throws YAPI_Exception
YAPI_Exception - on errorpublic int getMinutesB()
throws YAPI_Exception
YAPI_Exception - on errorpublic int set_minutesB(int newval)
throws YAPI_Exception
newval - : an integer corresponding to the minutes in the 30-59 interval when a wake up must take placeYAPI_Exception - on errorpublic int setMinutesB(int newval)
throws YAPI_Exception
newval - : an integer corresponding to the minutes in the 30-59 interval when a wake up must take placeYAPI_Exception - on errorpublic int get_hours()
throws YAPI_Exception
YAPI_Exception - on errorpublic int getHours()
throws YAPI_Exception
YAPI_Exception - on errorpublic int set_hours(int newval)
throws YAPI_Exception
newval - : an integer corresponding to the hours when a wake up must take placeYAPI_Exception - on errorpublic int setHours(int newval)
throws YAPI_Exception
newval - : an integer corresponding to the hours when a wake up must take placeYAPI_Exception - on errorpublic int get_weekDays()
throws YAPI_Exception
YAPI_Exception - on errorpublic int getWeekDays()
throws YAPI_Exception
YAPI_Exception - on errorpublic int set_weekDays(int newval)
throws YAPI_Exception
newval - : an integer corresponding to the days of the week when a wake up must take placeYAPI_Exception - on errorpublic int setWeekDays(int newval)
throws YAPI_Exception
newval - : an integer corresponding to the days of the week when a wake up must take placeYAPI_Exception - on errorpublic int get_monthDays()
throws YAPI_Exception
YAPI_Exception - on errorpublic int getMonthDays()
throws YAPI_Exception
YAPI_Exception - on errorpublic int set_monthDays(int newval)
throws YAPI_Exception
newval - : an integer corresponding to the days of the month when a wake up must take placeYAPI_Exception - on errorpublic int setMonthDays(int newval)
throws YAPI_Exception
newval - : an integer corresponding to the days of the month when a wake up must take placeYAPI_Exception - on errorpublic int get_months()
throws YAPI_Exception
YAPI_Exception - on errorpublic int getMonths()
throws YAPI_Exception
YAPI_Exception - on errorpublic int set_months(int newval)
throws YAPI_Exception
newval - : an integer corresponding to the months when a wake up must take placeYAPI_Exception - on errorpublic int setMonths(int newval)
throws YAPI_Exception
newval - : an integer corresponding to the months when a wake up must take placeYAPI_Exception - on errorpublic int get_secondsBefore()
throws YAPI_Exception
YAPI_Exception - on errorpublic int getSecondsBefore()
throws YAPI_Exception
YAPI_Exception - on errorpublic int set_secondsBefore(int newval)
throws YAPI_Exception
newval - : an integer corresponding to the number of seconds to anticipate wake-up time to allow
the system to power-upYAPI_Exception - on errorpublic int setSecondsBefore(int newval)
throws YAPI_Exception
newval - : an integer corresponding to the number of seconds to anticipate wake-up time to allow
the system to power-upYAPI_Exception - on errorpublic long get_nextOccurence()
throws YAPI_Exception
YAPI_Exception - on errorpublic long getNextOccurence()
throws YAPI_Exception
YAPI_Exception - on errorpublic static YWakeUpSchedule FindWakeUpSchedule(String func)
func - : a string that uniquely characterizes the wake up schedule, for instance
YHUBGSM5.wakeUpSchedule1.public static YWakeUpSchedule FindWakeUpScheduleInContext(YAPIContext yctx, String func)
yctx - : a YAPI contextfunc - : a string that uniquely characterizes the wake up schedule, for instance
YHUBGSM5.wakeUpSchedule1.public int registerValueCallback(YWakeUpSchedule.UpdateCallback callback)
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.public int _invokeValueCallback(String value)
_invokeValueCallback in class YFunctionpublic long get_minutes()
throws YAPI_Exception
YAPI_Exceptionpublic int set_minutes(long bitmap)
throws YAPI_Exception
bitmap - : Minutes 00-59 of each hour scheduled for wake up.YAPI_Exception - on errorpublic YWakeUpSchedule nextWakeUpSchedule()
public static YWakeUpSchedule FirstWakeUpSchedule()
public static YWakeUpSchedule FirstWakeUpScheduleInContext(YAPIContext yctx)
yctx - : a YAPI context.Copyright © 2026. All rights reserved.