Skip to content

Feature/rtc cli status #2710

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
polipl wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Feature/rtc cli status #2710

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
cc6031d
add hardware RTC startup sync and periodic system clock correction
polipl May 8, 2026
56eb87d
add 'get rtcclock' CLI command to report RTC source and current time
polipl May 8, 2026
0e29572
Merge branch 'meshcore-dev:main' into feature/rtc-auto-sync-on-startup
polipl Jun 5, 2026
c302a91
Merge branch 'meshcore-dev:main' into feature/rtc-cli-status
polipl Jun 5, 2026
867236f
Merge pull request #1 from polipl/feature/rtc-auto-sync-on-startup
polipl Jun 5, 2026
fbe61ce
Merge branch 'main' into feature/rtc-cli-status
polipl Jun 5, 2026
12c13b0
Merge pull request #2 from polipl/feature/rtc-cli-status
polipl Jun 5, 2026
5ba1e62
debug on
polipl Jun 5, 2026
c99fe8f
Merge branch 'meshcore-dev:main' into main
polipl Jun 6, 2026
c6089a8
Merge branch 'meshcore-dev:main' into feature/rtc-cli-status
polipl Jun 6, 2026
8cb7901
Merge branch 'main' into feature/rtc-cli-status
polipl Jun 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/MeshCore.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,8 @@ class RTCClock {
*/
virtual void tick() { /* no op */}

virtual const char* getSourceName() const { return "internal"; }

uint32_t getCurrentTimeUnique() {
uint32_t t = getCurrentTime();
if (t <= last_unique) {
Expand Down
22 changes: 22 additions & 0 deletions src/helpers/AutoDiscoverRTCClock.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,17 @@ bool AutoDiscoverRTCClock::i2c_probe(TwoWire& wire, uint8_t addr) {
return (error == 0);
}

void AutoDiscoverRTCClock::syncSystemClock() {
uint32_t hw_time = getCurrentTime();
if (hw_time <= 1704067200UL) return; // DS3231 not set or lost power (before 2024-01-01)

uint32_t sys_time = _fallback->getCurrentTime();
int32_t drift = (int32_t)(hw_time - sys_time);
if (drift > 2 || drift < -2) {
_fallback->setCurrentTime(hw_time);
}
}

void AutoDiscoverRTCClock::begin(TwoWire& wire) {
#if !defined(DISABLE_DS3231_PROBE)
if (i2c_probe(wire, DS3231_ADDRESS)) {
Expand All @@ -51,6 +62,17 @@ void AutoDiscoverRTCClock::begin(TwoWire& wire) {
rtc_8130_success = true;
MESH_DEBUG_PRINTLN("RX8130CE: Initialized");
}

if (ds3231_success) _source_name = "DS3231";
else if (rv3028_success) _source_name = "RV3028";
else if (rtc_8563_success) _source_name = "PCF8563";
else if (rtc_8130_success) _source_name = "RX8130CE";

_has_hw_rtc = ds3231_success || rv3028_success || rtc_8563_success || rtc_8130_success;
if (_has_hw_rtc) {
syncSystemClock();
_last_sync_ms = millis();
}
}

uint32_t AutoDiscoverRTCClock::getCurrentTime() {
Expand Down
20 changes: 19 additions & 1 deletion src/helpers/AutoDiscoverRTCClock.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,36 @@
#include <Arduino.h>
#include <Wire.h>

#ifndef RTC_RESYNC_INTERVAL_MS
#define RTC_RESYNC_INTERVAL_MS 3600000UL // re-sync system clock from hardware RTC once per hour
#endif

class AutoDiscoverRTCClock : public mesh::RTCClock {
mesh::RTCClock* _fallback;
bool _has_hw_rtc;
unsigned long _last_sync_ms;
const char* _source_name;

bool i2c_probe(TwoWire& wire, uint8_t addr);
void syncSystemClock();
public:
AutoDiscoverRTCClock(mesh::RTCClock& fallback) : _fallback(&fallback) { }
AutoDiscoverRTCClock(mesh::RTCClock& fallback)
: _fallback(&fallback), _has_hw_rtc(false), _last_sync_ms(0), _source_name("internal") { }

const char* getSourceName() const override { return _source_name; }

void begin(TwoWire& wire);
uint32_t getCurrentTime() override;
void setCurrentTime(uint32_t time) override;

void tick() override {
_fallback->tick(); // is typically VolatileRTCClock, which now needs tick()
if (_has_hw_rtc) {
unsigned long now = millis();
if ((unsigned long)(now - _last_sync_ms) >= RTC_RESYNC_INTERVAL_MS) {
syncSystemClock();
_last_sync_ms = now;
}
}
}
};
7 changes: 7 additions & 0 deletions src/helpers/CommonCLI.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -926,6 +926,13 @@ void CommonCLI::handleGetCmd(uint32_t sender_timestamp, char* command, char* rep
#else
strcpy(reply, "ERROR: Power management not supported");
#endif
} else if (memcmp(config, "rtcclock", 8) == 0) {
uint32_t now = getRTCClock()->getCurrentTime();
DateTime dt = DateTime(now);
sprintf(reply, "> %s | %04d-%02d-%02d %02d:%02d:%02d UTC",
getRTCClock()->getSourceName(),
dt.year(), dt.month(), dt.day(),
dt.hour(), dt.minute(), dt.second());
} else {
sprintf(reply, "??: %s", config);
}
Expand Down
12 changes: 6 additions & 6 deletions variants/heltec_v3/platformio.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ build_flags =
-D ADVERT_LON=0.0
-D ADMIN_PASSWORD='"password"'
-D MAX_NEIGHBOURS=50
; -D MESH_PACKET_LOGGING=1
; -D MESH_DEBUG=1
-D MESH_PACKET_LOGGING=1
-D MESH_DEBUG=1
build_src_filter = ${Heltec_lora32_v3.build_src_filter}
+<helpers/ui/SSD1306Display.cpp>
+<../examples/simple_repeater>
Expand Down Expand Up @@ -167,8 +167,8 @@ build_flags =
-D AUTO_SHUTDOWN_MILLIVOLTS=3400
-D BLE_DEBUG_LOGGING=1
-D OFFLINE_QUEUE_SIZE=256
; -D MESH_PACKET_LOGGING=1
; -D MESH_DEBUG=1
-D MESH_PACKET_LOGGING=1
-D MESH_DEBUG=1
build_src_filter = ${Heltec_lora32_v3.build_src_filter}
+<helpers/ui/SSD1306Display.cpp>
+<helpers/ui/MomentaryButton.cpp>
Expand All @@ -191,8 +191,8 @@ build_flags =
-D WIFI_SSID='"myssid"'
-D WIFI_PWD='"mypwd"'
-D OFFLINE_QUEUE_SIZE=256
; -D MESH_PACKET_LOGGING=1
; -D MESH_DEBUG=1
-D MESH_PACKET_LOGGING=1
-D MESH_DEBUG=1
build_src_filter = ${Heltec_lora32_v3.build_src_filter}
+<helpers/ui/SSD1306Display.cpp>
+<helpers/ui/MomentaryButton.cpp>
Expand Down
26 changes: 13 additions & 13 deletions variants/heltec_v4/platformio.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,8 @@ build_flags =
-D ADVERT_LON=0.0
-D ADMIN_PASSWORD='"password"'
-D MAX_NEIGHBOURS=50
; -D MESH_PACKET_LOGGING=1
; -D MESH_DEBUG=1
-D MESH_PACKET_LOGGING=1
-D MESH_DEBUG=1
build_src_filter = ${heltec_v4_oled.build_src_filter}
+<helpers/ui/SSD1306Display.cpp>
+<../examples/simple_repeater>
Expand Down Expand Up @@ -135,9 +135,9 @@ build_flags =
-D ADMIN_PASSWORD='"password"'
-D MAX_NEIGHBOURS=50
-D WITH_ESPNOW_BRIDGE=1
; -D BRIDGE_DEBUG=1
; -D MESH_PACKET_LOGGING=1
; -D MESH_DEBUG=1
-D BRIDGE_DEBUG=1
-D MESH_PACKET_LOGGING=1
-D MESH_DEBUG=1
build_src_filter = ${heltec_v4_oled.build_src_filter}
+<helpers/bridges/ESPNowBridge.cpp>
+<helpers/ui/SSD1306Display.cpp>
Expand All @@ -156,8 +156,8 @@ build_flags =
-D ADVERT_LON=0.0
-D ADMIN_PASSWORD='"password"'
-D ROOM_PASSWORD='"hello"'
; -D MESH_PACKET_LOGGING=1
; -D MESH_DEBUG=1
-D MESH_PACKET_LOGGING=1
-D MESH_DEBUG=1
build_src_filter = ${heltec_v4_oled.build_src_filter}
+<helpers/ui/SSD1306Display.cpp>
+<../examples/simple_room_server>
Expand All @@ -171,8 +171,8 @@ build_flags =
${heltec_v4_oled.build_flags}
-D MAX_CONTACTS=350
-D MAX_GROUP_CHANNELS=1
; -D MESH_PACKET_LOGGING=1
; -D MESH_DEBUG=1
-D MESH_PACKET_LOGGING=1
-D MESH_DEBUG=1
build_src_filter = ${heltec_v4_oled.build_src_filter}
+<../examples/simple_secure_chat/main.cpp>
lib_deps =
Expand Down Expand Up @@ -234,8 +234,8 @@ build_flags =
-D WIFI_DEBUG_LOGGING=1
-D WIFI_SSID='"myssid"'
-D WIFI_PWD='"mypwd"'
; -D MESH_PACKET_LOGGING=1
; -D MESH_DEBUG=1
-D MESH_PACKET_LOGGING=1
-D MESH_DEBUG=1
build_src_filter = ${heltec_v4_oled.build_src_filter}
+<helpers/ui/SSD1306Display.cpp>
+<helpers/ui/MomentaryButton.cpp>
Expand Down Expand Up @@ -320,8 +320,8 @@ build_flags =
-D ADVERT_LON=0.0
-D ADMIN_PASSWORD='"password"'
-D ROOM_PASSWORD='"hello"'
; -D MESH_PACKET_LOGGING=1
; -D MESH_DEBUG=1
-D MESH_PACKET_LOGGING=1
-D MESH_DEBUG=1
build_src_filter = ${heltec_v4_tft.build_src_filter}
+<helpers/ui/ST7789LCDDisplay.cpp>
+<../examples/simple_room_server>
Expand Down