Prepare ESP collector 0.1.4 release

Author: Maksym Shtembuliak

CONTRIBUTING.md

@@ -48,7 +48,7 @@ The behavioral specification is the integration's own fake collector:
 - **Discovery**: UDP `58899`, `set>server=IP:PORT;` → reply `rsp>server=2;` + reverse TCP to Home Assistant.
 - **Heartbeat**: FC=1 on connect, then periodic (default 60 s); payload is the PN truncated to 14 bytes. A server FC=1 is answered with its own `tid`.
 - **FC=2** (query collector): the core answers parameters it knows from its own state (PN, firmware, current endpoint, baud); the glue answers the rest (hardware, IP, SSID, RSSI, Wi-Fi scan list). Unknown parameters → `01 <param>` (refused), like the factory fake.
-- **FC=3** (set collector): writes are *staged* and committed together. Param 41/43 stage the target Wi-Fi SSID/password; param 21 stages the server endpoint; param 29 (`system_operation`) **commits everything staged** — endpoint and/or Wi-Fi — and is refused only when nothing is staged. Param 34 (baud) applies immediately. Everything else is refused `01 <param>`. The committed endpoint is persisted to NVS (so the bridge reconnects to the same HA across reboots / can be moved to another HA); incoming discovery still overrides it live. `AT+CLDSRVHOST1=` applies an endpoint immediately (no staging) and retargets the link.
+- **FC=3** (set collector): writes are *staged* and committed together. Param 41/43 stage the target Wi-Fi SSID/password; param 21 stages the server endpoint; param 29 (`system_operation`) **commits everything staged** — endpoint and/or Wi-Fi. If nothing is staged, param 29 is treated as **Restart Collector** and the reboot is delayed until after the response frame is sent. Param 34 (baud) applies immediately. Everything else is refused `01 <param>`. The committed endpoint is persisted to NVS (so the bridge reconnects to the same HA across reboots / can be moved to another HA); incoming discovery still overrides it live. `AT+CLDSRVHOST1=` applies an endpoint immediately (no staging) and retargets the link.
 - **FC=4** (forward): payload → UART as-is; the inverter reply (end detected by a `response_gap` of silence) → frame with the same `tid`/`devcode`/`devaddr`. **Inverter silence → no reply at all** — the integration distinguishes a timeout from a zero-filled answer, so this is load-bearing.
 - **AT lines** (`AT+...\n`) are interleaved with binary frames on the same TCP stream; they are told apart by the 3-byte `AT+` prefix.
 - Inverter requests are serialized: one in flight, with a `command_spacing` pause (factory ~850 ms) between commands.
@@ -62,10 +62,10 @@ The PN is synthetic: `V00` + the 15-digit decimal MAC → the PN18 format `^[A-Z
 The firmware answers `AT+VDTU?` with a capability string:
 
 ```
-AT+VDTU:esp-collector,<semver>;features=local_only,no_cloud,wifi_params,endpoint_write;uart=<baud,data,stop,parity>;spacing_ms=<n>;queue=<n>
+AT+VDTU:esp-collector,<semver>;features=local_only,no_cloud,wifi_params,endpoint_write,reboot;uart=<baud,data,stop,parity>;spacing_ms=<n>;queue=<n>
 ```
 
-EyeBond Local probes this on link-up. The `esp-collector,` prefix identifies a virtual bridge so cloud-only flows can be hidden and an honest device name/version can be shown. Factory collectors do not return the prefix. For every other command the bridge behavior remains compatible with the factory collector path. When the capability string is unset (core without glue), the reply is an empty value, like the factory reference for unknown commands.
+EyeBond Local probes this on link-up. The `esp-collector,` prefix identifies a virtual bridge so cloud-only flows can be hidden and an honest device name/version can be shown. Factory collectors do not return the prefix. Features advertise optional collector-side operations such as endpoint writes and restart. For every other command the bridge behavior remains compatible with the factory collector path.
 
 ---
 

README.md

@@ -137,7 +137,7 @@ select:
     restore_value: true
 ```
 
