chore: harden shared state, parser bounds and build pinning

- Guard the AES output buffer against oversized advertisements
- Protect the cross-core MpptData hand-off with a critical section and
  publish from a consistent snapshot
- Scan in 30s blocks and clear results between them: NimBLE 1.4.x only
  frees its result list when a scan completes, and one entry is kept per
  unique BLE address (including MAC-randomising phones)
- Do not let the forced-reconnect watchdog reset the reboot watchdog
- Publish discovery immediately after a reconnect instead of waiting for
  the retry timer
- Pin espressif32 to 6.13.0 (Arduino core 2.0.17), the last platform
  compatible with NimBLE-Arduino 1.4.x
- Document diagnostics, watchdogs and the data_age_s field
This commit is contained in:
Michael Holzmann 2026-11-14 14:54:35 +00:00
parent 4cd4fbe41a
commit a2fea10678
5 changed files with 111 additions and 33 deletions

View File

@ -37,9 +37,10 @@ better in Home Assistant while it's there.
|---|---| |---|---|
| 📶 **Reads the advertisement** | Passive BLE scan of the SmartSolar MPPT's broadcasts — no pairing, no connection, lower draw. | | 📶 **Reads the advertisement** | Passive BLE scan of the SmartSolar MPPT's broadcasts — no pairing, no connection, lower draw. |
| 🔐 **Real decryption** | AES-128-CTR exactly as the Victron BLE protocol specifies, matching the reference Python implementation bit for bit. | | 🔐 **Real decryption** | AES-128-CTR exactly as the Victron BLE protocol specifies, matching the reference Python implementation bit for bit. |
| 📡 **MQTT every 10s** | One JSON payload with every value, plus a retained online/offline LWT topic. | | 📡 **MQTT every 10s** | One JSON payload with every value, plus a retained online/offline LWT topic and a `diag` topic with uptime, RSSI, heap and reconnect counters. |
| 🏠 **Auto-discovery** | Appears in Home Assistant as a **Victron SmartSolar MPPT** device with entities grouped. No YAML. | | 🏠 **Auto-discovery** | Appears in Home Assistant as a **Victron SmartSolar MPPT** device with entities grouped. No YAML. |
| 🧵 **Two cores, no crashes** | BLE scanning pinned to core 1, WiFi/MQTT to core 0 via FreeRTOS — sidesteps the radio coexistence crashes that come from sharing a core. | | 🧵 **Two cores** | BLE scanning pinned to core 1, WiFi/MQTT to core 0 via FreeRTOS. Coexistence is handled by a 50% BLE scan duty cycle, not by the core split. |
| 🔁 **Self-healing** | Non-blocking reconnects, forced MQTT reconnect after 5 minutes without a successful publish, and a reboot after 60 minutes |
| 🔌 **External load too** | The MPPT's load output current is published as amps, and multiplied by battery voltage to give watts — so the dashboard shows draw as well as charge. | | 🔌 **External load too** | The MPPT's load output current is published as amps, and multiplied by battery voltage to give watts — so the dashboard shows draw as well as charge. |
| 📊 **Dashboard included** | A ready-made Mushroom + Mini Graph dashboard card and optional template sensors. | | 📊 **Dashboard included** | A ready-made Mushroom + Mini Graph dashboard card and optional template sensors. |
| 🪫 **0.15W idle** | The entire point. | | 🪫 **0.15W idle** | The entire point. |
@ -154,7 +155,28 @@ cp include/example.config.h include/config.h
"charge_state_raw": 3, "charge_state_raw": 3,
"error_code": 0, "error_code": 0,
"external_load_a": "0.35", "external_load_a": "0.35",
"external_load_w": "4.5" "external_load_w": "4.5",
"data_age_s": 2
}
```
`data_age_s` is the age of the last decoded BLE packet. If it keeps growing while
`solar/mppt/diag` still updates, MQTT and WiFi are fine and the problem is BLE reception.
```json
{
"uptime_s": 86400,
"wifi_status": 3,
"wifi_rssi": -61,
"free_heap": 182344,
"min_free_heap": 140112,
"wifi_disconnects": 0,
"mqtt_connects": 1,
"publish_failures": 0,
"ble_valid": 14321,
"ble_ignored": 0,
"ble_rssi": -72,
"ble_age_s": 2
} }
``` ```
@ -173,6 +195,27 @@ cp include/example.config.h include/config.h
| 252 | External control | | 252 | External control |
</details> </details>
## Troubleshooting
Start by subscribing to the `solar/mppt/diag` topic:
| Observation | Likely cause |
|---|---|
| `diag` updates, `ble_age_s`/`data_age_s` growing | MQTT and WiFi are fine; the MPPT advertisement is not being received (range, MPPT asleep, VictronConnect connected to it, BLE scan failed) |
| `diag` stops, `status` still `online` | WiFi or broker path; watch the serial log for `[WiFi] Disconnected, reason=` and `[MQTT] Connection lost` |
| `publish_failures` climbing | Socket/broker rejects; check broker logs for duplicate `MQTT_CLIENT_ID` |
| `free_heap` low or `min_free_heap` dropping each boot | Memory pressure; shorten the diag interval or reduce scanning |
Note that retained `online` on `solar/mppt/status` only means the broker has not yet
noticed the TCP session is gone; it does not prove the ESP32 is still publishing.
The firmware includes two safety nets (both defined in `src/main.cpp`):
- **5 minutes** without a successful publish → drop and rebuild the MQTT connection.
- **60 minutes** without any successful publish → `ESP.restart()`.
---
## Home Assistant ## Home Assistant
Once the ESP32 is running, go to **Settings → Devices & Services → MQTT**. A **Victron Once the ESP32 is running, go to **Settings → Devices & Services → MQTT**. A **Victron

