Toit
Libraries
bignum
binary
bitmap
ble
bytes
core
crypto
device
ec618
encoding
esp32
expect
fixed-point
flash
font
gpio
i2c
i2s
icons
io
line-wrap
log
math
monitor
net
pulse-counter
reader
reader-writer
rmt
serial
spi
statistics
system
tls
uart
uuid
writer
zlib

Library esp32

To use this library in your code:

import esp32
ESP32 related functionality.

Classes

PmLock
The ESP32 power management lock.

Globals

DEEP-SLEEP-MIN-DURATION
The shortest duration supported by deep-sleep.
ESP-RST-EXT
Deprecated. Use RESET-EXTERNAL.
ESP-RST-PANIC
Deprecated. Use RESET-PANIC.
ESP-RST-SDIO
Deprecated. Use RESET-SDIO.
ESP-RST-SW
Deprecated. Use RESET-SOFTWARE.
RESET-BROWNOUT
Brownout reset (software or hardware).
RESET-CPU-LOCKUP
Reset due to a CPU lock up.
RESET-DEEPSLEEP
Reset after exiting deep sleep.
RESET-EFUSE
Reset due to an efuse error.
RESET-EXTERNAL
Reset due to external pin. (Not applicable to the ESP32).
Also see WAKEUP-EXT1.
RESET-INTERRUPT-WATCHDOG
Reset (software or hardware) due to the interrupt watchdog.
RESET-JTAG
Reset by JTAG.
RESET-OTHER-WATCHDOG
Reset due to an other (non interrupt or task) watchdog.
RESET-PANIC
Reset due to an exception or a panic.
RESET-POWER-GLITCH
Reset because a power glitch was detected.
RESET-POWER-ON
Reset due to power-on.
RESET-SDIO
Reset over SDIO (secure digital input output).
RESET-SOFTWARE
Reset via esp_restart.
RESET-TASK-WATCHDOG
Reset due to the task watchdog.
RESET-UNKNOWN
Unknown reset reason.
RESET-USB
Reset by the USB peripheral.
RTC-MEMORY-SIZE
Size of the user accessible RTC memory.
Deprecated.
WAKEUP-ALL
This constant isn't a wakeup cause, but is used to disable all wakeup sources with esp_sleep_disable_wakeup_source.
WAKEUP-EXT0
Wakeup caused by an external signal using RTC_IO.
WAKEUP-EXT1
Wakeup caused by external signal using RTC_CNTL.
WAKEUP-GPIO
Wakeup caused by GPIO (light sleep only).
WAKEUP-TIMER
Wakeup caused by timer.
WAKEUP-TOUCHPAD
Wakeup caused by the touchpad.
WAKEUP-UART
Wakeup caused by UART (light sleep only).
WAKEUP-ULP
Wakeup caused by the ULP program.
WAKEUP-UNDEFINED
Undefined wakeup.
In case of deep sleep, the reset was not caused by exit from deep sleep.

Functions

adjust-real-time-clock adjustment/Duration -> none
Adjusts the real-time clock with the specified adjustment.
The adjustment may not be visible immediately through calls to Time.now in case techniques like time smearing are used to prevent large jumps in time.
deep-sleep duration/Duration -> none
Enters deep sleep for the specified duration (up to 24h) and does not return. Exiting deep sleep causes the ESP32 to start over from main.
Durations shorter than DEEP-SLEEP-MIN-DURATION are increased to that duration. Use reset instead when no sleep is intended.
If you need to deep sleep for longer than 24h, you can chain multiple deep sleeps.
If the ESP32 wakes up due to the duration expiring, then reset-reason is set to RESET-DEEPSLEEP and the wakeup-cause is set to WAKEUP-TIMER.
dump-heap -> none
Sends (as a system message) a detailed report over the usage of memory at the OS level.
enable-external-wakeup pin-mask/int on-any-high/bool -> none
Sets the ESP32 to wake up from deep sleep if the GPIO pins in pin-mask matches the mode.
The pin-mask is a bit mask of the pins to monitor.
If the ESP32 wakes up due to the GPIO pins, then reset-reason is set to RESET-DEEPSLEEP and wakeup-cause is set to WAKEUP-EXT1.
If on-any-high is true, the ESP32 will wake up if any pin in the mask is high.
If on-any-high is false, then the behavior depends on the chip. An ESP32 will wake up if *all* pins in the mask are low. All other chips wake up if *any* pin in the mask is low.
The following GPIO pins can be used:
  • ESP32: 0, 2, 4, 12-15, 25-27, 32-39
  • ESP32-S2: 0-21
  • ESP32-S3: 0-21
Support for the ESP32-C3 is not yet implemented.
Examples
Wake up when GPIO pin 33 goes high:

esp32.enable-external-wakeup (1 << 33) true
enable-touchpad-wakeup -> none
Enables waking up from touchpad triggers.
The ESP32 wakes up if any configured pin has its value drop below their threshold.
Use touchpad-wakeup-status to find which pin has triggered the wakeup.
If the ESP32 wakes up due to the touchpad, then reset-reason is set to RESET-DEEPSLEEP and wakeup-cause is set to WAKEUP-TOUCHPAD.
mac-address -> ByteArray
The WiFi MAC address of the ESP32.
memory-page-report -> none
Sends (as a system message) a report over the usage of memory at the OS level.
pm-configure --min-frequency-mhz/int --max-frequency-mhz/int --enable-light-sleep/bool -> none
Sets the power management configuration.
See the documentation for the ESP32 power management for more details.
https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-reference/system/power_management.html
pm-light-sleep-enabled -> bool
Returns whether the current power management has light-sleep enabled.
pm-max-frequency-mhz -> int
Returns the current power management max-frequency in MHz.
pm-min-frequency-mhz -> int
Returns the current power management min-frequency in MHz.
reset -> none
Resets the ESP32 and does not return.
After restarting, reset-reason is RESET-SOFTWARE and wakeup-cause is WAKEUP-UNDEFINED.
reset-reason -> int
One of the RESET-* enum values (such as RESET-POWER-ON) that indicates why the ESP32 was reset.
rtc-user-bytes -> ByteArray
Constructs a ByteArray backed by the RTC user data.
Deprecated. Use storage.Bucket instead.
Advanced
RTC memory is volatile memory that is powered during deep sleep. RTC memory is random access and significantly faster than flash memory.
It is recommended to ensure the integrity of the stored data with a checksum.
There is only one RTC memory on the device, so all tasks or processes have access to the same RTC memory.
set-real-time-clock time/Time -> none
Sets the real-time clock to the new time.
The new time is visible immediately through calls to Time.now.
total-deep-sleep-time -> int
Returns the total number of microseconds this device has been in deep sleep.
total-run-time -> int
Returns the total number of microseconds this device has been running (including deep sleep).
touchpad-wakeup-status -> int
Returns the pin number that triggered the wakeup.
Returns -1 if the wakeup wasn't caused by a touchpad.
wakeup-cause -> int
One of the WAKEUP-* enum values (such as WAKEUP-TIMER) that indicates why the ESP32 was woken up from deep sleep.
watchdog-deinit -> none
Disables the watchdog timer.
watchdog-init --ms/int -> none
Initializes the watchdog timer.
If there is an interval of ms milliseconds between calls to watchdog-reset, the ESP32 will reset.
Use watchdog-deinit to disable the watchdog timer.
watchdog-reset -> none
Resets the watchdog timer.
See watchdog-init.