tasmota-webserial-esptool 6.5.4 → 7.0.1

package/README.md

@@ -1,8 +1,8 @@
-# Fork of Adafruit WebSerial ESPTool
+# WebSerial ESPTool
 
-JavaScript package to install firmware on ESP devices via the browser using WebSerial.
+JavaScript package to install and make backups of firmwares on ESP devices via the browser using WebSerial.
 
-This fork is **not** based on esptool.js
+WebSerial ESPTool is **not** based on esptool.js
 
 
 ## Local development
@@ -16,5 +16,6 @@ This fork is **not** based on esptool.js
 
 This project was originally written by [Melissa LeBlanc-Williams](https://github.com/makermelissa). [Nabu Casa](https://www.nabucasa.com) ported the code over to TypeScript and in March 2022 took over maintenance from Adafruit. In July 2022, the Nabucasa stopped maintaining the project in favor of an official, but very early release of Espressif's [esptool-js](https://github.com/espressif/esptool-js/). Due to the instability of the tool, Adafruit updated their fork with Nabucasa's changes in November 2022 and took over maintenance once again. In December 2024, the tool was once again updated to use Espressif's esptool-js as the backend.
 Since Adafruit is slow in adding new MCUs (support for C2, C6 and H2 is from this fork) and uses now esptool.js which is still buggy, i decided to maintain my own version and do not provide PRs upstream anymore.
+In 12/2025 support for new MCUs and chip variant support for the different P4 revisions and flash read was added.
 
 Copyright: Adafruit, Nabu Casa and Johann Obermeier

package/READ_FLASH_FEATURE.md

@@ -0,0 +1,130 @@
+# Read Flash Partition Feature
+
+## Übersicht
+
+Die Read Flash Partition Funktionalität wurde erfolgreich aus esptool.js in WebSerial_ESPTool implementiert. Diese Funktion ermöglicht es, Flash-Speicher direkt vom ESP-Chip zu lesen und als Binärdatei herunterzuladen.
+
+## Implementierte Änderungen
+
+### 1. Backend (TypeScript)
+
+#### `src/const.ts`
+- Hinzugefügt: `ESP_READ_FLASH = 0xd2` Konstante
+- Hinzugefügt: `FLASH_READ_TIMEOUT = 100` Konstante
+
+#### `src/esp_loader.ts`
+- Neue Methode `readFlash()` in der `EspStubLoader` Klasse implementiert
+- Die Methode unterstützt:
+  - Lesen von Flash-Speicher ab einer bestimmten Adresse
+  - Angabe der zu lesenden Größe in Bytes
+  - Optional: Callback-Funktion für Fortschrittsanzeige
+  - Rückgabe der Daten als `Uint8Array`
+
+### 2. Frontend (HTML/JavaScript/CSS)
+
+#### `index.html`
+- Neue UI-Sektion "Read Flash" hinzugefügt mit:
+  - Eingabefeld für Adresse (hexadezimal)
+  - Eingabefeld für Größe (dezimal in Bytes)
+  - "Read Flash" Button
+  - Fortschrittsbalken
+
+#### `js/script.js`
+- Neue Funktion `clickReadFlash()` implementiert
+- Automatischer Download der gelesenen Daten als `.bin` Datei
+- Fortschrittsanzeige während des Lesevorgangs
+- Fehlerbehandlung und Logging
+
+#### `css/style.css`
+- Styling für die neue "Read Flash" Sektion
+- Responsive Layout-Anpassungen
+
+## Verwendung
+
+### Über die Web-Oberfläche
+
+#### Flash direkt lesen
+
+1. Verbinden Sie sich mit einem ESP-Gerät über den "Connect" Button
+2. Scrollen Sie zur "Read Flash" Sektion
+3. Geben Sie die Startadresse ein (z.B. `0` für den Anfang des Flash-Speichers)
+4. Geben Sie die Größe in Bytes ein (z.B. `4096` für 4KB)
+5. Klicken Sie auf "Read Flash"
+6. Die Daten werden automatisch als `.bin` Datei heruntergeladen
+
+#### Partitionstabelle lesen
+
+1. Verbinden Sie sich mit einem ESP-Gerät über den "Connect" Button
+2. Scrollen Sie zur "Partition Table" Sektion
+3. Klicken Sie auf "Read Partition Table"
+4. Die Partitionstabelle wird gelesen und angezeigt
+5. Klicken Sie auf "Download" neben einer Partition, um diese herunterzuladen
+
+### Programmatisch
+
+```typescript
+// Beispiel: 4KB vom Offset 0x0 lesen
+const data = await espStubLoader.readFlash(
+  0x0,           // Adresse
+  4096,          // Größe in Bytes
+  (packet, progress, totalSize) => {
+    // Optional: Fortschritts-Callback
+    console.log(`Progress: ${progress}/${totalSize} bytes`);
+  }
+);
+
+// data ist ein Uint8Array mit den gelesenen Daten
+```
+
+## Technische Details
+
+### Protokoll
+
+Die Implementierung folgt dem ESP Serial Protocol:
+1. Sende `ESP_READ_FLASH` Kommando mit Parametern (Adresse, Größe, Block-Größe, Anzahl Blöcke)
+2. Warte auf Bestätigung
+3. Empfange Datenpakete über SLIP-Protokoll
+4. Sende Acknowledgment nach jedem Paket
+5. Wiederhole bis alle Daten empfangen wurden
+
+### Kompatibilität
+
+Die Funktion ist nur im Stub-Modus verfügbar (nach `runStub()`), da der ROM-Bootloader diesen Befehl nicht unterstützt.
+
+Unterstützte Chips:
+- ESP32
+- ESP32-S2
+- ESP32-S3
+- ESP32-C2
+- ESP32-C3
+- ESP32-C5
+- ESP32-C6
+- ESP32-C61
+- ESP32-H2
+- ESP32-P4
+- ESP8266
+
+## Beispiel-Anwendungsfälle
+
+1. **Backup erstellen**: Kompletten Flash-Speicher sichern
+2. **Partition lesen**: Spezifische Partitionen extrahieren (z.B. NVS, OTA)
+3. **Debugging**: Flash-Inhalt zur Fehleranalyse untersuchen
+4. **Firmware-Extraktion**: Installierte Firmware vom Gerät lesen
+5. **Partitionstabelle analysieren**: Übersicht über alle Partitionen erhalten
+6. **Einzelne Partitionen sichern**: Nur bestimmte Partitionen herunterladen
+
+## Bekannte Einschränkungen
+
+- Die Funktion erfordert, dass der Stub-Loader läuft
+- Große Lesevorgänge können einige Zeit in Anspruch nehmen
+- Die maximale Größe ist durch den verfügbaren Flash-Speicher des Chips begrenzt
+
+## Build-Prozess
+
+Nach Änderungen am TypeScript-Code:
+
+```bash
+npm run prepublishOnly
+```
+
+Dies kompiliert den TypeScript-Code und erstellt die Distributionsdateien in `dist/`.

package/css/light.css

@@ -61,6 +61,17 @@ button {
   background-color: #ddd;
 }
 
+#commands button {
+  border-color: #333;
+  background-color: #fff;
+  color: #333;
+}
+
+#commands button:hover {
+  background-color: #333;
+  color: #fff;
+}
+
 #commands .buttons button {
   border-color: #333;
 }