-The normal way to change speed is in EyeBond Local: open the ESP bridge collector **Configure** menu, choose **Change inverter UART speed**, select the speed, and confirm. The inverter connection may drop briefly while the speed changes.
+The normal way to change speed is in EyeBond Local: open the ESP bridge collector **Configure** menu, choose **Change inverter UART speed**, select the speed, and confirm. On ESP8266/ESP32, the selected speed is saved and restored after reboot or power loss. The inverter connection may drop briefly while the speed changes.
 
 This ESPHome select appears under the ESPHome device in Home Assistant. It is useful for diagnostics, but normal users should prefer the EyeBond Local action.
 
@@ -170,7 +170,7 @@ After setup, Home Assistant may show two relevant devices:
 - the EyeBond Local collector/inverter devices;
 - the ESPHome device for firmware-level features such as logs, OTA, and optional baud-rate select.
 
-For the custom ESP bridge, EyeBond Local also exposes **Change inverter UART speed** in the collector **Configure** menu. Use it when the bridge is found but the inverter needs another serial speed.
+For the custom ESP bridge, EyeBond Local also exposes **Change inverter UART speed** in the collector **Configure** menu. Use it when the bridge is found but the inverter needs another serial speed. On ESP8266/ESP32, the selected speed is saved and restored after reboot or power loss.
 
 ---
 

README.uk.md

