From dccddc0510cd0f319d329177543c632c83e85a07 Mon Sep 17 00:00:00 2001 From: GRHM <13894957+grayum@users.noreply.github.com> Date: Thu, 29 Oct 2026 15:13:22 +0100 Subject: [PATCH] Credit Paul and Claude AI; document backup and ESP8266 erase The Eurom ESPHome YAML was developed by Paul (@ph-wheels) alongside Claude AI (Anthropic), with code generation and coding assistance. Make this credit explicit in both READMEs, the guide and YAML comments. Preserve the maintainer-provided legacy 2 MiB backup command, add its esptool 5.x equivalent, and distinguish a fixed read length from measured flash capacity and the existing 1 MiB board profile. Document an optional full erase only after verified backup, correcting the supplied target from ESP32 to ESP8266. Validation: ESPHome 2026.10.1 configuration validation and C++ generation passed; YAML settings are semantically unchanged; links, command help and whitespace checked. No hardware read, erase, flash or restore operation was performed. Co-authored-by: Paul --- README.md | 2 +- esphome/eurom-mon-soleil-dsp/CHANGELOG.md | 2 + esphome/eurom-mon-soleil-dsp/README.md | 6 +- esphome/eurom-mon-soleil-dsp/TESTING.md | 2 + .../eurom-mon-soleil-dsp/TYWE1S_flashing.txt | 62 +++++++++++++++++-- .../eurom-mon-soleil-dsp/eurom-400-wifi.yaml | 4 +- 6 files changed, 70 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index c0a4876..84fb3ee 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,6 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for contributions and [AGENTS.md](AGENTS. Developed and maintained by [Graham van der Wielen](https://github.com/grayum). -Created with assistance from ChatGPT & Codex (OpenAI). AI-assisted changes still require human review and appropriate validation. +The Eurom ESPHome YAML was developed by [Paul (@ph-wheels)](https://github.com/ph-wheels) alongside Claude AI (Anthropic), with code generation and coding assistance. Repository preparation and documentation also received assistance from ChatGPT & Codex (OpenAI). AI-assisted changes still require human review and appropriate validation. Original project code, configuration, documentation and contributed photographs are provided under the [MIT License](LICENSE), except third-party names and marks. Eurom, ESPHome and Home Assistant are the property of their respective owners. This is an independent community project with no manufacturer endorsement. diff --git a/esphome/eurom-mon-soleil-dsp/CHANGELOG.md b/esphome/eurom-mon-soleil-dsp/CHANGELOG.md index af38894..2323aea 100644 --- a/esphome/eurom-mon-soleil-dsp/CHANGELOG.md +++ b/esphome/eurom-mon-soleil-dsp/CHANGELOG.md @@ -2,6 +2,8 @@ ## Unreleased - TYWE1S documentation contribution 2026-10-29 +- Credited Paul for developing the ESPHome YAML alongside Claude AI (Anthropic), including code generation and coding assistance; retained his co-author attribution. +- Preserved the subsequently supplied original 2 MiB backup command with legacy/current esptool examples and a flash-capacity/profile check. Added an optional post-backup erase step with the ESP8266 target corrected from the supplied ESP32 example. - Added Paul-contributed `TYWE1S_flashing.txt` and the approved carrier-board `images/pinout.png`, with development credit linking to @ph-wheels. - Corrected spelling and clarified board pin numbering, crossed UART connections, the carrier's separate 5 V supply and 3.3 V TTL signaling, manual bootloader entry, browser serial installation and reconnection. - Added a documentation-sourced full-flash backup procedure with two reads and comparison; it was absent from the original notes and remains untested on the heater. Restoration remains open. diff --git a/esphome/eurom-mon-soleil-dsp/README.md b/esphome/eurom-mon-soleil-dsp/README.md index d06a9d9..585bfa9 100644 --- a/esphome/eurom-mon-soleil-dsp/README.md +++ b/esphome/eurom-mon-soleil-dsp/README.md @@ -41,7 +41,7 @@ The board (`esp01_1m`), RX GPIO13, TX GPIO15 and 9600 baud are retained from the ## TYWE1S carrier-board connections and initial flashing -Read the complete [connecting, backup and flashing instructions](TYWE1S_flashing.txt) before proceeding. The original notes and drawing were contributed by [Paul (@ph-wheels)](https://github.com/ph-wheels); spelling, sequencing and explanations were edited for this project. The original text did not include backup commands; the added esptool procedure is explicitly labelled as documentation guidance awaiting a hardware test record. +Read the complete [connecting, backup and flashing instructions](TYWE1S_flashing.txt) before proceeding. The original notes and drawing were contributed by [Paul (@ph-wheels)](https://github.com/ph-wheels); spelling, sequencing and explanations were edited for this project. The original text did not include backup commands; the maintainer subsequently supplied the original 2 MiB backup command. The guide preserves that legacy example alongside modern esptool syntax and a two-read verification procedure, with physical testing still outstanding. ![Paul-contributed TYWE1S carrier-board pinout, with a four-pin connector at left and programming pads at top](images/pinout.png) @@ -65,6 +65,8 @@ The carrier must be disconnected from the heater and all its wiring before conne **Back up before flashing:** the guide detects flash size, reads the full factory flash twice and compares the results. Matching reads check consistency, not recoverability; restoration has not been tested. Dumps may contain credentials, and they belong in private storage outside this repository. A Wi-Fi-module dump does not back up a separate heater MCU or establish how all timer settings are stored. +The original backup example reads `0x200000` bytes (2 MiB). That is a supplied example, not a confirmed flash-capacity measurement; check `flash-id` and the existing `esp01_1m` (1 MiB) profile before proceeding. The guide also documents an **optional, destructive full erase after backup verification**, targeted at `esp8266`. The supplied `--chip esp32` erase command does not target this TYWE1S/ESP8266 device and is identified as a correction in the notes. Ordinary installation already erases sectors it writes; a separate full erase is not a routine update step. + ## Setup in ESPHome Device Builder 1. Back up your current **local ESPHome YAML and secrets** before editing. For a matching TYWE1S carrier still running stock firmware, first read the [connection and flashing guide](TYWE1S_flashing.txt), verify the actual board and make a private factory flash backup before any installation. Other modules/revisions are not covered by that contribution. @@ -114,4 +116,4 @@ Photographs supplied by the maintainer show the controls of the test unit; they - [ESPHome Tuya MCU](https://esphome.io/components/tuya/), [Tuya climate](https://esphome.io/components/climate/tuya/) and [encrypted OTA](https://esphome.io/components/ota/esphome/). - [Espressif esptool commands](https://docs.espressif.com/projects/esptool/en/latest/esp8266/esptool/basic-commands.html), [manual reset options](https://docs.espressif.com/projects/esptool/en/latest/esp8266/esptool/advanced-options.html) and [ESP8266 boot mode selection](https://docs.espressif.com/projects/esptool/en/latest/esp8266/advanced-topics/boot-mode-selection.html) support the documentation-added backup procedure. -Developed by [Graham van der Wielen](https://github.com/grayum) and [Paul (@ph-wheels)](https://github.com/ph-wheels). Maintained by Graham van der Wielen. Paul contributed the original TYWE1S connection/flashing instructions and carrier-board pinout. Created with assistance from ChatGPT & Codex (OpenAI). Independent community project; not affiliated with Eurom. See the repository [MIT License](../../LICENSE). +Developed by [Graham van der Wielen](https://github.com/grayum) and [Paul (@ph-wheels)](https://github.com/ph-wheels). Paul developed the ESPHome YAML alongside **Claude AI (Anthropic)**, which provided code generation and coding assistance; he also contributed the original TYWE1S connection/flashing instructions and carrier-board pinout. Repository maintenance and documentation integration are by Graham van der Wielen, with assistance from ChatGPT & Codex (OpenAI). Independent community project; not affiliated with Eurom. See the repository [MIT License](../../LICENSE). diff --git a/esphome/eurom-mon-soleil-dsp/TESTING.md b/esphome/eurom-mon-soleil-dsp/TESTING.md index 5e896c0..0d4f866 100644 --- a/esphome/eurom-mon-soleil-dsp/TESTING.md +++ b/esphome/eurom-mon-soleil-dsp/TESTING.md @@ -79,3 +79,5 @@ Time zone is normally inferred from the build environment when it is not set in Paul (@ph-wheels) supplied connection/initial-flashing notes and a numbered carrier-board drawing through the maintainer. Editing corrects typos (including TYME1S → TYWE1S), clarifies 3.3 V UART logic versus the carrier's 5 V input, and adds a full-flash backup/readback comparison procedure based on Espressif's documentation. Backup commands were absent from the source contribution; they are not presented as a completed device test. The pin table was checked against the supplied drawing and the original connection notes. No voltage, isolation, connector-to-GPIO, flash-read, flash-write or restoration test was performed during this documentation edit. No heater-control YAML or validation-tooling behavior was changed. Record those hardware results before closing the remaining installation/recovery TODOs. + +The maintainer subsequently supplied the original legacy `read_flash` command with a 2 MiB length and an erase example. The guide preserves the backup example, supplies modern syntax, flags the unresolved 2 MiB read versus 1 MiB board-profile distinction, and corrects the erase target from ESP32 to ESP8266. A full erase is optional and follows verified backup; no erase was performed. YAML comments and credits now attribute Paul's development work alongside Claude AI (Anthropic); no functional YAML setting changed. diff --git a/esphome/eurom-mon-soleil-dsp/TYWE1S_flashing.txt b/esphome/eurom-mon-soleil-dsp/TYWE1S_flashing.txt index 52af459..ebd6df8 100644 --- a/esphome/eurom-mon-soleil-dsp/TYWE1S_flashing.txt +++ b/esphome/eurom-mon-soleil-dsp/TYWE1S_flashing.txt @@ -2,14 +2,17 @@ Eurom Mon Soleil DSP: connecting, backing up and flashing a TYWE1S carrier board Development, original connection/flashing notes and pinout contribution: Paul (https://github.com/ph-wheels). +Paul developed the ESPHome YAML alongside Claude AI (Anthropic), with code +generation and coding assistance. Editing and integration: Graham van der Wielen, with ChatGPT & Codex assistance. The pin numbers below refer to the CARRIER BOARD in images/pinout.png, not the pins of a bare TYWE1S module. Use the drawing's orientation and numbering. The contribution is board-specific; PCB revisions and other heater models have -not been independently checked. The backup commands in section 4 were added -during documentation review using Espressif's esptool documentation. They were -not present in the original notes and have not been tested on this heater. +not been independently checked. Section 4 preserves the original 2 MiB backup +command subsequently supplied by the maintainer, alongside current esptool +syntax and documentation-added verification steps. Backup and erase hardware +tests have not been performed during this documentation review. 1. Before connecting anything @@ -88,6 +91,28 @@ Enter the bootloader as in section 3, then detect the flash size: python -m esptool --chip esp8266 --port "$EUROM_PORT" --baud 115200 --before no-reset --after no-reset flash-id Record the detected size privately. Do not infer it from esp01_1m in the YAML. +The maintainer supplied this ORIGINAL backup command, using legacy esptool.py +and underscore command spelling. Run it only with a compatible older esptool +installation, from a private backup directory outside the repository, and +only if the detected capacity is exactly 2 MiB: + + esptool.py -b 115200 --chip esp8266 --port /dev/tty.usbserial-0001 read_flash 0x000000 0x200000 eurom_original_2M_2.bin + +Here 0x200000 = 2,097,152 bytes (2 MiB). The serial port is an example and must +match the actual adapter. This command does not itself establish the flash +size or prove recovery. A 2 MiB flash chip and the YAML's esp01_1m (1 MiB) +profile must be reviewed separately; do not infer the right profile from a +backup filename. For other detected capacities, use the full-size ALL reads +below rather than a fixed 2 MiB read. + +The equivalent esptool 5.x command, using the same section 3 manual bootloader +entry and a private current directory, is: + + python3 -m esptool --chip esp8266 --port "$EUROM_PORT" --baud 115200 --before no-reset --after no-reset read-flash 0x000000 0x200000 eurom_original_2M_2.bin + +Use either syntax with the matching installed tool, not both to the same file. +These single-read examples do not replace the two-read comparison below. + Create a NEW private backup directory outside the repository: EUROM_BACKUP_DIR="$(mktemp -d "$HOME/eurom-factory-backup.XXXXXX")" @@ -110,7 +135,36 @@ size matches flash-id's detected capacity. Two matching reads check readback consistency; they do not prove restoration. Store a protected second copy elsewhere and record model/article number, module/PCB revision if known, detected flash size, tool version and date. Restoration testing remains TODO; -no erase or restore commands are supplied by this contribution. +no restoration procedure is supplied by this contribution. + +4a. Optional full erase AFTER backup verification + +A full erase destroys the current firmware and flash-stored settings. It is +not a backup command, and is not required for every ESPHome installation: +normal flashing erases the sectors being written. Use this optional step only +as a deliberate clean-install/troubleshooting operation after the full backup +and comparison above succeeded, a protected copy exists elsewhere, and the +correct replacement firmware has already been prepared and compiled. +Complete section 5 first, then return here if a full erase is needed. After +erasing, proceed to the serial installation in section 6. + +The maintainer's supplied erase example used "--chip esp32 erase_flash". +That targets an ESP32; this TYWE1S project uses an ESP8266. The command below +corrects the target and uses esptool 5.x's hyphenated erase-flash spelling. +Re-enter the serial bootloader (section 3) and confirm EUROM_PORT identifies +the intended, isolated carrier board before running: + + python3 -m esptool --chip esp8266 --port "$EUROM_PORT" --baud 115200 --before no-reset --after no-reset erase-flash + +For an older esptool version that requires underscore spelling, the corrected +equivalent is: + + python3 -m esptool --chip esp8266 --port "$EUROM_PORT" --baud 115200 --before no_reset --after no_reset erase_flash + +Use the spelling supported by the installed version; do not run both examples. +After erasing, the board will not boot its previous firmware or join Wi-Fi. +Continue with the prepared serial installation in sections 5-6; after a full +erase there is no running ESPHome firmware to accept an OTA installation. 5. Prepare ESPHome Device Builder diff --git a/esphome/eurom-mon-soleil-dsp/eurom-400-wifi.yaml b/esphome/eurom-mon-soleil-dsp/eurom-400-wifi.yaml index 91e0543..b9cddc4 100644 --- a/esphome/eurom-mon-soleil-dsp/eurom-400-wifi.yaml +++ b/esphome/eurom-mon-soleil-dsp/eurom-400-wifi.yaml @@ -1,4 +1,6 @@ # Eurom Mon Soleil DSP 400 WiFi - ESPHome via Tuya MCU protocol +# YAML developed by Paul (@ph-wheels) alongside Claude AI (Anthropic), +# with code generation and coding assistance. See README.md for full credits. # Tuya product id: wv9d5ocs76u6maqj # # Maintainer-reported datapoints (logs + button tests, 2026-10-28). @@ -121,4 +123,4 @@ text_sensor: bssid: name: ESP Connected BSSID mac_address: - name: ESP Mac Wifi Address \ No newline at end of file + name: ESP Mac Wifi Address