简体中文
English
简体中文
日本語

Arduino 上手教程

2. 设备开发 & 案例程序

5. 扩展模块

6. 应用案例

PaperMono RTC 实时时钟

PaperMono RTC 实时时钟相关 API 与案例程序。

案例程序

编译要求

  • M5Stack 板管理版本 >= 3.3.9
  • 开发板选项 = M5PaperMono
  • M5Unified 库版本 >= 0.2.20
  • M5GFX 库版本 >= 0.2.27

手动设置 RTC 时间

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 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
#include <M5Unified.h>

M5Canvas canvas(&M5.Display);
static constexpr const char* const wd[7] = {"Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"};
static int last_drawn_minute = -1;

void drawScreen(const m5::rtc_datetime_t& dt)
{
    const int w = M5.Display.width();
    const int h = M5.Display.height();

    char dateText[32];
    char timeText[16];
    snprintf(dateText, sizeof(dateText), "%04d/%02d/%02d", dt.date.year, dt.date.month, dt.date.date);
    snprintf(timeText, sizeof(timeText), "%02d:%02d", dt.time.hours, dt.time.minutes);

    canvas.fillSprite(TFT_WHITE);
    canvas.setTextColor(TFT_BLACK);
    canvas.setTextDatum(top_center);

    canvas.setFont(&fonts::FreeSansBold18pt7b);
    canvas.drawString("PaperMono RTC Test", w / 2, 24);

    canvas.setFont(&fonts::FreeSansBold24pt7b);
    canvas.setTextSize(1);
    canvas.drawString(timeText, w / 2, h / 2 - 80);

    canvas.setTextSize(1);
    canvas.setFont(&fonts::FreeSansBold18pt7b);
    canvas.drawString(dateText, w / 2, h / 2 + 48);
    canvas.drawString(wd[dt.date.weekDay], w / 2, h / 2 + 94);

    canvas.pushSprite(0, 0);
}

void drawErrorScreen(const char* message)
{
    const int w = M5.Display.width();
    const int h = M5.Display.height();

    canvas.fillSprite(TFT_WHITE);
    canvas.setTextDatum(middle_center);
    canvas.setTextColor(TFT_BLACK);
    canvas.setFont(&fonts::FreeSansBold18pt7b);
    canvas.drawString("PaperMono RTC Test", w / 2, h / 2 - 48);
    canvas.drawString(message, w / 2, h / 2 + 36);
    canvas.pushSprite(0, 0);
}

void setup()
{
    auto cfg = M5.config();
    cfg.clear_display = false;
    M5.begin(cfg);
    M5.Display.setRotation(0);
    M5.Display.setEpdMode(epd_mode_t::epd_text);

    canvas.createSprite(M5.Display.width(), M5.Display.height());

    if (!M5.Rtc.isEnabled()) {
        drawErrorScreen("RTC not found");
        while (true) {
            delay(1000);
        }
    }

    M5.Rtc.setDateTime({{2026, 8, 18}, {12, 0, 0}});

    const auto dt = M5.Rtc.getDateTime();
    drawScreen(dt);
    last_drawn_minute = dt.time.minutes;
}

void loop()
{
    M5.update();
    const auto dt = M5.Rtc.getDateTime();
    if (dt.time.minutes != last_drawn_minute) {
        last_drawn_minute = dt.time.minutes;
        drawScreen(dt);
    }
    delay(100);
}

SNTP 网络时间

说明
使用时请将 ssidpassword 替换为实际的 Wi-Fi 名称和密码。
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 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
#include <Arduino.h>
#include <M5GFX.h>
#include <M5Unified.h>
#include <WiFi.h>
#include <esp_sntp.h>
#include <sntp.h>

#define NTP_TIMEZONE "UTC-8"
#define NTP_SERVER1  "0.pool.ntp.org"
#define NTP_SERVER2  "1.pool.ntp.org"
#define NTP_SERVER3  "2.pool.ntp.org"

static constexpr uint32_t WIFI_CONNECT_TIMEOUT_MS = 20000;
static constexpr uint32_t SNTP_SYNC_TIMEOUT_MS    = 30000;

M5Canvas canvas(&M5.Display);

const char* ssid     = "ssid";
const char* password = "password";

static constexpr const char* const wd[7] = {"Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"};
static int last_drawn_minute = -1;