package/css/style.css

@@ -6,26 +6,62 @@
   box-sizing: border-box;
   font-size: 16px;
   height: 85px;
-  line-height: 40px;
-  padding: 20px 70px 0px 70px; /* TRouBLe */
+  padding: 15px 70px;
   position: fixed;
   width: 100%;
   z-index: 1000;
   margin: 0;
   border-bottom: 5px solid #00a7e9;
+  display: flex;
+  justify-content: space-between;
+  align-items: center;
+  top: 0;
+  transition: transform 0.3s ease-in-out;
 }
 
-.header h1 {
-  flex: 1;
-  font-size: 20px;
-  font-weight: 400;
+.header-hidden {
+  transform: translateY(-100%);
+}
+
+.header .left {
+  display: flex;
+  align-items: center;
+}
+
+.header .title {
+  font-size: 24px;
+  font-weight: 500;
+  margin-right: 30px;
+}
+
+.header .right {
+  display: flex;
+  align-items: center;
+  gap: 15px;
+}
+
+.header .controls-row {
+  display: flex;
+  align-items: center;
+  gap: 8px;
+  margin-right: 20px;
+  padding-right: 20px;
+  border-right: 2px solid #ccc;
+}
+
+.header .controls-row label {
+  font-size: 13px;
+  margin-left: 12px;
+}
+
+.header .controls-row label:first-child {
+  margin-left: 0;
 }
 
 .header button {
   border: solid 2px #fff;
   background-color: #000;
   color: #fff;
-  margin-left: 20px;
   height: 30px;
 }
 
@@ -34,6 +70,10 @@
   color: #000;
 }
 
+.header select {
+  height: 30px;
+}
+
 button,
 .firmware {
   height: 25px;
@@ -82,7 +122,12 @@ div.clear {
 .main {
   overflow-x: hidden;
   overflow-y: auto;
-  padding-top: 80px;
+  padding-top: 90px;
+  transition: padding-top 0.3s ease-in-out;
+}
+
+.main.no-header-padding {
+  padding-top: 0;
 }
 
 .hidden {
@@ -95,32 +140,63 @@ div.clear {
   margin-bottom: 1em;
 }
 
-.subheader {
-  height: 100px;
-  line-height: 100px;
-  padding-left: 70px;
-  padding-right: 70px;
+.log-controls {
+  display: flex;
+  align-items: center;
+  gap: 8px;
+  padding-left: 12px;
+  border-left: 1px solid #ccc;
 }
 
-.subheader .title {
-  font-size: 36px;
-  font-weight: 500;
+.log-controls.hidden {
+  display: none;
+}
+
+.small-btn {
+  padding: 4px 12px;
+  font-size: 13px;
+  border-radius: 12px;
+  border-width: 2px;
+  border-style: solid;
+  cursor: pointer;
+  height: 26px;
+  line-height: 14px;
 }
 
 #app.connected #commands {
-  height: 200px;
+  height: auto;
+  max-height: 70vh;
+  overflow-y: auto;
 }
 
 #app.connected #log {
-  height: calc(100vh - 530px);
+  height: calc(100vh - 320px);
+  min-height: 200px;
+}
+
+#app.connected #log.hidden {
+  height: 0;
+  min-height: 0;
+  padding: 0;
+  border: 0;
 }
 
 #app #commands {
   height: 0;
+  overflow: hidden;
 }
 
 #app #log {
-  height: calc(100vh - 330px);
+  height: calc(100vh - 220px);
+  min-height: 200px;
+}
+
+#app #log.hidden {
+  height: 0;
+  min-height: 0;
+  padding: 0;
+  border: 0;
+  overflow: hidden;
 }
 
 #commands,
@@ -157,21 +233,8 @@ div.clear {
 }
 
 .footer {
-  padding-left: 70px;
-  padding-right: 70px;
-}
-
-.footer a {
-  color: blue;
-}
-
-.footer .controls {
-  line-height: 45px;
-}
-
-.footer button {
-  font-size: 14px;
-  margin: 0 10px;
+  padding: 10px 70px;
+  height: 20px;
 }
 
 .remix {
@@ -195,11 +258,11 @@ div.clear {
   display: inline-block;
   position: relative;
   width: 50px;
-  margin-right: 25px;
+  margin-right: 5px;
   -webkit-user-select: none;
   -moz-user-select: none;
   -ms-user-select: none;
-  margin-left: 10px;
+  margin-left: 5px;
 }
 
 .onoffswitch-checkbox {
@@ -280,14 +343,7 @@ div.clear {
   border-color: #67ac38;
 }
 
-.footer .onoffswitch {
-  margin-right: 20px;
-  top: 7px;
-}
 
-#butClear {
-  margin-top: 10px;
-}
 
 #commands {
   min-width: 600px;
@@ -297,11 +353,17 @@ div.clear {
 }
 
 #commands .upload {
-  width: 600px;
+  max-width: 600px;
   display: flex;
   align-items: center;
   margin: 5px auto;
-  justify-content: center;
+  justify-content: flex-start;
+  padding-left: calc(50% - 300px);
+}
+
+/* Hide upload rows 2-8 by default, show dynamically via JavaScript */
+#commands .upload:nth-child(n+2):nth-child(-n+8) {
+  display: none;
 }
 
 #commands .upload .offset {