@@ -137,7 +137,7 @@ select:
     restore_value: true
 ```
 
-Звичайний спосіб змінити швидкість — через EyeBond Local: відкрийте меню **Configure** для ESP-моста, оберіть **Сменить скорость UART инвертора**, виберіть швидкість і підтвердьте дію. Під час зміни швидкості зв'язок з інвертором може коротко зникнути.
+Звичайний спосіб змінити швидкість — через EyeBond Local: відкрийте меню **Configure** для ESP-моста, оберіть **Сменить скорость UART инвертора**, виберіть швидкість і підтвердьте дію. На ESP8266/ESP32 вибрана швидкість зберігається і відновлюється після перезавантаження або вимкнення живлення. Під час зміни швидкості зв'язок з інвертором може коротко зникнути.
 
 Цей ESPHome-перемикач з'являється на ESPHome-пристрої в Home Assistant. Він корисний для діагностики, але для звичайного використання краще користуватися дією EyeBond Local.
 
@@ -170,7 +170,7 @@ select:
 - пристрої колектора/інвертора EyeBond Local;
 - ESPHome-пристрій для функцій прошивки: логи, OTA і необов'язковий перемикач швидкості UART.
 
-Для кастомного ESP-моста EyeBond Local також показує дію **Сменить скорость UART инвертора** в меню **Configure** колектора. Використовуйте її, якщо міст знайдено, але інвертору потрібна інша швидкість serial-зв'язку.
+Для кастомного ESP-моста EyeBond Local також показує дію **Сменить скорость UART инвертора** в меню **Configure** колектора. Використовуйте її, якщо міст знайдено, але інвертору потрібна інша швидкість serial-зв'язку. На ESP8266/ESP32 вибрана швидкість зберігається і відновлюється після перезавантаження або вимкнення живлення.
 
 ---
 

components/eybond_collector/at_handler.cpp

@@ -51,7 +51,7 @@ std::string vdtu_value(const CollectorProfile &profile) {
     return profile.vdtu;
   }
   return std::string("esp-collector,") + BRIDGE_VERSION +
-         ";features=local_only,no_cloud,wifi_params,endpoint_write" +
+         ";features=local_only,no_cloud,wifi_params,endpoint_write,reboot" +
          ";uart=" + profile.uart;
 }
 

components/eybond_collector/core.cpp

@@ -63,7 +63,7 @@ bool parse_uart_settings(const std::string &value, UartSettings *out) {
 
 std::string build_vdtu_capabilities(const CollectorProfile &profile, const CoreConfig &config) {
   return std::string("esp-collector,") + BRIDGE_VERSION +
-         ";features=local_only,no_cloud,wifi_params,endpoint_write" +
+         ";features=local_only,no_cloud,wifi_params,endpoint_write,reboot" +
          ";uart=" + profile.uart +
          ";spacing_ms=" + std::to_string(config.command_spacing_ms) +
          ";queue=" + std::to_string(config.forward_queue_limit);

components/eybond_collector/core.h

@@ -10,7 +10,8 @@
 //   - on connect: unsolicited FC=1 heartbeat (payload = PN[:14] NUL-padded), then periodic
 //   - server FC=1 -> heartbeat reply with the request tid
 //   - server FC=2 param 5 -> {0x00, 0x05} + firmware version; other params -> {0x01, param}
-//   - server FC=3 -> {0x01, param} (sets are refused; the bridge has no cloud config)
+//   - server FC=3 -> platform-controlled collector params (Wi-Fi/endpoint
+//     staging, param 29 apply/reboot, UART baud) or {0x01, param} refused
 //   - server FC=4 -> payload to UART verbatim, response framed back with the same
 //     tid/devcode/devaddr; inverter silence -> NO reply (the integration relies on
 //     distinguishing timeout from data)
@@ -48,7 +49,7 @@ struct CoreConfig {
 };
 
 // Compose the AT+VDTU capability value the bridge advertises, e.g.
-// "esp-collector,0.2.0;features=local_only,no_cloud;uart=2400,8,1,NONE;spacing_ms=850;queue=4".
+// "esp-collector,0.2.0;features=local_only,no_cloud,reboot;uart=2400,8,1,NONE;spacing_ms=850;queue=4".
 // A future integration version can probe this once to detect the virtual bridge;
 // factory collectors answer the query differently (empty/garbage), so absence of
 // this exact "esp-collector," prefix means "factory".

components/eybond_collector/eybond_collector.cpp

@@ -6,6 +6,8 @@
 #include <cstdio>
 #include <cstdlib>
 
+#include <Arduino.h>
+
 #include "esphome/core/helpers.h"
 #include "esphome/core/log.h"
 #include "esphome/components/network/util.h"
@@ -43,6 +45,9 @@ void EybondCollector::setup() {
     this->write_status_led_(false);
   }
 
+  baud_pref_ = global_preferences->make_preference<uint32_t>(BAUD_PREF_HASH);
+  this->restore_persisted_baud_rate_();
+
   eybond::CollectorProfile profile;
   uint8_t mac[6];
   get_mac_address_raw(mac);
@@ -112,6 +117,7 @@ void EybondCollector::loop() {
       tcp_up_ = false;
       core_->on_tcp_closed(now);
     }
+    this->process_reboot_(now);
     this->update_status_led_(now);
     return;
   }
@@ -172,6 +178,7 @@ void EybondCollector::loop() {
   core_->loop(millis());
   this->process_pending_connect_();
   this->process_wifi_apply_(millis());
+  this->process_reboot_(millis());
   this->poll_wifi_scan_(millis());
   this->update_status_led_(millis());
 }
@@ -230,7 +237,11 @@ uint8_t EybondCollector::set_param(uint8_t parameter, const std::string &value)
     pending_endpoint_ = value;
     return 0;
   }
-  if (parameter == 29) {  // system_operation: commit ALL staged changes
+  if (parameter == 29) {  // system_operation: commit staged changes or restart
+    bool had_staged = !pending_endpoint_.empty();
+#ifdef USE_WIFI
+    had_staged = had_staged || !pending_wifi_ssid_.empty() || !pending_wifi_password_.empty();
+#endif
     bool committed = false;
     if (!pending_endpoint_.empty()) {
       std::string host;
@@ -249,7 +260,14 @@ uint8_t EybondCollector::set_param(uint8_t parameter, const std::string &value)
       committed = true;
     }
 #endif
-    return committed ? 0 : 1;  // refuse only when nothing was staged
+    if (committed) {
+      return 0;
+    }
+    if (had_staged) {
+      return 1;  // staged but invalid/incomplete; do not reinterpret as restart
+    }
+    this->request_reboot_(millis());
+    return 0;
   }
 #ifdef USE_WIFI
   switch (parameter) {
@@ -330,6 +348,7 @@ void EybondCollector::apply_uart(const std::string &value) {
   if (!this->reconfigure_uart_(s.baud, s.data_bits, s.stop_bits, parity)) {
     return;
   }
+  this->persist_baud_rate_(s.baud);
   if (core_ != nullptr) {
     core_->update_uart_description(this->uart_settings_string_());
   }
@@ -347,6 +366,7 @@ bool EybondCollector::apply_baud_rate(uint32_t baud) {
   if (!this->reconfigure_uart_(baud, u->get_data_bits(), u->get_stop_bits(), u->get_parity())) {
     return false;
   }
+  this->persist_baud_rate_(baud);
   if (core_ != nullptr) {
     core_->update_uart_description(this->uart_settings_string_());
   }
@@ -358,6 +378,32 @@ bool EybondCollector::apply_baud_rate(uint32_t baud) {
 
 uint32_t EybondCollector::current_baud_rate() const { return this->parent_->get_baud_rate(); }
 
+void EybondCollector::restore_persisted_baud_rate_() {
+  uint32_t saved = 0;
+  if (!baud_pref_.load(&saved) || saved == 0) {
+    return;
+  }
+  if (!this->baud_supported_(saved)) {
+    ESP_LOGW(TAG, "Ignoring unsupported persisted inverter UART baud rate %u", static_cast<unsigned>(saved));
+    return;
+  }
+  auto *u = this->parent_;
+  if (!this->reconfigure_uart_(saved, u->get_data_bits(), u->get_stop_bits(), u->get_parity())) {
+    ESP_LOGW(TAG, "Persisted inverter UART baud rate %u cannot be applied on this platform",
+             static_cast<unsigned>(saved));
+    return;
+  }
+  ESP_LOGI(TAG, "Restored inverter UART baud rate %u", static_cast<unsigned>(saved));
+}
+
+void EybondCollector::persist_baud_rate_(uint32_t baud) {
+  if (!baud_pref_.save(&baud)) {
+    ESP_LOGW(TAG, "Failed to persist inverter UART baud rate %u", static_cast<unsigned>(baud));
+    return;
+  }
+  global_preferences->sync();
+}
+
 void EybondCollector::process_wifi_apply_(uint32_t now) {
 #ifdef USE_WIFI
   if (!wifi_apply_requested_ || static_cast<int32_t>(now - wifi_apply_at_ms_) < 0) {
@@ -374,6 +420,21 @@ void EybondCollector::process_wifi_apply_(uint32_t now) {
 #endif
 }
 
+void EybondCollector::request_reboot_(uint32_t now) {
+  reboot_requested_ = true;
+  reboot_at_ms_ = now + 1500;
+  ESP_LOGI(TAG, "Collector restart requested; rebooting after response flush");
+}
+
+void EybondCollector::process_reboot_(uint32_t now) {
+  if (!reboot_requested_ || static_cast<int32_t>(now - reboot_at_ms_) < 0) {
+    return;
+  }
+  reboot_requested_ = false;
+  ESP_LOGI(TAG, "Restarting collector");
+  ESP.restart();
+}
+
 void EybondCollector::poll_wifi_scan_(uint32_t now) {
   (void) now;
   if (!wifi_scan_running_) {

components/eybond_collector/eybond_collector.h

@@ -41,6 +41,7 @@ struct PersistedEndpoint {
 } PACKED;
 
 static const uint32_t ENDPOINT_PREF_HASH = 0xE7B0'DC01;
+static const uint32_t BAUD_PREF_HASH = 0xE7B0'DC02;
 
 class EybondCollector : public Component, public uart::UARTDevice, private eybond::CollectorCore::Actions
 #ifdef USE_EYBOND_BLE
@@ -98,12 +99,16 @@ class EybondCollector : public Component, public uart::UARTDevice, private eybon
 
   void process_pending_connect_();
   void process_wifi_apply_(uint32_t now);
+  void request_reboot_(uint32_t now);
+  void process_reboot_(uint32_t now);
   void poll_wifi_scan_(uint32_t now);
   void configure_fallback_ap_(const std::string &pn);
   void note_activity_(uint32_t now);
   void update_status_led_(uint32_t now);
   void write_status_led_(bool on);
   std::string uart_settings_string_() const;
+  void restore_persisted_baud_rate_();
+  void persist_baud_rate_(uint32_t baud);
 
 #ifdef USE_EYBOND_BLE
   // eybond::BleProvisioning::Actions
@@ -147,19 +152,27 @@ class EybondCollector : public Component, public uart::UARTDevice, private eybon
 
   // WiFi reconfiguration via the integration's collector parameter flow:
   // FC=3 writes stage ssid (41) and password (43); FC=3 param 29 ("apply")
-  // commits them. The commit is deferred to loop() so the FC=3 response
-  // reaches HA before the STA reconnects.
+  // commits them. With nothing staged, param 29 requests collector restart.
+  // Deferred operations run from loop() so the FC=3 response reaches HA before
+  // the STA reconnects or the board reboots.
   std::string pending_wifi_ssid_;
   std::string pending_wifi_password_;
   bool wifi_apply_requested_{false};
   uint32_t wifi_apply_at_ms_{0};
 
+  // FC=3 param 29 with no staged Wi-Fi/endpoint changes is a collector restart
+  // request. Reboot is delayed so the SmartESS-compatible response frame reaches
+  // HA before the TCP link drops.
+  bool reboot_requested_{false};
+  uint32_t reboot_at_ms_{0};
+
   // Wi-Fi scan cache for FC=2 param 49 ("[ssid,rssi][ssid2,rssi2]...").
   std::string wifi_scan_cache_;
   bool wifi_scan_running_{false};
 
   // Notified after a successful runtime re-baud (keeps the select entity in sync).
   std::function<void(uint32_t)> baud_listener_;
+  ESPPreferenceObject baud_pref_;
 
   // Server-endpoint write (FC=3 param 21 staged, committed by param 29) and its
   // NVS persistence.

docs/FLASHING.md

@@ -49,7 +49,7 @@ Both presets can be used for TTL, RS232, or RS485:
 
 After flashing, the board opens a setup access point if it cannot join Wi-Fi. Connect to that access point from a phone or laptop and enter your Wi-Fi credentials.
 
-If your inverter needs another UART speed, add the bridge in EyeBond Local, open the collector **Configure** menu, choose **Change inverter UART speed**, select the speed, and confirm. The inverter connection may drop briefly while the speed changes.
+If your inverter needs another UART speed, add the bridge in EyeBond Local, open the collector **Configure** menu, choose **Change inverter UART speed**, select the speed, and confirm. On ESP8266/ESP32, the selected speed is saved and restored after reboot or power loss. The inverter connection may drop briefly while the speed changes.
 
 If your board or pins are different, use the ESPHome YAML option below.
 
@@ -190,7 +190,7 @@ Keep Home Assistant and the bridge on the same network for easiest discovery.
 
 EyeBond Local creates the collector/inverter devices.
 
-EyeBond Local can change the inverter UART speed for the custom ESP bridge from the collector **Configure** menu. Use **Change inverter UART speed**, choose the speed, and confirm. The option is shown only for this ESP bridge, not for factory collectors.
+EyeBond Local can change the inverter UART speed for the custom ESP bridge from the collector **Configure** menu. Use **Change inverter UART speed**, choose the speed, and confirm. On ESP8266/ESP32, the selected speed is saved and restored after reboot or power loss. The option is shown only for this ESP bridge, not for factory collectors.
 
 The ESPHome integration can also add the ESP board as a separate device. This gives you: