Release 0.1.10: add unified device configuration

Author: Maksym Shtembuliak

.github/workflows/ci.yml

@@ -20,28 +20,11 @@ jobs:
       - name: Host tests
         run: make -C host_tests test
       - name: Validate YAML and docs links
-        run: |
-          python - <<'PY'
-          from pathlib import Path
-          import re
-          import yaml
-
-          class Loader(yaml.SafeLoader):
-              pass
-          Loader.add_constructor("!secret", lambda loader, node: loader.construct_scalar(node))
-          for path in sorted(Path("examples").glob("*.yaml")):
-              if path.name == "secrets.yaml":
-                  raise SystemExit("examples/secrets.yaml must not be committed")
-              yaml.load(path.read_text(), Loader=Loader)
-
-          link_re = re.compile(r"\[[^\]]+\]\(([^)]+)\)")
-          for path in [Path("README.md"), Path("README.uk.md"), *Path("docs").glob("*.md")]:
-              for match in link_re.finditer(path.read_text()):
-                  target = match.group(1).split("#", 1)[0]
-                  if not target or "://" in target:
-                      continue
-                  if not (path.parent / target).exists():
-                      raise SystemExit(f"{path}: broken link {target}")
-          PY
-      - name: Compile release presets
-        run: python tools/build_web_release.py --compile --local-source --version ci
+        run: python tools/validate_repo.py
+      - name: Compile release presets and YAML-only profiles
+        run: >-
+          python tools/build_web_release.py
+          --compile
+          --compile-yaml-profiles
+          --local-source
+          --version ci

.github/workflows/release.yml

@@ -28,14 +28,34 @@ jobs:
         run: python -m pip install "esphome==${ESPHOME_VERSION}" pyyaml
       - name: Host tests
         run: make -C host_tests test
+      - name: Validate YAML and docs links
+        run: python tools/validate_repo.py
       - name: Build web release
-        run: python tools/build_web_release.py --compile --local-source --version "${GITHUB_REF_NAME}"
+        run: >-
+          python tools/build_web_release.py
+          --compile
+          --compile-yaml-profiles
+          --local-source
+          --version "${GITHUB_REF_NAME}"
+      - name: Generate checksums
+        run: |
+          cd dist/web-release/web
+          for file in firmware/*.bin manifest-*.json; do
+            sha256sum "$file" | sed 's#  firmware/#  #'
+          done > ../SHA256SUMS
+      - name: Render release notes
+        run: >-
+          python tools/render_release_notes.py
+          "${GITHUB_REF_NAME}"
+          --output dist/web-release/RELEASE_NOTES.md
       - name: Upload release artifacts
         uses: softprops/action-gh-release@v3
         with:
+          body_path: dist/web-release/RELEASE_NOTES.md
           files: |
             dist/web-release/web/firmware/*.bin
             dist/web-release/web/manifest-*.json
+            dist/web-release/SHA256SUMS
       - name: Upload Pages artifact
         uses: actions/upload-pages-artifact@v5
         with:

CHANGELOG.md

@@ -4,6 +4,54 @@ All notable changes to this project are documented here. The format is based on
 [Keep a Changelog](https://keepachangelog.com/), and this project adheres to
 [Semantic Versioning](https://semver.org/).
 
+## [0.1.10] - 2026-07-10
+
+### Added
+- **Unified local configuration page.** `/` now combines Wi-Fi provisioning,
+  Home Assistant endpoint settings, complete inverter UART framing and web OTA.
+  It is available on both the normal LAN address and `192.168.4.1` in setup mode.
+- **Complete persisted UART framing.** ESP8266 and ESP32 now persist data bits,
+  parity and stop bits together with baud rate. Existing baud-only preferences
+  migrate automatically. On BK72xx, UART settings remain build-time-only and can
+  be changed only by rebuilding and reflashing the firmware.
+- **Hardware identity overview.** The page shows the compiled TX/RX and RS485
+  direction/status/communication LED pins, collector PN and ESPHome hostname.
+  Build-time fields remain read-only until a platform-safe boot-time
+  hardware-profile mechanism is available.
+- **Interactive Wi-Fi scan.** Nearby networks retain the stock captive-portal
+  behavior: SSID, a signal-strength indicator and lock state are displayed, and
+  selecting a row copies its SSID into the Wi-Fi form. Exact RSSI is available
+  from the indicator tooltip. The configured network remains visible and is
+  clearly marked as connected or currently unavailable.
+- **Configurable collector PN.** The default PN remains protected by a checked
+  toggle. Disabling it allows a validated custom PN; re-enabling it restores the
+  default. Identity changes are persisted and applied after a safe restart.
+- **Local page translations.** English, Ukrainian and Russian can be selected on
+  the device page. The browser remembers the selected language.
+- **ESPHome Dashboard adoption.** Ready-made ESP8266, ESP32 and BK72xx builds
+  publish project metadata and a board-specific `dashboard_import` package over
+  mDNS. The Dashboard can create a local YAML for a device flashed from a
+  prebuilt binary; no server-specific ownership key is required.
+- **UART / RS485 diagnostics.** The local page shows passive live counters for
+  transmitted bytes and requests, total physical receive bytes and the age of
+  the last TX/RX activity. Developer-only response/stale counters remain in the
+  diagnostics JSON. Counters reset at boot and never influence transport behavior.
+- **Dark and light themes.** The local page uses the dark theme by default and
+  remembers the user's theme toggle alongside the language preference.
+
+### Fixed
+- The always-on local web server is initialized only after the network stack is
+  ready. Starting AsyncTCP from the component's pre-Wi-Fi setup priority caused
+  an ESP32 boot loop; captive-portal registration remains available before Wi-Fi.
+
+### Changed
+- Collector identity, Home Assistant endpoint and UART framing now have separate
+  save actions. PN changes require explicit browser confirmation and explain the
+  Home Assistant re-add requirement.
+- UART persistence wording now explicitly states that settings are stored in
+  non-volatile device memory and used after every restart.
+- `BRIDGE_VERSION` bumped to `0.1.10`.
+
 ## [0.1.8] - 2026-07-04
 
 ### Fixed
@@ -114,6 +162,8 @@ Home Assistant integration. Highlights:
 - Status LED indication and the `AT+VDTU` virtual-bridge capability probe.
 - Web installer (GitHub Pages) for the ESP8266 and ESP32 presets.
 
+[0.1.10]: https://github.com/groove-max/esp-eybond-collector/compare/v0.1.8...v0.1.10
+[0.1.8]: https://github.com/groove-max/esp-eybond-collector/compare/v0.1.7...v0.1.8
 [0.1.7]: https://github.com/groove-max/esp-eybond-collector/compare/v0.1.6...v0.1.7
 [0.1.6]: https://github.com/groove-max/esp-eybond-collector/compare/v0.1.5...v0.1.6
 [0.1.5]: https://github.com/groove-max/esp-eybond-collector/compare/v0.1.4...v0.1.5

README.md

@@ -176,13 +176,47 @@ For the custom ESP bridge, EyeBond Local also exposes **Change inverter UART spe
 
 ---
 
-## Wi-Fi changes
+## Local settings page
 
-The bridge can use normal ESPHome Wi-Fi setup and captive portal behavior. When it opens the setup portal, its temporary Wi-Fi network is named like its virtual collector PN, for example `V00000...`.
+Once the collector is connected to your network, open
+`http://<collector-ip>/`. If it cannot join Wi-Fi, connect to its temporary
+`V00000...` network and open `http://192.168.4.1/` instead. Both addresses show
+the same settings page.
+
+From this page you can:
+
+- choose a Wi-Fi network and enter its password;
+- set the Home Assistant server address and port;
+- view or change the collector PN;
+- check the UART pins and change the inverter UART settings;
+- see whether data is moving over UART / RS485;
+- install a firmware update over the network.
+
+Each section has its own **Save** button. Before changing the PN, server address
+or UART settings, the page explains how that change can affect Home Assistant or
+the inverter connection. Nearby Wi-Fi networks show signal strength and security;
+the network currently configured on the collector is highlighted.
+
+UART settings can be changed directly on ESP8266 and ESP32. They are stored in
+flash and remain in use after a restart. On BK72xx they are shown for reference;
+to change them, edit the YAML and flash the board again. The page is available in
+English, Ukrainian and Russian, with a light or dark theme.
+
+For a custom YAML, enable the page with `web_configuration: true` under
+`eybond_collector:` and include `captive_portal:`.
+
+### Add a prebuilt collector to ESPHome Dashboard
+
+You do not need a pairing key. If ESPHome Device Builder is on the same network
+and can receive mDNS traffic, it should show the collector as a discovered
+device. Click **Adopt** and ESPHome will create a local YAML using the package for
+the matching board. Review the board and pin assignment before installing an
+update from that YAML.
 
 EyeBond Local can also change collector Wi-Fi settings for the bridge. If the new credentials are wrong, the bridge should fall back to its setup portal instead of becoming permanently unreachable.
 
-The nearby-network list can show only the current network on the first read. Refresh after a few seconds to see the full scan result.
+The first Wi-Fi scan may show only the current network. Refresh the page after a
+few seconds if the full list has not appeared yet.
 
 ---
 

README.uk.md

@@ -176,13 +176,48 @@ select:
 
 ---
 
-## Зміна Wi-Fi
+## Локальна сторінка налаштувань
 
-Міст підтримує звичайне налаштування Wi-Fi через ESPHome і сторінку налаштування. Коли міст відкриває сторінку налаштування, його тимчасова Wi-Fi-мережа має назву як віртуальний PN колектора, наприклад `V00000...`.
+Коли колектор підключиться до вашої мережі, відкрийте
+`http://<ip-колектора>/`. Якщо підключитися до Wi-Fi не вдалося, приєднайтеся до
+тимчасової мережі з назвою на кшталт `V00000...` і відкрийте
+`http://192.168.4.1/`. В обох випадках відкриється та сама сторінка.
+
+На ній можна:
+
+- обрати Wi-Fi-мережу та ввести пароль;
+- вказати адресу й порт сервера Home Assistant;
+- переглянути або змінити PN колектора;
+- перевірити UART-піни та налаштувати зв’язок з інвертором;
+- побачити, чи надходять і передаються дані через UART / RS485;
+- оновити прошивку через мережу.
+
+Кожен блок має окрему кнопку **Зберегти**. Перед зміною PN, адреси сервера або
+UART сторінка попередить, як це може вплинути на зв’язок з Home Assistant чи
+інвертором. У списку Wi-Fi видно рівень сигналу та захист мережі, а поточну
+мережу колектора виділено окремо.
+
+На ESP8266 та ESP32 параметри UART можна змінити прямо на сторінці. Вони
+зберігаються у flash-пам’яті й не втрачаються після перезапуску. На BK72xx ці
+параметри можна лише переглянути: для зміни потрібно відредагувати YAML і знову
+прошити плату. Доступні українська, англійська та російська мови, а також світла
+і темна теми.
+
+У власному YAML сторінка вмикається через `web_configuration: true` у
+`eybond_collector:` і потребує секції `captive_portal:`.
+
+### Додавання готового колектора до ESPHome Dashboard
+
+Ключ прив’язки не потрібен. Якщо ESPHome Device Builder працює в тій самій
+мережі й отримує mDNS-повідомлення, він покаже колектор серед знайдених
+пристроїв. Натисніть **Adopt** — ESPHome створить локальний YAML із пакетом для
+відповідної плати. Перед першим оновленням перевірте тип плати та призначення
+пінів.
 
 EyeBond Local також може змінювати Wi-Fi-налаштування моста. Якщо нові дані неправильні, міст має перейти на сторінку налаштування, а не зникнути назавжди.
 
-Список мереж може спочатку показати тільки поточну мережу. Оновіть через кілька секунд, щоб побачити повний результат сканування.
+Під час першого сканування може відобразитися лише поточна мережа. Якщо повний
+список не з’явився, оновіть сторінку за кілька секунд.
 
 ---
 

components/eybond_collector/__init__.py

@@ -13,7 +13,7 @@
 import esphome.final_validate as fv
 from esphome import pins
 from esphome.components import uart
-from esphome.const import CONF_ID
+from esphome.const import CONF_ID, CONF_NUMBER, CONF_RX_PIN, CONF_TX_PIN, CONF_UART_ID
 from esphome.core import CORE
 
 CODEOWNERS = ["@groove-max"]
@@ -33,6 +33,7 @@
 CONF_STATUS_LED_PIN = "status_led_pin"
 CONF_COM_LED_PIN = "com_led_pin"
 CONF_BLE_PROVISIONING = "ble_provisioning"
+CONF_WEB_CONFIGURATION = "web_configuration"
 
 eybond_collector_ns = cg.esphome_ns.namespace("eybond_collector")
 EybondCollector = eybond_collector_ns.class_("EybondCollector", cg.Component, uart.UARTDevice)
@@ -68,6 +69,7 @@ def _validate_pn(value):
             cv.Optional(CONF_STATUS_LED_PIN): pins.gpio_output_pin_schema,
             cv.Optional(CONF_COM_LED_PIN): pins.gpio_output_pin_schema,
             cv.Optional(CONF_BLE_PROVISIONING, default=False): cv.boolean,
+            cv.Optional(CONF_WEB_CONFIGURATION, default=False): cv.boolean,
         }
     )
     .extend(cv.COMPONENT_SCHEMA)
@@ -77,20 +79,24 @@ def _validate_pn(value):
 
 
 def _final_validate(config):
-    """ble_provisioning needs ESP32 BLE and the esp32_ble_server GATT server."""
-    if not config.get(CONF_BLE_PROVISIONING):
-        return config
-    if not CORE.is_esp32:
-        raise cv.Invalid(
-            "ble_provisioning is only supported on ESP32 (it needs on-chip BLE); "
-            "ESP8266 and BK72xx/LibreTiny have no usable BLE server."
-        )
     full_config = fv.full_config.get()
-    if "esp32_ble_server" not in full_config:
+    if config.get(CONF_BLE_PROVISIONING):
+        if not CORE.is_esp32:
+            raise cv.Invalid(
+                "ble_provisioning is only supported on ESP32 (it needs on-chip BLE); "
+                "ESP8266 and BK72xx/LibreTiny have no usable BLE server."
+            )
+        if "esp32_ble_server" not in full_config:
+            raise cv.Invalid(
+                "ble_provisioning requires an 'esp32_ble_server:' entry in your YAML — "
+                "it provides the BLE GATT server the bridge attaches to. Add an empty "
+                "'esp32_ble_server:' block (see examples/esp32-ble.yaml)."
+            )
+    if config.get(CONF_WEB_CONFIGURATION) and "captive_portal" not in full_config:
         raise cv.Invalid(
-            "ble_provisioning requires an 'esp32_ble_server:' entry in your YAML — "
-            "it provides the BLE GATT server the bridge attaches to. Add an empty "
-            "'esp32_ble_server:' block (see examples/esp32-ble.yaml)."
+            "web_configuration requires a 'captive_portal:' entry; the settings "
+            "page reuses its stock Wi-Fi setup handlers on both the normal LAN "
+            "and the fallback access point"
         )
     return config
 
@@ -103,6 +109,21 @@ async def to_code(config):
     await cg.register_component(var, config)
     await uart.register_uart_device(var, config)
 
+    # Keep the generated UART component authoritative. These values are only
+    # metadata for the local configuration page; arbitrary pin remapping is not
+    # universally reloadable by ESPHome's platform UART implementations.
+    uart_tx_pin = -1
+    uart_rx_pin = -1
+    for uart_config in CORE.config.get("uart", []):
+        if uart_config.get(CONF_ID) != config[CONF_UART_ID]:
+            continue
+        if CONF_TX_PIN in uart_config:
+            uart_tx_pin = uart_config[CONF_TX_PIN][CONF_NUMBER]
+        if CONF_RX_PIN in uart_config:
+            uart_rx_pin = uart_config[CONF_RX_PIN][CONF_NUMBER]
+        break
+    cg.add(var.set_uart_pin_numbers(uart_tx_pin, uart_rx_pin))
+
     if CONF_PN in config:
         cg.add(var.set_pn(config[CONF_PN]))
     cg.add(var.set_udp_port(config[CONF_UDP_PORT]))
@@ -126,3 +147,6 @@ async def to_code(config):
     if config[CONF_BLE_PROVISIONING]:
         cg.add_define("USE_EYBOND_BLE")
         cg.add(var.set_ble_provisioning(True))
+    if config[CONF_WEB_CONFIGURATION]:
+        cg.add_define("USE_EYBOND_WEB_CONFIG")
+        cg.add(var.set_web_configuration(True))