@@ -374,7 +436,113 @@ div.clear {
   margin-right: 10px;
   border-width: 2px;
   border-style: solid;
+  cursor: pointer;
+}
+
+#commands button {
+  cursor: pointer;
+}
+
+#commands .read-flash {
+  width: 800px;
+  margin: 20px auto 10px auto;
+  padding-top: 20px;
+  border-top: 2px solid #ccc;
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+}
+
+#commands .read-flash .progress-bar {
+  width: 400px;
+  margin-bottom: 10px;
+}
+
+#commands .read-flash-inputs {
+  display: flex;
+  align-items: center;
+  gap: 15px;
+}
+
+#commands .read-flash label {
+  display: flex;
+  align-items: center;
+  gap: 5px;
+  white-space: nowrap;
+}
+
+#commands .read-flash input {
+  width: 100px;
+  padding: 5px;
+  border-radius: 5px;
+  border: 2px solid #ccc;
+}
+
+#commands .read-flash button {
+  border-width: 2px;
+  border-style: solid;
+  padding: 2px 30px;
+  cursor: pointer;
+}
+
+#commands .partition-table {
+  width: 800px;
+  margin: 20px auto 10px auto;
+  padding-top: 20px;
+  border-top: 2px solid #ccc;
+  display: flex;
+  flex-direction: column;
+  align-items: center;
+}
+
+#commands .partition-table button {
+  margin: 0 0 10px 0;
+  border-width: 2px;
+  border-style: solid;
+  padding: 2px 30px;
+  cursor: pointer;
+}
+
+#commands .partition-table .progress-bar {
+  width: 400px;
+  margin-bottom: 10px;
 }
