yoctolib-esm
Version:
Yoctopuce library for TypeScript/JavaScript, as an ECMAScript 2015 module
350 lines (349 loc) • 15 kB
TypeScript
/*********************************************************************
*
* $Id: svn_id $
*
* Implements the high-level API for WakeUpSchedule functions
*
* - - - - - - - - - License information: - - - - - - - - -
*
* Copyright (C) 2011 and beyond by Yoctopuce Sarl, Switzerland.
*
* Yoctopuce Sarl (hereafter Licensor) grants to you a perpetual
* non-exclusive license to use, modify, copy and integrate this
* file into your software for the sole purpose of interfacing
* with Yoctopuce products.
*
* You may reproduce and distribute copies of this file in
* source or object form, as long as the sole purpose of this
* code is to interface with Yoctopuce products. You must retain
* this notice in the distributed source file.
*
* You should refer to Yoctopuce General Terms and Conditions
* for additional information regarding your rights and
* obligations.
*
* THE SOFTWARE AND DOCUMENTATION ARE PROVIDED 'AS IS' WITHOUT
* WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING
* WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO
* EVENT SHALL LICENSOR BE LIABLE FOR ANY INCIDENTAL, SPECIAL,
* INDIRECT OR CONSEQUENTIAL DAMAGES, LOST PROFITS OR LOST DATA,
* COST OF PROCUREMENT OF SUBSTITUTE GOODS, TECHNOLOGY OR
* SERVICES, ANY CLAIMS BY THIRD PARTIES (INCLUDING BUT NOT
* LIMITED TO ANY DEFENSE THEREOF), ANY CLAIMS FOR INDEMNITY OR
* CONTRIBUTION, OR OTHER SIMILAR COSTS, WHETHER ASSERTED ON THE
* BASIS OF CONTRACT, TORT (INCLUDING NEGLIGENCE), BREACH OF
* WARRANTY, OR OTHERWISE.
*
*********************************************************************/
import { YAPIContext, YFunction } from './yocto_api.js';
/**
* YWakeUpSchedule Class: wake up schedule control interface, available for instance in the
* YoctoHub-GSM-4G, the YoctoHub-Wireless-SR, the YoctoHub-Wireless-g or the YoctoHub-Wireless-n
*
* The YWakeUpSchedule class implements a wake up condition. The wake up time is
* specified as a set of months and/or days and/or hours and/or minutes when the
* wake up should happen.
*/
export declare class YWakeUpSchedule extends YFunction {
_className: string;
_minutesA: number;
_minutesB: number;
_hours: number;
_weekDays: number;
_monthDays: number;
_months: number;
_secondsBefore: number;
_nextOccurence: number;
_valueCallbackWakeUpSchedule: YWakeUpSchedule.ValueCallback | null;
readonly MINUTESA_INVALID: number;
readonly MINUTESB_INVALID: number;
readonly HOURS_INVALID: number;
readonly WEEKDAYS_INVALID: number;
readonly MONTHDAYS_INVALID: number;
readonly MONTHS_INVALID: number;
readonly SECONDSBEFORE_INVALID: number;
readonly NEXTOCCURENCE_INVALID: number;
static readonly MINUTESA_INVALID: number;
static readonly MINUTESB_INVALID: number;
static readonly HOURS_INVALID: number;
static readonly WEEKDAYS_INVALID: number;
static readonly MONTHDAYS_INVALID: number;
static readonly MONTHS_INVALID: number;
static readonly SECONDSBEFORE_INVALID: number;
static readonly NEXTOCCURENCE_INVALID: number;
constructor(yapi: YAPIContext, func: string);
imm_parseAttr(name: string, val: any): number;
/**
* Returns the minutes in the 00-29 interval of each hour scheduled for wake up.
*
* @return an integer corresponding to the minutes in the 00-29 interval of each hour scheduled for wake up
*
* On failure, throws an exception or returns YWakeUpSchedule.MINUTESA_INVALID.
*/
get_minutesA(): Promise<number>;
/**
* Changes the minutes in the 00-29 interval when a wake up must take place.
* Remember to call the saveToFlash() method of the module if the
* modification must be kept.
*
* @param newval : an integer corresponding to the minutes in the 00-29 interval when a wake up must take place
*
* @return YAPI.SUCCESS if the call succeeds.
*
* On failure, throws an exception or returns a negative error code.
*/
set_minutesA(newval: number): Promise<number>;
/**
* Returns the minutes in the 30-59 interval of each hour scheduled for wake up.
*
* @return an integer corresponding to the minutes in the 30-59 interval of each hour scheduled for wake up
*
* On failure, throws an exception or returns YWakeUpSchedule.MINUTESB_INVALID.
*/
get_minutesB(): Promise<number>;
/**
* Changes the minutes in the 30-59 interval when a wake up must take place.
* Remember to call the saveToFlash() method of the module if the
* modification must be kept.
*
* @param newval : an integer corresponding to the minutes in the 30-59 interval when a wake up must take place
*
* @return YAPI.SUCCESS if the call succeeds.
*
* On failure, throws an exception or returns a negative error code.
*/
set_minutesB(newval: number): Promise<number>;
/**
* Returns the hours scheduled for wake up.
*
* @return an integer corresponding to the hours scheduled for wake up
*
* On failure, throws an exception or returns YWakeUpSchedule.HOURS_INVALID.
*/
get_hours(): Promise<number>;
/**
* Changes the hours when a wake up must take place.
* Remember to call the saveToFlash() method of the module if the
* modification must be kept.
*
* @param newval : an integer corresponding to the hours when a wake up must take place
*
* @return YAPI.SUCCESS if the call succeeds.
*
* On failure, throws an exception or returns a negative error code.
*/
set_hours(newval: number): Promise<number>;
/**
* Returns the days of the week scheduled for wake up.
*
* @return an integer corresponding to the days of the week scheduled for wake up
*
* On failure, throws an exception or returns YWakeUpSchedule.WEEKDAYS_INVALID.
*/
get_weekDays(): Promise<number>;
/**
* Changes the days of the week when a wake up must take place.
* Remember to call the saveToFlash() method of the module if the
* modification must be kept.
*
* @param newval : an integer corresponding to the days of the week when a wake up must take place
*
* @return YAPI.SUCCESS if the call succeeds.
*
* On failure, throws an exception or returns a negative error code.
*/
set_weekDays(newval: number): Promise<number>;
/**
* Returns the days of the month scheduled for wake up.
*
* @return an integer corresponding to the days of the month scheduled for wake up
*
* On failure, throws an exception or returns YWakeUpSchedule.MONTHDAYS_INVALID.
*/
get_monthDays(): Promise<number>;
/**
* Changes the days of the month when a wake up must take place.
* Remember to call the saveToFlash() method of the module if the
* modification must be kept.
*
* @param newval : an integer corresponding to the days of the month when a wake up must take place
*
* @return YAPI.SUCCESS if the call succeeds.
*
* On failure, throws an exception or returns a negative error code.
*/
set_monthDays(newval: number): Promise<number>;
/**
* Returns the months scheduled for wake up.
*
* @return an integer corresponding to the months scheduled for wake up
*
* On failure, throws an exception or returns YWakeUpSchedule.MONTHS_INVALID.
*/
get_months(): Promise<number>;
/**
* Changes the months when a wake up must take place.
* Remember to call the saveToFlash() method of the module if the
* modification must be kept.
*
* @param newval : an integer corresponding to the months when a wake up must take place
*
* @return YAPI.SUCCESS if the call succeeds.
*
* On failure, throws an exception or returns a negative error code.
*/
set_months(newval: number): Promise<number>;
/**
* Returns the number of seconds to anticipate wake-up time to allow
* the system to power-up.
*
* @return an integer corresponding to the number of seconds to anticipate wake-up time to allow
* the system to power-up
*
* On failure, throws an exception or returns YWakeUpSchedule.SECONDSBEFORE_INVALID.
*/
get_secondsBefore(): Promise<number>;
/**
* Changes the number of seconds to anticipate wake-up time to allow
* the system to power-up.
* Remember to call the saveToFlash() method of the module if the
* modification must be kept.
*
* @param newval : an integer corresponding to the number of seconds to anticipate wake-up time to allow
* the system to power-up
*
* @return YAPI.SUCCESS if the call succeeds.
*
* On failure, throws an exception or returns a negative error code.
*/
set_secondsBefore(newval: number): Promise<number>;
/**
* Returns the date/time (seconds) of the next wake up occurrence.
*
* @return an integer corresponding to the date/time (seconds) of the next wake up occurrence
*
* On failure, throws an exception or returns YWakeUpSchedule.NEXTOCCURENCE_INVALID.
*/
get_nextOccurence(): Promise<number>;
/**
* Retrieves a wake up schedule for a given identifier.
* The identifier can be specified using several formats:
*
* - FunctionLogicalName
* - ModuleSerialNumber.FunctionIdentifier
* - ModuleSerialNumber.FunctionLogicalName
* - ModuleLogicalName.FunctionIdentifier
* - ModuleLogicalName.FunctionLogicalName
*
*
* This function does not require that the wake up schedule is online at the time
* it is invoked. The returned object is nevertheless valid.
* Use the method YWakeUpSchedule.isOnline() to test if the wake up schedule is
* indeed online at a given time. In case of ambiguity when looking for
* a wake up schedule 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.
*
* @param func : a string that uniquely characterizes the wake up schedule, for instance
* YHUBGSM5.wakeUpSchedule1.
*
* @return a YWakeUpSchedule object allowing you to drive the wake up schedule.
*/
static FindWakeUpSchedule(func: string): YWakeUpSchedule;
/**
* Retrieves a wake up schedule for a given identifier in a YAPI context.
* The identifier can be specified using several formats:
*
* - FunctionLogicalName
* - ModuleSerialNumber.FunctionIdentifier
* - ModuleSerialNumber.FunctionLogicalName
* - ModuleLogicalName.FunctionIdentifier
* - ModuleLogicalName.FunctionLogicalName
*
*
* This function does not require that the wake up schedule is online at the time
* it is invoked. The returned object is nevertheless valid.
* Use the method YWakeUpSchedule.isOnline() to test if the wake up schedule is
* indeed online at a given time. In case of ambiguity when looking for
* a wake up schedule 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.
*
* @param yctx : a YAPI context
* @param func : a string that uniquely characterizes the wake up schedule, for instance
* YHUBGSM5.wakeUpSchedule1.
*
* @return a YWakeUpSchedule object allowing you to drive the wake up schedule.
*/
static FindWakeUpScheduleInContext(yctx: YAPIContext, func: string): YWakeUpSchedule;
/**
* 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.
*
* @param 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.
* @noreturn
*/
registerValueCallback(callback: YWakeUpSchedule.ValueCallback | null): Promise<number>;
_invokeValueCallback(value: string): Promise<number>;
/**
* Returns all the minutes of each hour that are scheduled for wake up.
*/
get_minutes(): Promise<number>;
/**
* Changes all the minutes where a wake up must take place.
*
* @param bitmap : Minutes 00-59 of each hour scheduled for wake up.
*
* @return YAPI.SUCCESS if the call succeeds.
*
* On failure, throws an exception or returns a negative error code.
*/
set_minutes(bitmap: number): Promise<number>;
/**
* Continues the enumeration of wake up schedules started using yFirstWakeUpSchedule().
* Caution: You can't make any assumption about the returned wake up schedules order.
* If you want to find a specific a wake up schedule, use WakeUpSchedule.findWakeUpSchedule()
* and a hardwareID or a logical name.
*
* @return a pointer to a YWakeUpSchedule object, corresponding to
* a wake up schedule currently online, or a null pointer
* if there are no more wake up schedules to enumerate.
*/
nextWakeUpSchedule(): YWakeUpSchedule | null;
/**
* Starts the enumeration of wake up schedules currently accessible.
* Use the method YWakeUpSchedule.nextWakeUpSchedule() to iterate on
* next wake up schedules.
*
* @return a pointer to a YWakeUpSchedule object, corresponding to
* the first wake up schedule currently online, or a null pointer
* if there are none.
*/
static FirstWakeUpSchedule(): YWakeUpSchedule | null;
/**
* Starts the enumeration of wake up schedules currently accessible.
* Use the method YWakeUpSchedule.nextWakeUpSchedule() to iterate on
* next wake up schedules.
*
* @param yctx : a YAPI context.
*
* @return a pointer to a YWakeUpSchedule object, corresponding to
* the first wake up schedule currently online, or a null pointer
* if there are none.
*/
static FirstWakeUpScheduleInContext(yctx: YAPIContext): YWakeUpSchedule | null;
}
export declare namespace YWakeUpSchedule {
interface ValueCallback {
(func: YWakeUpSchedule, value: string): void;
}
}