View File

@ -36,5 +36,9 @@
#define BLE_SCAN_INTERVAL_MS 100 #define BLE_SCAN_INTERVAL_MS 100
#define BLE_SCAN_WINDOW_MS 50 #define BLE_SCAN_WINDOW_MS 50
// Scan in blocks; NimBLE 1.4.x frees its result list only when a scan ends.
#define BLE_SCAN_PERIOD_S 30
#define BLE_SCAN_PAUSE_MS 1000
// How often to publish the diagnostics payload (milliseconds) // How often to publish the diagnostics payload (milliseconds)
#define DIAG_INTERVAL_MS 60000 #define DIAG_INTERVAL_MS 60000

View File

@ -1,5 +1,7 @@
[env:esp32dev] [env:esp32dev]
platform = espressif32 ; Pinned: NimBLE-Arduino 1.4.x targets Arduino core 2.x (IDF 4.4).
; espressif32 6.13.0 is the last platform release on Arduino core 2.0.17.
platform = espressif32@6.13.0
board = esp32dev board = esp32dev
framework = arduino framework = arduino

View File

@ -12,7 +12,7 @@
static uint8_t s_encKey[16]; static uint8_t s_encKey[16];
// Shared between BLE core (1) and MQTT core (0) // Shared between BLE core (1) and MQTT core (0)
static volatile bool s_newData = false; static portMUX_TYPE s_dataMux = portMUX_INITIALIZER_UNLOCKED;
static MpptData s_latest = {}; static MpptData s_latest = {};
// MQTT + WiFi — only touched by core 0 task // MQTT + WiFi — only touched by core 0 task
@ -33,6 +33,8 @@ static volatile int s_lastBleRssi = 0;
static volatile bool s_bleSeen = false; static volatile bool s_bleSeen = false;
static volatile uint32_t s_lastPublishOkMs = 0; static volatile uint32_t s_lastPublishOkMs = 0;
static uint32_t s_lastDiscoveryAttemptMs = 0;
#ifndef MQTT_TOPIC_DIAG #ifndef MQTT_TOPIC_DIAG
#define MQTT_TOPIC_DIAG "solar/mppt/diag" #define MQTT_TOPIC_DIAG "solar/mppt/diag"
#endif #endif
@ -52,6 +54,16 @@ static volatile uint32_t s_lastPublishOkMs = 0;
#define BLE_SCAN_WINDOW_MS 50 #define BLE_SCAN_WINDOW_MS 50
#endif #endif
// NimBLE-Arduino 1.4.x only frees its result vector when a scan completes, so
// scan in long blocks and clear in between instead of scanning forever.
#ifndef BLE_SCAN_PERIOD_S
#define BLE_SCAN_PERIOD_S 30
#endif
#ifndef BLE_SCAN_PAUSE_MS
#define BLE_SCAN_PAUSE_MS 1000
#endif
// Reconnect strategy // Reconnect strategy
#ifndef WIFI_RETRY_MS #ifndef WIFI_RETRY_MS
#define WIFI_RETRY_MS 10000UL #define WIFI_RETRY_MS 10000UL
@ -151,6 +163,7 @@ static bool mqttEnsureConnected(uint32_t now) {
s_mqttConnects++; s_mqttConnects++;
s_mqtt.publish(MQTT_TOPIC_STATUS, "online", true); s_mqtt.publish(MQTT_TOPIC_STATUS, "online", true);
s_discoveryPublished = false; s_discoveryPublished = false;
s_lastDiscoveryAttemptMs = 0; // publish discovery immediately
return true; return true;
} }
@ -165,10 +178,10 @@ static bool mqttEnsureConnected(uint32_t now) {
static bool publishDiscovery() { static bool publishDiscovery() {
static uint32_t lastAttemptMs = 0;
uint32_t now = millis(); uint32_t now = millis();
if (lastAttemptMs != 0 && now - lastAttemptMs < DISCOVERY_RETRY_MS) return false; if (s_lastDiscoveryAttemptMs != 0 &&
lastAttemptMs = now; now - s_lastDiscoveryAttemptMs < DISCOVERY_RETRY_MS) return false;
s_lastDiscoveryAttemptMs = now;
// Common device suffix appended to every payload // Common device suffix appended to every payload
// identifiers must match across all sensors for HA to group them // identifiers must match across all sensors for HA to group them
@ -329,7 +342,9 @@ void mqttTask(void* param) {
delay(1000); delay(1000);
// Buffer must be set BEFORE connect — largest discovery packet is ~570 bytes // Buffer must be set BEFORE connect — largest discovery packet is ~570 bytes
s_mqtt.setBufferSize(1024); if (!s_mqtt.setBufferSize(1024)) {
Serial.println("[MQTT] setBufferSize(1024) FAILED");
}
s_mqtt.setServer(MQTT_HOST, MQTT_PORT); s_mqtt.setServer(MQTT_HOST, MQTT_PORT);
s_mqtt.setKeepAlive(30); s_mqtt.setKeepAlive(30);
s_mqtt.setSocketTimeout(5); s_mqtt.setSocketTimeout(5);
@ -337,6 +352,7 @@ void mqttTask(void* param) {
s_lastPublishOkMs = millis(); s_lastPublishOkMs = millis();
uint32_t lastDiagMs = millis(); uint32_t lastDiagMs = millis();
uint32_t lastDataMs = s_lastPublishOkMs; uint32_t lastDataMs = s_lastPublishOkMs;
uint32_t lastForceReconnectMs = 0;
for (;;) { for (;;) {
uint32_t now = millis(); uint32_t now = millis();
@ -353,13 +369,18 @@ void mqttTask(void* param) {
// Publish on a fixed cadence, not only when a BLE packet arrives: this // Publish on a fixed cadence, not only when a BLE packet arrives: this
// keeps the session exercised and makes an outage visible instead of // keeps the session exercised and makes an outage visible instead of
// leaving a silently stale broker. // leaving a silently stale broker. New BLE packets simply refresh the
// snapshot that the next scheduled publish sends.
if (mqttUp && s_bleSeen) { if (mqttUp && s_bleSeen) {
if (s_newData) { MpptData snapshot;
s_newData = false;
if (publishData(s_latest, now)) lastDataMs = now; // Take a consistent copy; the BLE callback runs on the other core.
} else if (now - lastDataMs >= PUBLISH_INTERVAL_MS) { portENTER_CRITICAL(&s_dataMux);
if (publishData(s_latest, now)) lastDataMs = now; snapshot = s_latest;
portEXIT_CRITICAL(&s_dataMux);
if (now - lastDataMs >= PUBLISH_INTERVAL_MS) {
if (publishData(snapshot, now)) lastDataMs = now;
} }
} }
@ -369,12 +390,15 @@ void mqttTask(void* param) {
} }
// MQTT thinks it is connected but nothing gets out -> half-open socket. // MQTT thinks it is connected but nothing gets out -> half-open socket.
if (mqttUp && now - s_lastPublishOkMs >= MQTT_WATCHDOG_MS) { // Keep the actual last-success timestamp untouched so the reboot
// watchdog below still fires if reconnecting does not help.
if (mqttUp && now - s_lastPublishOkMs >= MQTT_WATCHDOG_MS &&
now - lastForceReconnectMs >= MQTT_WATCHDOG_MS) {
Serial.printf("[MQTT] No successful publish for %lus, forcing reconnect\n", Serial.printf("[MQTT] No successful publish for %lus, forcing reconnect\n",
(unsigned long)((now - s_lastPublishOkMs) / 1000UL)); (unsigned long)((now - s_lastPublishOkMs) / 1000UL));
s_mqtt.disconnect(); s_mqtt.disconnect();
s_lastPublishOkMs = now; // give the new connection a full window lastForceReconnectMs = now;
lastDataMs = now; lastDataMs = 0; // publish the newest snapshot right after reconnect
} }
// Total comms failure for a long time -> the ESP32 itself is wedged. // Total comms failure for a long time -> the ESP32 itself is wedged.
@ -405,11 +429,14 @@ class VictronAdvertisedDeviceCallbacks : public NimBLEAdvertisedDeviceCallbacks
MpptData parsed = parseVictronMppt(s_encKey, payload, payloadLen); MpptData parsed = parseVictronMppt(s_encKey, payload, payloadLen);
if (parsed.valid) { if (parsed.valid) {
portENTER_CRITICAL(&s_dataMux);
s_latest = parsed; s_latest = parsed;
portEXIT_CRITICAL(&s_dataMux);
s_lastBleRssi = device->getRSSI();
s_lastBleMs = millis(); s_lastBleMs = millis();
s_bleSeen = true; s_bleSeen = true;
s_bleValid++; s_bleValid++;
s_newData = true;
Serial.println("[BLE] Valid Victron packet decoded"); Serial.println("[BLE] Valid Victron packet decoded");
} else { } else {
s_bleIgnored++; s_bleIgnored++;
@ -426,11 +453,10 @@ static void bleInit() {
s_scan = NimBLEDevice::getScan(); s_scan = NimBLEDevice::getScan();
s_scan->setAdvertisedDeviceCallbacks(new VictronAdvertisedDeviceCallbacks(), true); s_scan->setAdvertisedDeviceCallbacks(new VictronAdvertisedDeviceCallbacks(), true);
s_scan->setActiveScan(false); s_scan->setActiveScan(false);
s_scan->setMaxResults(0); // callbacks only, don't store devices
s_scan->setInterval(BLE_SCAN_INTERVAL_MS); s_scan->setInterval(BLE_SCAN_INTERVAL_MS);
s_scan->setWindow(BLE_SCAN_WINDOW_MS); s_scan->setWindow(BLE_SCAN_WINDOW_MS);
Serial.printf("[BLE] Scanner initialised (interval %d ms, window %d ms)\n", Serial.printf("[BLE] Scanner initialised (interval %d ms, window %d ms, %d s blocks)\n",
BLE_SCAN_INTERVAL_MS, BLE_SCAN_WINDOW_MS); BLE_SCAN_INTERVAL_MS, BLE_SCAN_WINDOW_MS, BLE_SCAN_PERIOD_S);
} }
// ── Setup & Loop ───────────────────────────────────────────────────────────── // ── Setup & Loop ─────────────────────────────────────────────────────────────
@ -460,12 +486,10 @@ void setup() {
} }
void loop() { void loop() {
// Continuous passive scan. Restart only if the controller/host stopped it. // Long passive scan, then clear: NimBLE 1.4.x keeps one result object per
if (!s_scan->isScanning()) { // unique BLE address (including phones with rotating MACs) until a scan
Serial.println("[BLE] Starting continuous scan"); // completes, so clearing after each block keeps the heap flat.
if (!s_scan->start(0, nullptr, true)) { s_scan->start(BLE_SCAN_PERIOD_S, false);
Serial.println("[BLE] Scan start FAILED"); s_scan->clearResults();
} delay(BLE_SCAN_PAUSE_MS);
}
delay(5000);
} }

View File

@ -103,6 +103,11 @@ MpptData parseVictronMppt(const uint8_t* encKey, const uint8_t* data, size_t len
} }
uint8_t decrypted[32] = {0}; uint8_t decrypted[32] = {0};
if (encLen > sizeof(decrypted)) {
Serial.printf("[BLE] Encrypted payload too long (%u bytes)\n",
(unsigned)encLen);
return result;
}
if (!aes128ctrDecrypt(encKey, nonce, encrypted, decrypted, encLen)) { if (!aes128ctrDecrypt(encKey, nonce, encrypted, decrypted, encLen)) {
Serial.println("[BLE] AES decryption failed"); Serial.println("[BLE] AES decryption failed");
return result; return result;