+
+.partition-table-display {
+  width: 100%;
+  margin-top: 20px;
+  border-collapse: collapse;
+}
+
+.partition-table-display th,
+.partition-table-display td {
+  padding: 8px 12px;
+  text-align: left;
+  border: 1px solid #ccc;
+}
+
+.partition-table-display th {
+  font-weight: 600;
+  background-color: #f0f0f0;
+}
+
+.partition-download-btn {
+  padding: 5px 15px;
+  font-size: 14px;
+  border-radius: 10px;
+  border-width: 2px;
+  border-style: solid;
+  cursor: pointer;
+  background-color: transparent;
+  transition: background-color 0.2s, color 0.2s;
+}
+
+.partition-download-btn:hover {
+  background-color: #00a7e9;
+  color: #fff;
+  border-color: #00a7e9;
+}
+
 .justify {
   display: flex;
   justify-content: space-between;

package/dist/const.d.ts

@@ -144,6 +144,28 @@ export declare const ESP32H2_SPI_MISO_DLEN_OFFS = 40;
 export declare const ESP32H2_SPI_W0_OFFS = 88;
 export declare const ESP32H2_UART_DATE_REG_ADDR = 1610612860;
 export declare const ESP32H2_BOOTLOADER_FLASH_OFFSET = 0;
+export declare const ESP32H4_SPI_REG_BASE = 1611239424;
+export declare const ESP32H4_BASEFUSEADDR = 1611339776;
+export declare const ESP32H4_MACFUSEADDR: number;
+export declare const ESP32H4_SPI_USR_OFFS = 24;
+export declare const ESP32H4_SPI_USR1_OFFS = 28;
+export declare const ESP32H4_SPI_USR2_OFFS = 32;
+export declare const ESP32H4_SPI_MOSI_DLEN_OFFS = 36;
+export declare const ESP32H4_SPI_MISO_DLEN_OFFS = 40;
+export declare const ESP32H4_SPI_W0_OFFS = 88;
+export declare const ESP32H4_UART_DATE_REG_ADDR: number;
+export declare const ESP32H4_BOOTLOADER_FLASH_OFFSET = 8192;
+export declare const ESP32H21_SPI_REG_BASE = 1610625024;
+export declare const ESP32H21_BASEFUSEADDR = 1611350016;
+export declare const ESP32H21_MACFUSEADDR: number;
+export declare const ESP32H21_SPI_USR_OFFS = 24;
+export declare const ESP32H21_SPI_USR1_OFFS = 28;
+export declare const ESP32H21_SPI_USR2_OFFS = 32;
+export declare const ESP32H21_SPI_MOSI_DLEN_OFFS = 36;
+export declare const ESP32H21_SPI_MISO_DLEN_OFFS = 40;
+export declare const ESP32H21_SPI_W0_OFFS = 88;
+export declare const ESP32H21_UART_DATE_REG_ADDR = 1610612860;
+export declare const ESP32H21_BOOTLOADER_FLASH_OFFSET = 0;
 export declare const ESP32P4_SPI_REG_BASE = 1342754816;
 export declare const ESP32P4_BASEFUSEADDR = 1343410176;
 export declare const ESP32P4_EFUSE_BLOCK1_ADDR: number;
@@ -156,6 +178,18 @@ export declare const ESP32P4_SPI_MISO_DLEN_OFFS = 40;
 export declare const ESP32P4_SPI_W0_OFFS = 88;
 export declare const ESP32P4_UART_DATE_REG_ADDR: number;
 export declare const ESP32P4_BOOTLOADER_FLASH_OFFSET = 8192;
+export declare const ESP32S31_SPI_REG_BASE = 542113792;
+export declare const ESP32S31_BASEFUSEADDR = 544296960;
+export declare const ESP32S31_EFUSE_BLOCK1_ADDR: number;
+export declare const ESP32S31_MACFUSEADDR: number;
+export declare const ESP32S31_SPI_USR_OFFS = 24;
+export declare const ESP32S31_SPI_USR1_OFFS = 28;
+export declare const ESP32S31_SPI_USR2_OFFS = 32;
+export declare const ESP32S31_SPI_MOSI_DLEN_OFFS = 36;
+export declare const ESP32S31_SPI_MISO_DLEN_OFFS = 40;
+export declare const ESP32S31_SPI_W0_OFFS = 88;
+export declare const ESP32S31_UART_DATE_REG_ADDR: number;
+export declare const ESP32S31_BOOTLOADER_FLASH_OFFSET = 8192;
 export interface SpiFlashAddresses {
     regBase: number;
     baseFuse: number;
@@ -181,8 +215,11 @@ export declare const CHIP_FAMILY_ESP32C5 = 12997;
 export declare const CHIP_FAMILY_ESP32C6 = 12998;
 export declare const CHIP_FAMILY_ESP32C61 = 207969;
 export declare const CHIP_FAMILY_ESP32H2 = 12914;
+export declare const CHIP_FAMILY_ESP32H4 = 12916;
+export declare const CHIP_FAMILY_ESP32H21 = 12917;
 export declare const CHIP_FAMILY_ESP32P4 = 12928;
-export type ChipFamily = typeof CHIP_FAMILY_ESP8266 | typeof CHIP_FAMILY_ESP32 | typeof CHIP_FAMILY_ESP32S2 | typeof CHIP_FAMILY_ESP32S3 | typeof CHIP_FAMILY_ESP32C2 | typeof CHIP_FAMILY_ESP32C3 | typeof CHIP_FAMILY_ESP32C5 | typeof CHIP_FAMILY_ESP32C6 | typeof CHIP_FAMILY_ESP32C61 | typeof CHIP_FAMILY_ESP32H2 | typeof CHIP_FAMILY_ESP32P4;
+export declare const CHIP_FAMILY_ESP32S31 = 12849;
+export type ChipFamily = typeof CHIP_FAMILY_ESP8266 | typeof CHIP_FAMILY_ESP32 | typeof CHIP_FAMILY_ESP32S2 | typeof CHIP_FAMILY_ESP32S3 | typeof CHIP_FAMILY_ESP32C2 | typeof CHIP_FAMILY_ESP32C3 | typeof CHIP_FAMILY_ESP32C5 | typeof CHIP_FAMILY_ESP32C6 | typeof CHIP_FAMILY_ESP32C61 | typeof CHIP_FAMILY_ESP32H2 | typeof CHIP_FAMILY_ESP32H4 | typeof CHIP_FAMILY_ESP32H21 | typeof CHIP_FAMILY_ESP32P4 | typeof CHIP_FAMILY_ESP32S31;
 interface ChipIdInfo {
     name: string;
     family: ChipFamily;
@@ -208,6 +245,7 @@ export declare const ESP_WRITE_REG = 9;
 export declare const ESP_READ_REG = 10;
 export declare const ESP_ERASE_FLASH = 208;
 export declare const ESP_ERASE_REGION = 209;
+export declare const ESP_READ_FLASH = 210;
 export declare const ESP_SPI_SET_PARAMS = 11;
 export declare const ESP_SPI_ATTACH = 13;
 export declare const ESP_CHANGE_BAUDRATE = 15;
@@ -221,11 +259,12 @@ export declare const ROM_INVALID_RECV_MSG = 5;
 export declare const USB_RAM_BLOCK = 2048;
 export declare const ESP_RAM_BLOCK = 6144;
 export declare const DEFAULT_TIMEOUT = 3000;
-export declare const CHIP_ERASE_TIMEOUT = 600000;
+export declare const CHIP_ERASE_TIMEOUT = 150000;
 export declare const MAX_TIMEOUT: number;
 export declare const SYNC_TIMEOUT = 100;
 export declare const ERASE_REGION_TIMEOUT_PER_MB = 30000;
 export declare const MEM_END_ROM_TIMEOUT = 500;
+export declare const FLASH_READ_TIMEOUT = 100;
 /**
  * @name timeoutPerMb
  * Scales timeouts which are size-specific