alarm – Alarms and sleep

Provides alarms that trigger based on time intervals or on external events, such as pin changes. The program can simply wait for these alarms, or go to sleep and be awoken when they trigger.

There are two supported levels of sleep: light sleep and deep sleep.

Light sleep keeps sufficient state so the program can resume after sleeping. It does not shut down WiFi, BLE, or other communications, or ongoing activities such as audio playback. It reduces power consumption to the extent possible that leaves these continuing activities running. In some cases there may be no decrease in power consumption.

Deep sleep shuts down power to nearly all of the microcontroller including the CPU and RAM. This can save a more significant amount of power, but CircuitPython must restart code.py from the beginning when awakened.

For both light sleep and deep sleep, if CircuitPython is connected to a host computer, maintaining the connection takes priority and power consumption may not be reduced.

alarm.sleep_memory :SleepMemory

Memory that persists during deep sleep. This object is the sole instance of alarm.SleepMemory.

alarm.wake_alarm :_typing.Alarm

The most recently triggered alarm. If CircuitPython was sleeping, the alarm the woke it from sleep.

alarm.light_sleep_until_alarms(*alarms: _typing.Alarm)_typing.Alarm

Go into a light sleep until awakened one of the alarms. The alarm causing the wake-up is returned, and is also available as alarm.wake_alarm.

If no alarms are specified, return immediately.

If CircuitPython is connected to a host computer, the connection will be maintained, and the microcontroller may not actually go into a light sleep. This allows the user to interrupt an existing program with ctrl-C, and to edit the files in CIRCUITPY, which would not be possible in true light sleep. Thus, to use light sleep and save significant power,

alarm.exit_and_deep_sleep_until_alarms(*alarms: _typing.Alarm)None

Exit the program and go into a deep sleep, until awakened by one of the alarms. This function does not return.

When awakened, the microcontroller will restart and will run boot.py and code.py from the beginning.

After restart, an alarm equivalent to the one that caused the wake-up will be available as alarm.wake_alarm. Its type and/or attributes may not correspond exactly to the original alarm. For time-base alarms, currently, an alarm.time.TimeAlarm() is created.

If no alarms are specified, the microcontroller will deep sleep until reset.

If CircuitPython is connected to a host computer, the connection will be maintained, and the system will not go into deep sleep. This allows the user to interrupt an existing program with ctrl-C, and to edit the files in CIRCUITPY, which would not be possible in true deep sleep. Thus, to use deep sleep and save significant power, you will need to disconnect from the host.

Here is skeletal example that deep-sleeps and restarts every 60 seconds:

import alarm
import time

print("Waking up")

# Set an alarm for 60 seconds from now.
time_alarm = alarm.time.TimeAlarm(monotonic_time=time.monotonic() + 60)

# Deep sleep until the alarm goes off. Then restart the program.
alarm.exit_and_deep_sleep_until_alarms(time_alarm)
class alarm.SleepMemory

Store raw bytes in RAM that persists during deep sleep. The class acts as a bytearray. If power is lost, the memory contents are lost.

Note that this class can’t be imported and used directly. The sole instance of SleepMemory is available at alarm.sleep_memory.

Usage:

import alarm
alarm.sleep_memory[0] = True
alarm.sleep_memory[1] = 12

Not used. Access the sole instance through alarm.sleep_memory.

__bool__(self)bool

sleep_memory is True if its length is greater than zero. This is an easy way to check for its existence.

__len__(self)int

Return the length. This is used by (len)

__getitem__(self, index: slice)bytearray
__getitem__(self, index: int)int

Returns the value at the given index.

__setitem__(self, index: slice, value: _typing.ReadableBuffer)None
__setitem__(self, index: int, value: int)None

Set the value at the given index.