Arduino Quick Start
2. Devices & Examples
3. M5Unified
4. M5GFX
5. Extensions
Unit
Base
Cap
IoT
Accessories
StickS3 Wakeup
StickS3 sleep/wakeup related APIs and example program.
Example
Compilation Requirements
- M5Stack Board Manager version >= 3.2.5
- Development board option = M5StickS3
- M5Unified library version >= 0.2.12
- M5GFX library version >= 0.2.18
cpp
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
#include "M5Unified.h"
void setup(void) {
M5.begin();
M5.Display.setTextDatum(middle_center);
M5.Display.setTextFont(&fonts::FreeMonoBoldOblique9pt7b);
M5.Display.setRotation(1);
M5.Display.drawString("BtnA to Sleep 5s", M5.Display.width() / 2, M5.Display.height() / 2);
}
void loop(void) {
M5.update();
if (M5.BtnA.wasPressed()) {
M5.Display.clear();
M5.Power.timerSleep(5);//sec
}
}The example program runs as follows:
API
The power management part of StickS3 uses the Power_Class from the M5Unified library. For more related APIs, you can refer to the following documentation:
PMIC Timer Wakeup
StickS3 can be driven using the M5PM1 Arduino Library, enabling timed device wake-up through the PMIC. In this mode, power to peripherals such as the ESP32-S3 can be shut off, resulting in lower power consumption.
For more tutorials on using the StickS3 PMIC, please refer to StickS3 PMIC Configuration.
Compilation Requirements
- M5Stack Board Manager version >= 3.2.5
- Development board option = M5StickS3
- M5Unified library version >= 0.2.12
- M5GFX library version >= 0.2.18
- M5PM1 library version >= 1.0.1
Description: After the device is powered on, press button A to configure a 10-second timer to trigger a wake-up.
cpp
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
#include <M5Unified.h>
#include <M5PM1.h>
#include <Wire.h>
M5PM1 pm1;
void setup(void)
{
M5.begin();
M5.Display.setRotation(1);
Serial.begin(115200);
auto pin_num_sda = M5.getPin(m5::pin_name_t::in_i2c_sda);
auto pin_num_scl = M5.getPin(m5::pin_name_t::in_i2c_scl);
M5_LOGI("getPin: SDA:%u SCL:%u", pin_num_sda, pin_num_scl);
Wire.end();
Wire.begin(pin_num_sda, pin_num_scl, 100000U);
// Initialize PM1
m5pm1_err_t err = pm1.begin(&Wire, M5PM1_DEFAULT_ADDR, pin_num_sda, pin_num_scl, M5PM1_I2C_FREQ_100K);
if (err == M5PM1_OK) {
Serial.println("PM1 initialization successful");
} else {
Serial.printf("PM1 initialization failed, error code: %d\n", err);
}
M5.Display.fillScreen(BLACK);
M5.Display.setTextSize(2);
M5.Display.setTextColor(WHITE);
M5.Display.setCursor(0, 10);
M5.Display.println("Timer Power Test");
M5.Display.println("BtnA: After 10s Wakeup");
}
void loop(void)
{
M5.update();
if (M5.BtnA.wasPressed()) {
M5.Display.fillScreen(BLACK);
M5.Display.setCursor(0, 10);
M5.Display.println("Shutdown");
M5.Display.println("After 10s");
M5.Display.println("Wakeup");
delay(1000);
pm1.timerSet(10, M5PM1_TIM_ACTION_POWERON);
}
}