Skip to main content

server.sleepfor(sleepTime)

Disconnects the imp from WiFi and puts it into a deep sleep state for the specified duration

Availability

Device

Parameters

Name Type Description
sleepTime Integer The deep sleep duration in seconds (0—2,419,198)

Returns

Nothing — does not return

Description

This method causes the imp to enter a very low power mode (‘deep sleep’) and stop executing code for the specified period of time — or until the wake-up pin is triggered, if it has been activated. While the imp is in deep sleep, WiFi is disabled.

When the imp enters deep sleep, the execution of Squirrel code is stopped entirely. When the imp wakes up, your device code is loaded from the imp’s flash storage and restarted. No state data is preserved, with the exception of the special nv table, which will be maintained. The nv table is not preserved through a power-cycle.

In deep sleep, all of the imp’s pins are tri-stated, unless you have enabled pin 1 (imp001, imp002) or pin W (imp003) as the wake-up pin. The wake-up pin (and only the wake-up pin) has a weak pull-down.

The maximum sleep time is 2,419,198 seconds (28 days minus two seconds).

Deep sleep mode draws approximately 6μA of current on the imp001 card, or 4μA on the imp002 module. The processor is effectively shut down. Upon waking from deep sleep, the device will be in a ‘warm boot’ state with code execution returning to the start of the script. Booting and reconnecting to WiFi will take a second or more, so this method may not be appropriate for very short sleep periods.

It is recommended practice to call server.sleepfor() only when the imp is idle, ie. when any data that your device needs to send to the server has been sent. This is best achieved by incorporating your server.sleepfor() code in a function that is registered to called when the imp goes idle. To do so, use the method imp.onidle():

imp.onidle(function(){
    server.sleepfor(3600);
});

This snippet of code can be used to wake up every hour, on the hour:

imp.onidle(function(){
    server.sleepfor(3600 - (time() % 3600));
});

Module-specific Information

imp003

This method is not available on imp003-based devices with no 32kHz crystal and running impOS 34 and up. The method’s presence can be used to indicate whether or not a crystal has been detected:

if ("sleepfor" in server) {
    // imp has a 32kHz xtal 
}

imp004m

This method is not available on imp004m-based devices with no 32kHz crystal and running impOS 34 and up.

You will not be able to preserve data in the nv table during sleep. This is because the imp004m does not implement nv table functionality. Please see ‘Designing Hardware With The imp004m’ for possible workarounds.

imp005

imp005 devices are not currently capable of deep sleep, so server.sleepfor() has been removed from the imp005. Customers using this call to cause a device reset will now find that its use causes a Squirrel runtime error instead.

Example Code

This example demonstrates how to get the imp to wake up once an hour, log some data (in this case, voltage), store it in its non-volatile memory, then go back to sleep.