tasmota-webserial-esptool 7.0.1 → 7.2.0

package/src/struct.ts

@@ -1,7 +1,14 @@
+type DataViewGetter = (byteOffset: number, littleEndian?: boolean) => number;
+type DataViewSetter = (
+  byteOffset: number,
+  value: number,
+  littleEndian?: boolean,
+) => void;
+
 interface DataType {
   [key: string]: {
-    u: Function;
-    p: Function;
+    u: DataViewGetter;
+    p: DataViewSetter;
     bytes: number;
   };
 }
@@ -32,20 +39,6 @@ const lut: DataType = {
     p: DataView.prototype.setUint32,
     bytes: 4,
   },
-  q: {
-    // @ts-ignore
-    u: DataView.prototype.getInt64,
-    // @ts-ignore
-    p: DataView.prototype.setInt64,
-    bytes: 8,
-  },
-  Q: {
-    // @ts-ignore
-    u: DataView.prototype.getUint64,
-    // @ts-ignore
-    p: DataView.prototype.setUint64,
-    bytes: 8,
-  },
 };
 
 export const pack = (format: string, ...data: number[]) => {
@@ -53,7 +46,7 @@ export const pack = (format: string, ...data: number[]) => {
   if (format.replace(/[<>]/, "").length != data.length) {
     throw "Pack format to Argument count mismatch";
   }
-  let bytes: number[] = [];
+  const bytes: number[] = [];
   let littleEndian = true;
   for (let i = 0; i < format.length; i++) {
     if (format[i] == "<") {
@@ -70,9 +63,9 @@ export const pack = (format: string, ...data: number[]) => {
     if (!(formatChar in lut)) {
       throw "Unhandled character '" + formatChar + "' in pack format";
     }
-    let dataSize = lut[formatChar].bytes;
-    let view = new DataView(new ArrayBuffer(dataSize));
-    let dataViewFn = lut[formatChar].p.bind(view);
+    const dataSize = lut[formatChar].bytes;
+    const view = new DataView(new ArrayBuffer(dataSize));
+    const dataViewFn = lut[formatChar].p.bind(view);
     dataViewFn(0, value, littleEndian);
     for (let i = 0; i < dataSize; i++) {
       bytes.push(view.getUint8(i));
@@ -84,10 +77,10 @@ export const pack = (format: string, ...data: number[]) => {
 
 export const unpack = (format: string, bytes: number[]) => {
   let pointer = 0;
-  let data: number[] = [];
+  const data: number[] = [];
   let littleEndian = true;
 
-  for (let c of format) {
+  for (const c of format) {
     if (c == "<") {
       littleEndian = true;
     } else if (c == ">") {
@@ -101,12 +94,12 @@ export const unpack = (format: string, bytes: number[]) => {
     if (!(formatChar in lut)) {
       throw "Unhandled character '" + formatChar + "' in unpack format";
     }
-    let dataSize = lut[formatChar].bytes;
-    let view = new DataView(new ArrayBuffer(dataSize));
+    const dataSize = lut[formatChar].bytes;
+    const view = new DataView(new ArrayBuffer(dataSize));
     for (let i = 0; i < dataSize; i++) {
       view.setUint8(i, bytes[pointer + i] & 0xff);
     }
-    let dataViewFn = lut[formatChar].u.bind(view);
+    const dataViewFn = lut[formatChar].u.bind(view);
     data.push(dataViewFn(0, littleEndian));
     pointer += dataSize;
   }

package/src/util.ts

@@ -5,7 +5,7 @@
  */
 export const slipEncode = (buffer: number[]): number[] => {
   let encoded = [0xc0];
-  for (let byte of buffer) {
+  for (const byte of buffer) {
     if (byte == 0xdb) {
       encoded = encoded.concat([0xdb, 0xdd]);
     } else if (byte == 0xc0) {
@@ -23,9 +23,9 @@ export const slipEncode = (buffer: number[]): number[] => {
  * Convert a string to a byte array
  */
 export const toByteArray = (str: string): number[] => {
-  let byteArray: number[] = [];
+  const byteArray: number[] = [];
   for (let i = 0; i < str.length; i++) {
-    let charcode = str.charCodeAt(i);
+    const charcode = str.charCodeAt(i);
     if (charcode <= 0xff) {
       byteArray.push(charcode);
     }
@@ -37,7 +37,7 @@ export const hexFormatter = (bytes: number[]) =>
   "[" + bytes.map((value) => toHex(value)).join(", ") + "]";
 
 export const toHex = (value: number, size = 2) => {
-  let hex = value.toString(16).toUpperCase();
+  const hex = value.toString(16).toUpperCase();
   if (hex.startsWith("-")) {
     return "-0x" + hex.substring(1).padStart(size, "0");
   } else {

package/.devcontainer/devcontainer.json

@@ -1,22 +0,0 @@
-// For format details, see https://aka.ms/devcontainer.json. For config options, see the
-// README at: https://github.com/devcontainers/templates/tree/main/src/typescript-node
-{
-  "name": "Node.js & TypeScript",
-  // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
-  "image": "mcr.microsoft.com/devcontainers/typescript-node:0-20"
-
-  // Features to add to the dev container. More info: https://containers.dev/features.
-  // "features": {},
-
-  // Use 'forwardPorts' to make a list of ports inside the container available locally.
-  // "forwardPorts": [],
-
-  // Use 'postCreateCommand' to run commands after the container is created.
-  // "postCreateCommand": "yarn install",
-
-  // Configure tool-specific properties.
-  // "customizations": {},
-
-  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
-  // "remoteUser": "root"
-}

package/.github/dependabot.yml

@@ -1,10 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: weekly
-  - package-ecosystem: "npm"
-    directory: "/"
-    schedule:
-      interval: "weekly"

package/.github/workflows/build_upload.yml

@@ -1,75 +0,0 @@
-name: Build and upload
-
-on:
-  push:
-  workflow_dispatch:
-
-# Allow one concurrent deployment
-concurrency:
-  group: environment-${{ github.ref }}
-  cancel-in-progress: true
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-      id-token: write  # required to use OIDC
-    steps:
-      - uses: actions/checkout@v6
-      - name: Remove old files and folders
-        run: |
-          rm -rf package-lock.json
-          rm -rf dist
-          rm -rf js/modules
-          mkdir js/modules
-      - name: install node v20
-        uses: actions/setup-node@v6
-        with:
-          node-version: 20
-      - name: Install Yarn with NPM
-        run: npm install -g yarn
-      - name: yarn install
-        run: yarn install
-      - name: Compile TypeScript
-        run: |
-          set -e
-          rm -rf dist
-          NODE_ENV=production npm exec -- tsc
-          NODE_ENV=production npm exec -- rollup -c
-      - name: Rename and copy build artifact
-        run: |
-          cp dist/web/*.js js/modules/
-          mv js/modules/index.js js/modules/esptool.js
-          #ls js/modules/
-      - name: Commit Distribution Files
-        uses: stefanzweifel/git-auto-commit-action@v7
-        with:
-          commit_message: "Github Action: Updated dist files"
-      - name: Publish to NPM registry
-        uses: JS-DevTools/npm-publish@v4
-        with:
-          registry: https://registry.npmjs.org/
-          token: ${{ secrets.NPM_TOKEN }}
-          strategy: all
-      - name: Setup Pages
-        uses: actions/configure-pages@v5
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v4
-        with:
-          path: "."
-
-  deploy:
-    needs: build
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      pages: write
-      id-token: write
-    steps:
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v4

package/.github/workflows/ci.yml

@@ -1,30 +0,0 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
-name: CI
-
-on:
-  push:
-  pull_request:
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v6
-      - name: Use Node.js
-        uses: actions/setup-node@v6
-        with:
-          node-version: 20
-      - name: Remove old package-lock.json
-        run: |
-          rm -rf package-lock.json
-      - run: npm install
-      - run: npm ci
-      - run: script/build
-      - run: npm exec -- prettier --check src
-      - name: Commit changed files
-        uses: stefanzweifel/git-auto-commit-action@v7
-        with:
-          commit_message: "Github Action: Updated files"

package/.prettierignore

@@ -1 +0,0 @@
-src/stubs

package/CHANGELOG_CHIP_VARIANT.md

@@ -1,169 +0,0 @@
-# Changelog: Chip Variant Support
-
-## Änderungen in WebSerial_ESPTool
-
-### Neue Features
-
-#### 1. `chipVariant` Feld in ESPLoader
-- Neues öffentliches Feld: `chipVariant: string | null`
-- Wird automatisch bei der Chip-Erkennung gesetzt
-- Für ESP32-P4: `"rev0"` (Revision < 300) oder `"rev300"` (Revision >= 300)
-- Für alle anderen Chips: `null`
-
-#### 2. Erweiterte ESP32-P4 Erkennung
-- Revision wird aus eFuses gelesen (EFUSE_BLOCK1)
-- Funktioniert sowohl bei IMAGE_CHIP_ID als auch Magic Value Erkennung
-- Logging der erkannten Variante im Debug-Modus
-
-### Geänderte Dateien
-
-- `src/esp_loader.ts`:
-  - Hinzugefügt: `chipVariant: string | null` Feld
-  - Erweitert: `detectChip()` Methode setzt chipVariant für ESP32-P4
-  - Erweitert: Logging für bessere Nachvollziehbarkeit
-
-### API-Änderungen
-
-```typescript
-// Vorher
-const esploader = new ESPLoader(port, logger);
-await esploader.initialize();
-console.log(esploader.chipName);      // "ESP32-P4"
-console.log(esploader.chipRevision);  // 300
-
-// Nachher (zusätzlich)
-console.log(esploader.chipVariant);   // "rev300"
-```
-
-### Abwärtskompatibilität
-
-✅ Vollständig abwärtskompatibel
-- Bestehendes Code funktioniert unverändert
-- Neues Feld ist optional und kann ignoriert werden
-- Keine Breaking Changes
-
-## Änderungen in esp-web-tools
-
-### Neue Features
-
-#### 1. `chipVariant` Support in Manifesten
-- Neues optionales Feld in `Build` Interface: `chipVariant?: string`
-- Ermöglicht spezifische Firmware-Builds für verschiedene Chip-Varianten
-- Intelligente Matching-Logik mit Fallback-Unterstützung
-
-#### 2. Erweiterte Build-Auswahl
-- Priorisiert Builds mit passendem `chipVariant`
-- Fallback auf Builds ohne `chipVariant` Angabe
-- Bessere Fehlermeldungen mit Varianten-Information
-
-### Geänderte Dateien
-
-- `src/const.ts`:
-  - Erweitert: `Build` Interface mit `chipVariant?: string`
-  - Erweitert: `BaseFlashState` Interface mit `chipVariant?: string | null`
-
-- `src/flash.ts`:
-  - Erweitert: Build-Matching-Logik berücksichtigt chipVariant
-  - Erweitert: Fehlermeldungen zeigen chipVariant an
-  - Erweitert: Initialisierungsmeldung zeigt chipVariant an
-
-- `README.md`:
-  - Hinzugefügt: Dokumentation für Chip Variant Support
-  - Hinzugefügt: Beispiel für P4-Varianten
-
-### Manifest-Beispiel
-
-```json
-{
-  "name": "My Firmware",
-  "version": "1.0.0",
-  "builds": [
-    {
-      "chipFamily": "ESP32-P4",
-      "chipVariant": "rev0",
-      "parts": [...]
-    },
-    {
-      "chipFamily": "ESP32-P4",
-      "chipVariant": "rev300",
-      "parts": [...]
-    }
-  ]
-}
-```
-
-### Abwärtskompatibilität
-
-✅ Vollständig abwärtskompatibel
-- Bestehende Manifeste ohne `chipVariant` funktionieren weiterhin
-- `chipVariant` ist optional
-- Keine Breaking Changes
-
-## Testing
-
-### Build-Tests
-- ✅ WebSerial_ESPTool kompiliert erfolgreich
-- ✅ esp-web-tools kompiliert erfolgreich
-- ✅ Keine TypeScript-Fehler
-- ✅ Keine Linting-Fehler
-
-### Funktionale Tests (empfohlen)
-- [ ] Test mit ESP32-P4 Rev. 0 Hardware
-- [ ] Test mit ESP32-P4 Rev. 300 Hardware
-- [ ] Test mit Manifest mit chipVariant
-- [ ] Test mit Manifest ohne chipVariant (Fallback)
-- [ ] Test mit anderen ESP32-Chips (sollte chipVariant = null sein)
-
-## Deployment
-
-### WebSerial_ESPTool
-1. Version in `package.json` erhöhen
-2. `npm run prepublishOnly` ausführen
-3. `npm publish` ausführen
-
-### esp-web-tools
-1. Warten bis neue WebSerial_ESPTool Version verfügbar ist
-2. `package.json` aktualisieren: `"tasmota-webserial-esptool": "^6.5.0"` (oder höher)
-3. Version in `package.json` erhöhen
-4. `npm install`
-5. `npm run prepublishOnly` ausführen
-6. `npm publish` ausführen
-
-## Dokumentation
-
-- ✅ `CHIP_VARIANT_SUPPORT.md` - Vollständige technische Dokumentation
-- ✅ `manifest-example-p4-variants.json` - Beispiel-Manifest
-- ✅ `README.md` (esp-web-tools) - Kurze Anleitung
-- ✅ `CHANGELOG_CHIP_VARIANT.md` - Diese Datei
-
-## Verwendungsbeispiele
-
-### Szenario 1: Separate Builds für jede Variante
-```json
-{
-  "builds": [
-    { "chipFamily": "ESP32-P4", "chipVariant": "rev0", "parts": [...] },
-    { "chipFamily": "ESP32-P4", "chipVariant": "rev300", "parts": [...] }
-  ]
-}
-```
-
-### Szenario 2: Ein Build für alle Varianten
-```json
-{
-  "builds": [
-    { "chipFamily": "ESP32-P4", "parts": [...] }
-  ]
-}
-```
-
-### Szenario 3: Spezifischer Build + Fallback
-```json
-{
-  "builds": [
-    { "chipFamily": "ESP32-P4", "chipVariant": "rev300", "parts": [...] },
-    { "chipFamily": "ESP32-P4", "parts": [...] }
-  ]
-}
-```
-Rev300 verwendet ersten Build, Rev0 verwendet zweiten Build (Fallback).

package/CHIP_VARIANT_SUPPORT.md

@@ -1,184 +0,0 @@
-# ESP32-P4 Chip Variant Support
-
-## Übersicht
-
-Die beiden Projekte unterstützen jetzt die Unterscheidung zwischen verschiedenen ESP32-P4 Varianten über das neue `chipVariant` Feld.
-
-## WebSerial_ESPTool
-
-### Änderungen
-
-Das `ESPLoader` Objekt hat jetzt ein neues Feld:
-- `chipVariant: string | null` - Identifiziert die Chip-Variante
-
-### ESP32-P4 Varianten
-
-Für ESP32-P4 Chips werden folgende Varianten erkannt:
-- `"rev0"` - ESP32-P4 Revision < 300 (ältere Versionen)
-- `"rev300"` - ESP32-P4 Revision >= 300 (neuere Versionen)
-
-Die Erkennung erfolgt automatisch basierend auf der Chip-Revision, die aus den eFuses gelesen wird.
-
-### Beispiel
-
-```typescript
-const esploader = new ESPLoader(port, logger);
-await esploader.initialize();
-
-console.log(esploader.chipName);      // "ESP32-P4"
-console.log(esploader.chipFamily);    // CHIP_FAMILY_ESP32P4
-console.log(esploader.chipRevision);  // z.B. 0 oder 300
-console.log(esploader.chipVariant);   // "rev0" oder "rev300"
-```
-
-## esp-web-tools
-
-### Änderungen
-
-#### Manifest Format
-
-Das `Build` Interface unterstützt jetzt ein optionales `chipVariant` Feld:
-
-```typescript
-interface Build {
-  chipFamily: "ESP32-P4" | ...;
-  chipVariant?: string;  // NEU
-  parts: { path: string; offset: number; }[];
-}
-```
-
-#### Flash State
-
-Der `FlashState` enthält jetzt auch die `chipVariant` Information:
-
-```typescript
-interface BaseFlashState {
-  chipFamily?: "ESP32-P4" | ...;
-  chipVariant?: string | null;  // NEU
-  // ...
-}
-```
-
-### Manifest Beispiel
-
-Hier ist ein Beispiel-Manifest, das verschiedene Firmware-Builds für die zwei P4-Varianten bereitstellt:
-
-```json
-{
-  "name": "My ESP32-P4 Firmware",
-  "version": "1.0.0",
-  "builds": [
-    {
-      "chipFamily": "ESP32-P4",
-      "chipVariant": "rev0",
-      "parts": [
-        { "path": "bootloader_rev0.bin", "offset": 0 },
-        { "path": "partition-table.bin", "offset": 32768 },
-        { "path": "firmware_rev0.bin", "offset": 65536 }
-      ]
-    },
-    {
-      "chipFamily": "ESP32-P4",
-      "chipVariant": "rev300",
-      "parts": [
-        { "path": "bootloader_rev300.bin", "offset": 0 },
-        { "path": "partition-table.bin", "offset": 32768 },
-        { "path": "firmware_rev300.bin", "offset": 65536 }
-      ]
-    },
-    {
-      "chipFamily": "ESP32-S3",
-      "parts": [
-        { "path": "bootloader_s3.bin", "offset": 0 },
-        { "path": "partition-table.bin", "offset": 32768 },
-        { "path": "firmware_s3.bin", "offset": 65536 }
-      ]
-    }
-  ]
-}
-```
-
-### Matching-Logik
-
-Die Firmware-Auswahl funktioniert wie folgt:
-
-1. **Wenn `chipVariant` im Build angegeben ist**: Der Build wird nur verwendet, wenn sowohl `chipFamily` als auch `chipVariant` übereinstimmen.
-
-2. **Wenn `chipVariant` im Build NICHT angegeben ist**: Der Build wird für alle Varianten dieser `chipFamily` verwendet (Fallback).
-
-#### Beispiele
-
-**Szenario 1: Spezifische Builds für jede Variante**
-```json
-{
-  "builds": [
-    { "chipFamily": "ESP32-P4", "chipVariant": "rev0", "parts": [...] },
-    { "chipFamily": "ESP32-P4", "chipVariant": "rev300", "parts": [...] }
-  ]
-}
-```
-- ESP32-P4 rev0 → verwendet ersten Build
-- ESP32-P4 rev300 → verwendet zweiten Build
-
-**Szenario 2: Ein Build für alle Varianten**
-```json
-{
-  "builds": [
-    { "chipFamily": "ESP32-P4", "parts": [...] }
-  ]
-}
-```
-- ESP32-P4 rev0 → verwendet den Build
-- ESP32-P4 rev300 → verwendet den Build
-
-**Szenario 3: Spezifischer Build + Fallback**
-```json
-{
-  "builds": [
-    { "chipFamily": "ESP32-P4", "chipVariant": "rev300", "parts": [...] },
-    { "chipFamily": "ESP32-P4", "parts": [...] }
-  ]
-}
-```
-- ESP32-P4 rev0 → verwendet zweiten Build (Fallback)
-- ESP32-P4 rev300 → verwendet ersten Build (spezifisch)
-
-## Abwärtskompatibilität
-
-Alle Änderungen sind vollständig abwärtskompatibel:
-
-- Bestehende Manifeste ohne `chipVariant` funktionieren weiterhin
-- Das `chipVariant` Feld ist optional
-- Für alle Chips außer ESP32-P4 ist `chipVariant` `null`
-
-## Technische Details
-
-### Chip-Erkennung
-
-Die ESP32-P4 Revision wird aus den eFuses gelesen (EFUSE_BLOCK1):
-- Minor Revision: Bits [3:0]
-- Major Revision: Bit [23] << 2 | Bits [5:4]
-- Revision = Major * 100 + Minor
-
-### Erkennungsmethoden
-
-Die Chip-Erkennung verwendet einen zweistufigen Ansatz:
-
-1. **Primär: GET_SECURITY_INFO** (IMAGE_CHIP_ID)
-   - Unterstützt von: ESP32-C3 (neuere ROM), ESP32-S3, ESP32-C6, ESP32-H2, ESP32-P4 Rev. 300+
-   - Liefert direkt die Chip-ID
-   - Wenn nicht unterstützt oder leere Antwort → Fallback zu Magic Value
-
-2. **Fallback: Magic Value Detection**
-   - Unterstützt von: ESP8266, ESP32, ESP32-S2, ESP32-C3 (ältere ROM), ESP32-P4 Rev. < 300
-   - Liest Magic-Wert aus Register 0x40001000
-   - Zuverlässige Methode für ältere Chips
-
-**Für ESP32-P4:**
-- Beide Methoden funktionieren
-- Nach Erkennung wird die Revision aus eFuses gelesen
-- Basierend auf Revision wird `chipVariant` gesetzt:
-  - Rev. < 300 → `"rev0"`
-  - Rev. >= 300 → `"rev300"`
-
-**Hinweis:** Die Debug-Meldung "GET_SECURITY_INFO failed, using magic value detection" ist normal und erwartet für ältere Chips. Der Fallback-Mechanismus stellt sicher, dass alle Chips korrekt erkannt werden.