void drawScreen(const m5::rtc_datetime_t& dt)
{
    const int w = M5.Display.width();
    const int h = M5.Display.height();

    char dateText[32];
    char timeText[16];
    snprintf(dateText, sizeof(dateText), "%04d/%02d/%02d", dt.date.year, dt.date.month, dt.date.date);
    snprintf(timeText, sizeof(timeText), "%02d:%02d", dt.time.hours, dt.time.minutes);

    canvas.fillSprite(TFT_WHITE);
    canvas.setTextColor(TFT_BLACK);
    canvas.setTextDatum(top_center);

    canvas.setFont(&fonts::FreeSansBold18pt7b);
    canvas.drawString("PaperMono RTC Test", w / 2, 24);
    canvas.drawString("SNTP", w / 2, 70);

    canvas.setFont(&fonts::FreeSansBold24pt7b);
    canvas.setTextSize(1);
    canvas.drawString(timeText, w / 2, h / 2 - 80);

    canvas.setFont(&fonts::FreeSansBold18pt7b);
    canvas.drawString(dateText, w / 2, h / 2 + 48);
    canvas.drawString(wd[dt.date.weekDay], w / 2, h / 2 + 94);

    canvas.pushSprite(0, 0);
}

void drawSyncScreen()
{
    const int w = M5.Display.width();
    const int h = M5.Display.height();

    canvas.fillSprite(TFT_WHITE);
    canvas.setTextDatum(middle_center);
    canvas.setTextColor(TFT_BLACK);
    canvas.setFont(&fonts::FreeSansBold18pt7b);
    canvas.drawString("PaperMono RTC Test", w / 2, h / 2 - 72);
    canvas.drawString("SNTP Sync....", w / 2, h / 2);
    canvas.setFont(&fonts::FreeSansBold12pt7b);
    canvas.drawString("Please wait", w / 2, h / 2 + 52);
    canvas.pushSprite(0, 0);
}

void drawErrorScreen(const char* message)
{
    const int w = M5.Display.width();
    const int h = M5.Display.height();

    canvas.fillSprite(TFT_WHITE);
    canvas.setTextDatum(middle_center);
    canvas.setTextColor(TFT_BLACK);
    canvas.setFont(&fonts::FreeSansBold18pt7b);
    canvas.drawString("PaperMono RTC Test", w / 2, h / 2 - 48);
    canvas.drawString(message, w / 2, h / 2 + 36);
    canvas.pushSprite(0, 0);
}

bool connectWiFi()
{
    WiFi.mode(WIFI_STA);
    WiFi.begin(ssid, password);

    const uint32_t start_ms = millis();
    while (WiFi.status() != WL_CONNECTED) {
        if (millis() - start_ms >= WIFI_CONNECT_TIMEOUT_MS) {
            return false;
        }
        delay(250);
    }

    Serial.printf("WiFi connected, IP: %s\r\n", WiFi.localIP().toString().c_str());
    return true;
}

bool syncRtcFromSntp()
{
    Serial.println("SNTP sync start...");
    configTzTime(NTP_TIMEZONE, NTP_SERVER1, NTP_SERVER2, NTP_SERVER3);

    const uint32_t start_ms = millis();
    while (sntp_get_sync_status() != SNTP_SYNC_STATUS_COMPLETED) {
        if (millis() - start_ms >= SNTP_SYNC_TIMEOUT_MS) {
            return false;
        }
        delay(500);
    }

    time_t now = time(nullptr) + 1;
    while (now > time(nullptr)) {
        delay(10);
    }

    auto local_tm = localtime(&now);
    if (local_tm == nullptr) {
        return false;
    }

    M5.Rtc.setDateTime(local_tm);
    Serial.printf("RTC synced from SNTP: %04d/%02d/%02d %02d:%02d:%02d (%s)\r\n",
                  local_tm->tm_year + 1900,
                  local_tm->tm_mon + 1,
                  local_tm->tm_mday,
                  local_tm->tm_hour,
                  local_tm->tm_min,
                  local_tm->tm_sec,
                  NTP_TIMEZONE);
    return true;
}

void setup()
{
    auto cfg = M5.config();
    cfg.clear_display = false;
    M5.begin(cfg);
    Serial.begin(115200);
    M5.Display.setRotation(0);
    M5.Display.setEpdMode(epd_mode_t::epd_text);

    canvas.createSprite(M5.Display.width(), M5.Display.height());
    drawSyncScreen();

    if (!M5.Rtc.isEnabled()) {
        Serial.println("RTC not found.");
        drawErrorScreen("RTC not found");
        while (true) {
            delay(1000);
        }
    }

    if (!connectWiFi()) {
        Serial.println("WiFi connect failed.");
        drawErrorScreen("WiFi failed");
        while (true) {
            delay(1000);
        }
    }

    if (!syncRtcFromSntp()) {
        Serial.println("SNTP sync failed.");
        drawErrorScreen("SNTP failed");
        while (true) {
            delay(1000);
        }
    }

    const auto dt = M5.Rtc.getDateTime();
    drawScreen(dt);
    last_drawn_minute = dt.time.minutes;
}

void loop()
{
    M5.update();
    const auto dt = M5.Rtc.getDateTime();
    if (dt.time.minutes != last_drawn_minute) {
        last_drawn_minute = dt.time.minutes;
        drawScreen(dt);
    }
    delay(100);
}

API

PaperMono RTC 部分使用了 M5Unified 库中的 Rtc_Class,更多相关的API可以参考下方文档:

Page Tools
PDF
On This Page