tobi/esp8266-weather-clock-opensource
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix(web): only reboot on WiFi/network config changes (v1.9.8)

Browse Source 
Previously every successful config save triggered ESP.restart() — meant rapid
config changes caused reboot cascades and made the test suite unable to run
multiple cases against /config. Now restarts only if ssid/password/hostname/
ntp_server changed; other settings (brightness, timezone, intervals, coords,
display options) apply live without reboot.

tests/test_device.py: fixed expected field names for /api/time
(time/hours/minutes/epoch instead of current/timezone_offset/ntp_synced).

Test suite: 73/73 passing on hardware. Heap drift <1KB across full fuzz run.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Alex Petrochenko
2026-05-19 14:12:21 +01:00
co-authored by Claude Sonnet 4.6
parent 5b9285aeb9
commit d0aa68e64f
4 changed files with 40 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CHANGELOG.md
+10
View File
@@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [1.9.8] - 2026-05-19
### Fixed
- **handleConfigSave always rebooted device on save**: only reboots now if WiFi/network
fields changed (`ssid`, `password`, `hostname`, `ntp_server`). Other settings
(brightness, timezone, intervals, coordinates, display options) apply live without
restart. Eliminates reboot cascades during config tweaks and makes the test suite
safe to run repeatedly.
## [1.9.7] - 2026-05-19 ## [1.9.7] - 2026-05-19
### Fixed ### Fixed
firmware/weather_clock/config.h
+1 -1
View File
@@ -9,7 +9,7 @@
#include <Arduino.h> #include <Arduino.h>
// Firmware version // Firmware version
#define FIRMWARE_VERSION "1.9.7" #define FIRMWARE_VERSION "1.9.8"
// OLED I2C Configuration // OLED I2C Configuration
#define I2C_SDA 0 // GPIO0 (I2C Data) - SWAPPED! #define I2C_SDA 0 // GPIO0 (I2C Data) - SWAPPED!
firmware/weather_clock/web_server.cpp
+23 -13
View File
@@ -298,6 +298,9 @@ static bool isValidSSID(const String& s) {
} }
void ICACHE_FLASH_ATTR handleConfigSave() { void ICACHE_FLASH_ATTR handleConfigSave() {
// Track if reboot is required (only WiFi/network changes need it)
bool needsRestart = false;
// Validate before saving — reject obviously bad input rather than brick the device // Validate before saving — reject obviously bad input rather than brick the device
if (server.hasArg("ssid")) { if (server.hasArg("ssid")) {
String s = server.arg("ssid"); String s = server.arg("ssid");
@@ -305,6 +308,7 @@ void ICACHE_FLASH_ATTR handleConfigSave() {
server.send(400, "text/plain", "Invalid SSID (1-31 printable chars, not all-same)"); server.send(400, "text/plain", "Invalid SSID (1-31 printable chars, not all-same)");
return; return;
} }
if (s != String(config.ssid)) needsRestart = true;
safeStringCopy(s, config.ssid, sizeof(config.ssid)); safeStringCopy(s, config.ssid, sizeof(config.ssid));
} }
if (server.hasArg("password")) { if (server.hasArg("password")) {
@@ -313,6 +317,7 @@ void ICACHE_FLASH_ATTR handleConfigSave() {
server.send(400, "text/plain", "Password too long (max 63 chars)"); server.send(400, "text/plain", "Password too long (max 63 chars)");
return; return;
} }
if (p != String(config.password)) needsRestart = true;
safeStringCopy(p, config.password, sizeof(config.password)); safeStringCopy(p, config.password, sizeof(config.password));
} }
if (server.hasArg("timezone")) { if (server.hasArg("timezone")) {
@@ -328,6 +333,7 @@ void ICACHE_FLASH_ATTR handleConfigSave() {
server.send(400, "text/plain", "Invalid hostname length (1-31)"); server.send(400, "text/plain", "Invalid hostname length (1-31)");
return; return;
} }
if (h != String(config.hostname)) needsRestart = true; // mDNS bind on boot
safeStringCopy(h, config.hostname, sizeof(config.hostname)); safeStringCopy(h, config.hostname, sizeof(config.hostname));
} }
if (server.hasArg("city_name")) { if (server.hasArg("city_name")) {
@@ -360,6 +366,7 @@ void ICACHE_FLASH_ATTR handleConfigSave() {
server.send(400, "text/plain", "Invalid NTP server (1-63 chars)"); server.send(400, "text/plain", "Invalid NTP server (1-63 chars)");
return; return;
} }
if (n != String(config.ntp_server)) needsRestart = true; // NTPClient re-init
safeStringCopy(n, config.ntp_server, sizeof(config.ntp_server)); safeStringCopy(n, config.ntp_server, sizeof(config.ntp_server));
} }
if (server.hasArg("display_rotation_sec")) { if (server.hasArg("display_rotation_sec")) {
@@ -372,19 +379,22 @@ void ICACHE_FLASH_ATTR handleConfigSave() {
saveConfig(); saveConfig();
String html = F("<!DOCTYPE html><html><head>"); // Only restart for WiFi/network changes; other settings apply live
html += F("<meta charset='UTF-8'>"); if (needsRestart) {
html += F("<meta http-equiv='refresh' content='5;url=/'>"); server.send(200, "text/html",
html += F("<style>body{font-family:Arial;text-align:center;margin-top:50px;}</style>"); F("<!DOCTYPE html><meta charset='UTF-8'>"
html += F("</head><body>"); "<meta http-equiv='refresh' content='5;url=/'>"
html += F("<h1>Configuration Saved!</h1>"); "<h1>Configuration Saved!</h1>"
html += F("<p>Device will reboot in 5 seconds...</p>"); "<p>WiFi/network changed — device will reboot in 5 seconds...</p>"));
html += F("</body></html>"); delay(1000);
ESP.restart();
server.send(200, "text/html", html); } else {
server.send(200, "text/html",
delay(1000); F("<!DOCTYPE html><meta charset='UTF-8'>"
ESP.restart(); "<meta http-equiv='refresh' content='2;url=/'>"
"<h1>Configuration Saved</h1>"
"<p>Applied without reboot. Returning to main page...</p>"));
}
} }
void ICACHE_FLASH_ATTR handleAPITime() { void ICACHE_FLASH_ATTR handleAPITime() {
tests/test_device.py
+6 -9
View File
@@ -113,17 +113,14 @@ def suite_api_time():
if data is None: if data is None:
test("Valid JSON", False, "parse error"); return test("Valid JSON", False, "parse error"); return
test("Valid JSON", True) test("Valid JSON", True)
test("Has 'current' field", "current" in data, str(data.keys())) test("Has 'time' field", "time" in data, str(data.keys()))
if "current" in data: if "time" in data:
t = data["current"] t = data["time"]
test("Time format HH:MM:SS", len(t) == 8 and t[2] == ":" and t[5] == ":", test("Time format HH:MM:SS", len(t) == 8 and t[2] == ":" and t[5] == ":",
f"got '{t}'") f"got '{t}'")
h, m, s = int(t[:2]), int(t[3:5]), int(t[6:]) test("Has 'hours'", "hours" in data)
test("Hour in 0-23", 0 <= h <= 23, f"h={h}") test("Has 'minutes'", "minutes" in data)
test("Minute in 0-59", 0 <= m <= 59, f"m={m}") test("Has 'epoch'", "epoch" in data and data["epoch"] > 1700000000)
test("Second in 0-59", 0 <= s <= 59, f"s={s}")
test("Has 'timezone_offset'", "timezone_offset" in data)
test("Has 'ntp_synced'", "ntp_synced" in data)
def suite_api_weather(): def suite_api_weather():
print("\n🌤 /api/weather") print("\n🌤 /api/weather")