09. Sleep
The sleep object is a built-in object that provides power saving features.
Functional overview:
- Supports stop mode.
- Supports standby mode.
- Provides the function of reading and writing data to the backup RAM.
For details on each power saving mode, refer to Script Execution Mode.
The backup RAM is the memory that retains the set value even if the power saving mode is entered, as long as power is supplied. If power supply stops, the set value will be lost.
sleep Global Object
| Methods()/Properties | Summary | Version | Note |
|---|---|---|---|
| sleep.setStopSync() | Immediately transitions to power saving stop mode. | 00.00.15+ | |
| sleep.setStop() | Transitions to the power saving stop mode. | 00.00.15+ | |
| sleep.setStandbySync() | Immediately transitions to power saving standby mode. | 00.00.15+ | |
| sleep.setStandby() | Transitions to the power saving standby mode. | 00.00.15+ | |
| sleep.getEntryResumeControl() | Gets the resumeFlag value that was set immediately before. | 00.00.15+ | |
| sleep.setUserRegister() | Saves any value to the backup RAM. | 00.00.15+ | |
| sleep.getUserRegister() | Gets the value stored in backup RAM. | 00.00.15+ |
Details
sleep.setStopSync(rtcAlarm)
Immediately transitions to power saving stop mode.
Make an immediate transition in this method.
| Name | Type | M/O | Summary | Note |
|---|---|---|---|---|
| rtcAlarm | Object | mandatory | Time to return (resume) from stop mode hour : {number} Alarm occurrence time [hour] Range: 0 - 23 (*1) minute : {number} Alarm occurrence time [minutes] Range: 0 - 59 (*1) second : {number} Alarm occurrence time [second] Range: 0 - 59 (*1) | |
| return | undefined | - | - | When an error occurs, an exception is raised. |
*1: If you set all to -1, the stop mode continues. In that case, you can resume from the wakeup trigger or user switch.
sleep.setStop(rtcAlarm[,callback])
Transitions to the power saving stop mode.
At the time of transition, disconnect the network session and execute the callback process immediately before the transition and immediately after returning.
| Name | Type | M/O | Summary | Note |
|---|---|---|---|---|
| rtcAlarm | Object | mandatory | Time to return (resume) from stop mode hour : {number} Alarm occurrence time [hour] Range: 0 - 23 (*1) minute : {number} Alarm occurrence time [minutes] Range: 0 - 59 (*1) second : {number} Alarm occurrence time [second] Range: 0 - 59 (*1) | |
| callback(flag) | function | optional | Executes callback processing when an event occurs. flag : {number} Indicates the event content. 0: Immediately before transition to stop mode 1: Immediately after returning from stop mode | |
| return | undefined | - | - | When an error occurs, an exception is raised. |
*1: If you set all to -1, the stop mode continues. In that case, you can resume from the wakeup trigger or user switch.
sleep.setStandbySync(rtcAlarm,resumeFlag)
Immediately transitions to power saving standby mode.
Make an immediate transition in this method.
| Name | Type | M/O | Summary | Note |
|---|---|---|---|---|
| rtcAlarm | Object | mandatory | Time to return (resume) from standby mode hour : {number} Alarm occurrence time [hour] Range: 0 - 23 (*1) minute : {number} Alarm occurrence time [minutes] Range: 0 - 59 (*1) second : {number} Alarm occurrence time [second] Range: 0 - 59 (*1) | |
| resumeFlag | number | mandatory | Specify the operation at resume. 0: Resume as normal operation Other than 0: Fast resume without network preparation | |
| return | undefined | - | - | When an error occurs, an exception is raised. |
*1:If you set all to -1, the standby mode continues. In that case, you can resume from the wakeup trigger or user switch. In the case of the user switch, it will be forcibly resumed as normal operation regardless of the resumeFlag setting.
sleep.setStandby(rtcAlarm,resumeFlag[,callback()])
Transitions to the power saving standby mode.
At the transition, disconnect the network session and execute the callback process just before the transition.
| Name | Type | M/O | Summary | Note |
|---|---|---|---|---|
| rtcAlarm | Object | mandatory | Time to return (resume) from standby mode hour : {number} Alarm occurrence time [hour] Range: 0 - 23 (*1) minute : {number} Alarm occurrence time [minutes] Range: 0 - 59 (*1) second : {number} Alarm occurrence time [second] Range: 0 - 59 (*1) | |
| resumeFlag | number | mandatory | Specify the operation at resume. 0: Resume as normal operation Other than 0: Fast resume without network preparation | |
| callback() | function | optional | Executes callback processing before transition to standby mode. | |
| return | undefined | - | - | When an error occurs, an exception is raised. |
*1: If you set all to -1, the standby mode continues. In that case, you can resume from the wakeup trigger or user switch. In the case of the user switch, it will be forcibly resumed as normal operation regardless of the resumeFlag setting.
sleep.getEntryResumeControl()
Gets the resumeFlag value that was set immediately before.
| Name | Type | M/O | Summary | Note |
|---|---|---|---|---|
| return | number | - | resumeFlag value | Values other than 0 are rounded to 1. |
sleep.setUserRegister(userValue)
Saves any value to the backup RAM.
It can be used for general purposes.
| Name | Type | M/O | Summary | Note |
|---|---|---|---|---|
| userValue | number | mandatory | Any value Range: 0 - 65535 (0x0000 - 0xFFFF) | |
| return | undefined | - | - |
sleep.getUserRegister()
Gets the value stored in backup RAM.
| Name | Type | M/O | Summary | Note |
|---|---|---|---|---|
| return | number | - | Read value | If power supply stops and the value is lost, or if the value is not set, it will be 0. |
Object Usage Examples
Sample 1
This is a sample in stop mode.
Sleep and resume are repeated based on the current time.
var MAX_COUNT = 10;
var count = MAX_COUNT;
while(count-- > 0){
print('Hello stop-mode');
var set_date = new Date();
print('Now time: ' + set_date.toString());
set_date.setSeconds(set_date.getSeconds() + 30);
var rtc_time = {hour: set_date.getHours(), minute: set_date.getMinutes(),
second: set_date.getSeconds()};
sleep.setStopSync(rtc_time); //Transition to stop mode
print(Date() + ': resume!!!' + 'count=' + count ); //Executed after returning from stop mode
}
Sample 2
This is a sample in standby mode.
Sleep and resume are repeated based on the current time.
var now_count = sleep.getUserRegister();
var entry_resume = sleep.getEntryResumeControl();
print('entry resume cont.=' + entry_resume);
var MAX_COUNT = 5;
var delay_s = 10;
var set_count;
var now_date = new Date();
print('Now time: ' + now_date.toString());
now_date.setSeconds(now_date.getSeconds() + delay_s);
print('Set time: ' + now_date.toString());
var rtc_time = {hour: now_date.getHours(), minute: now_date.getMinutes(),
second: now_date.getSeconds()};
if (entry_resume == 0){
set_count = MAX_COUNT;
}else{
print(Date() + ': resume!!!');
set_count = --now_count;
}
sleep.setUserRegister(set_count);
if (set_count != 0){
sleep.setStandby(rtc_time, 1, function(){
print('standby ready');
});
}else{
print('Sleep Finish:');
}