esp32tool 1.4.1 → 1.5.0

package/js/script.js

@@ -1,6 +1,7 @@
 // Import WebUSB serial support for Android compatibility
 import { WebUSBSerial, requestSerialPort } from './webusb-serial.js';
 import { ESP32ToolConsole } from './console.js';
+import { HexEditor } from './hex-editor.js';
 
 // Make requestSerialPort available globally for esptool.js
 // Use defensive assignment to avoid accidental overwrites
@@ -32,6 +33,7 @@ let currentChipName = null; // Store chip name globally
 let currentMacAddr = null; // Store MAC address globally
 let isConnected = false; // Track connection state
 let consoleInstance = null; // ESP32ToolConsole instance
+let hexEditorInstance = null; // HexEditor instance
 let baudRateBeforeConsole = null; // Store baudrate before opening console
 let espLoaderBeforeConsole = null; // Store original ESPLoader before console
 let chipFamilyBeforeConsole = null; // Store chipFamily before opening console
@@ -228,6 +230,8 @@ const butCloseFileViewer = document.getElementById("butCloseFileViewer");
 const butDownloadFromViewer = document.getElementById("butDownloadFromViewer");
 const tabText = document.getElementById("tabText");
 const tabHex = document.getElementById("tabHex");
+const butHexEditor = document.getElementById("butHexEditor");
+const hexeditorContainer = document.getElementById("hexeditor-container");
 
 let currentViewedFile = null;
 let currentViewedFileData = null;
@@ -343,6 +347,7 @@ document.addEventListener("DOMContentLoaded", () => {
   butErase.addEventListener("click", clickErase);
   butProgram.addEventListener("click", clickProgram);
   butReadFlash.addEventListener("click", clickReadFlash);
+  butHexEditor.addEventListener("click", clickHexEditor);
   butReadPartitions.addEventListener("click", clickReadPartitions);
   butDetectFS.addEventListener("click", clickDetectFS);
   butOpenFSManager.addEventListener("click", clickOpenFSManager);
@@ -565,6 +570,36 @@ function enableStyleSheet(node, enabled) {
   node.disabled = !enabled;
 }
 
+/**
+ * Build advanced flash read/write options from the UI controls.
+ * Returns the options object or undefined if advanced mode is off.
+ * @returns {{ chunkSize?: number, blockSize?: number, maxInFlight?: number } | undefined}
+ */
+function buildAdvancedOptions() {
+  if (!advancedMode.checked) return undefined;
+
+  const validate = (name, value) => {
+    if (value === undefined) return undefined;
+    if (!Number.isFinite(value) || value <= 0) {
+      throw new Error(`Invalid ${name}: ${value}`);
+    }
+    return value;
+  };
+
+  const chunkSize = validate("chunkSize", parseInt(chunkSizeSelect.value));
+  const blockSize = validate("blockSize", parseInt(blockSizeSelect.value));
+  const maxInFlight = validate("maxInFlight", parseInt(maxInFlightSelect.value));
+
+  // blockSize and maxInFlight must both be finite or both non-finite
+  const hasBlockSize = Number.isFinite(blockSize);
+  const hasMaxInFlight = Number.isFinite(maxInFlight);
+  if (hasBlockSize !== hasMaxInFlight) {
+    throw new Error("blockSize and maxInFlight must be provided together");
+  }
+
+  return { chunkSize, blockSize, maxInFlight };
+}
+
 /**
  * Parse flash size string (e.g., "256KB", "4MB") to bytes
  * @param {string} sizeStr - Flash size string with unit (KB or MB)
@@ -1721,30 +1756,8 @@ async function clickReadFlash() {
     const progressBar = readProgress.querySelector("div");
 
     // Prepare options object if advanced mode is enabled
-    // Option validation helpers
-    const validateOption = (name, value) => {
-      if (value === undefined) return undefined;
-      if (!Number.isFinite(value) || value <= 0) {
-        throw new Error(`Invalid ${name}: ${value}`);
-      }
-      return value;
-    };
-
-    let options = undefined;
-    let chunkSizeOpt, blockSizeOpt, maxInFlightOpt;
-    if (advancedMode.checked) {
-      chunkSizeOpt = validateOption("chunkSize", parseInt(chunkSizeSelect.value));
-      blockSizeOpt = validateOption("blockSize", parseInt(blockSizeSelect.value));
-      maxInFlightOpt = validateOption("maxInFlight", parseInt(maxInFlightSelect.value));
-      if ((blockSizeOpt ?? maxInFlightOpt) &&
-          (blockSizeOpt === undefined || maxInFlightOpt === undefined)) {
-        throw new Error("blockSize and maxInFlight must be provided together");
-      }
-      options = {
-        chunkSize: chunkSizeOpt,
-        blockSize: blockSizeOpt,
-        maxInFlight: maxInFlightOpt
-      };
+    const options = buildAdvancedOptions();
+    if (options) {
       logMsg(`Advanced mode: chunkSize=0x${options.chunkSize?.toString(16)}, blockSize=${options.blockSize}, maxInFlight=${options.maxInFlight}`);
     }
 
@@ -1802,6 +1815,126 @@ async function clickReadFlash() {
   }
 }
 
+/**
+ * @name clickHexEditor
+ * Click handler for the Hex Editor button.
+ * Reads the entire flash into a hex editor window.
+ */
+async function clickHexEditor() {
+  const offset = parseInt(readOffset.value, 16);
+  const size = parseInt(readSize.value, 16);
+
+  if (isNaN(offset) || isNaN(size) || size <= 0) {
+    errorMsg("Invalid offset or size value");
+    return;
+  }
+
+  // Disable button to prevent concurrent reads
+  butHexEditor.disabled = true;
+
+  try {
+    // Create and show hex editor
+    if (!hexEditorInstance) {
+      hexEditorInstance = new HexEditor(hexeditorContainer);
+    }
+
+    // Show the container and progress overlay immediately
+    hexeditorContainer.classList.remove('hidden');
+    document.body.classList.add('hexeditor-active');
+
+    // Build a temporary UI for progress display
+    hexEditorInstance.initProgressUI();
+    hexEditorInstance.showProgress('Reading flash...', 0);
+
+    // Prepare options
+    const options = buildAdvancedOptions();
+
+    const data = await espStub.readFlash(
+      offset,
+      size,
+      (packet, progress, totalSize) => {
+        const pct = Math.floor((progress / totalSize) * 100);
+        hexEditorInstance.showProgress(
+          `Reading flash... ${pct}% (${(progress / 1024).toFixed(0)} / ${(totalSize / 1024).toFixed(0)} KB)`,
+          pct
+        );
+      },
+      options
+    );
+
+    logMsg(`Successfully read ${data.length} bytes from flash for hex editor`);
+
+    // Open hex editor with the data
+    hexEditorInstance.open(data, offset);
+
+    // Set up write handler
+    hexEditorInstance.onWriteFlash = async (editedData, modifiedOffsets) => {
+      // Snapshot the editor instance to avoid null dereference if disconnected mid-write
+      const editor = hexEditorInstance;
+      if (!editor) return;
+
+      // Group modified bytes into contiguous sectors (4KB aligned)
+      const SECTOR_SIZE = 0x1000;
+      const sectors = new Set();
+      for (const off of modifiedOffsets) {
+        sectors.add(Math.floor(off / SECTOR_SIZE) * SECTOR_SIZE);
+      }
+
+      const sortedSectors = [...sectors].sort((a, b) => a - b);
+      let written = 0;
+      const total = sortedSectors.length;
+
+      for (const sectorOff of sortedSectors) {
+        const sectorEnd = Math.min(sectorOff + SECTOR_SIZE, editedData.length);
+        const sectorData = editedData.slice(sectorOff, sectorEnd);
+        const flashAddr = offset + sectorOff;
+
+        editor.showProgress(
+          `Writing sector at 0x${flashAddr.toString(16).toUpperCase()}... (${written + 1}/${total})`,
+          Math.floor((written / total) * 100)
+        );
+
+        await espStub.flashData(
+          sectorData.buffer,
+          (bytesWritten, totalBytes) => {
+            const sectorPct = Math.floor((bytesWritten / totalBytes) * 100);
+            editor.showProgress(
+              `Writing sector at 0x${flashAddr.toString(16).toUpperCase()}... ${sectorPct}% (${written + 1}/${total})`,
+              Math.floor(((written + bytesWritten / totalBytes) / total) * 100)
+            );
+          },
+          flashAddr
+        );
+        written++;
+      }
+
+      editor.showProgress('Write complete!', 100);
+      logMsg(`Successfully wrote ${total} sector(s) to flash`);
+      await sleep(500);
+      editor.hideProgress();
+    };
+
+    // Set up close handler
+    hexEditorInstance.onClose = () => {
+      hexeditorContainer.classList.add('hidden');
+      document.body.classList.remove('hexeditor-active');
+      hexEditorInstance = null;
+    };
+
+  } catch (e) {
+    errorMsg("Failed to read flash for hex editor: " + e);
+    hexeditorContainer.classList.add('hidden');
+    document.body.classList.remove('hexeditor-active');
+    if (hexEditorInstance) {
+     // close() handles ResizeObserver/keydown cleanup; onClose is not yet wired here so null manually
+     try { hexEditorInstance.close(); } catch (_) {}
+     hexEditorInstance = null;
+   }
+  } finally {
+    butHexEditor.disabled = false;
+  }
+}
+
 /**
  * @name clickOpenFSManager
  * Click handler for the Open FS Manager button (ESP8266)
@@ -2106,6 +2239,7 @@ function toggleUIToolbar(show) {
   }
   butErase.disabled = !show;
   butReadFlash.disabled = !show;
+  butHexEditor.disabled = !show;
   butReadPartitions.disabled = !show;
 }
 
@@ -2136,6 +2270,12 @@ function toggleUIConnected(connected) {
     if (commands) commands.classList.remove("hidden");
     consoleSwitch.checked = false;
     saveSetting("console", false);
+    
+    // Close hex editor if open
+    if (hexEditorInstance) {
+      hexEditorInstance.close();
+      hexEditorInstance = null;
+    }
   }
   butConnect.textContent = lbl;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "esp32tool",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "type": "module",
   "description": "Flash & Read ESP devices using WebSerial, Electron, and also Android mobile via WebUSB",
   "main": "electron/main.cjs",
@@ -41,7 +41,7 @@
     "test-pwa": "npx serve . -p 5004"
   },
   "devDependencies": {
-    "@electron-forge/cli": "^7.11.1",
+    "@electron-forge/cli": "^7.6.1",
     "@electron-forge/maker-deb": "^7.11.1",
     "@electron-forge/maker-dmg": "^7.11.1",
     "@electron-forge/maker-rpm": "^7.11.1",
@@ -59,17 +59,17 @@
     "@types/serialport": "^10.2.0",
     "@types/w3c-web-serial": "^1.0.7",
     "archiver": "^7.0.1",
-    "electron": "^40.2.1",
+    "electron": "^40.4.1",
     "electron-squirrel-startup": "^1.0.1",
     "eslint": "^9.39.2",
-    "eslint-config-prettier": "^10.1.8",
-    "eslint-plugin-prettier": "^5.5.5",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
     "npm-run-all": "^4.1.5",
     "prettier": "^3.8.1",
     "rollup": "^4.57.0",
-    "serve": "^14.2.4",
+    "serve": "^14.2.5",
     "typescript": "^5.7.3",
-    "typescript-eslint": "^8.55.0"
+    "typescript-eslint": "^8.56.0"
   },
   "dependencies": {
     "pako": "^2.1.0",

package/src/cli.ts

@@ -280,7 +280,7 @@ async function connectViaUSB(
     if (webPort) {
       try {
         await webPort.close();
-      } catch (closeErr) {
+      } catch (_closeErr) {
         // Ignore close errors
       }
     }
@@ -582,7 +582,7 @@ async function main() {
     if (esploader) {
       try {
         await esploader.disconnect();
-      } catch (disconnectErr) {
+      } catch (_disconnectErr) {
         // Ignore disconnect errors during error handling
       }
     }

package/src/const.ts

@@ -1,11 +1,9 @@
 import { toByteArray } from "./util";
 
 export interface Logger {
-  /* eslint-disable @typescript-eslint/no-explicit-any */
   log(msg: string, ...args: any[]): void;
   error(msg: string, ...args: any[]): void;
   debug(msg: string, ...args: any[]): void;
-  /* eslint-enable @typescript-eslint/no-explicit-any */
 }
 
 export const baudRates = [

package/src/esp_loader.ts

@@ -1026,14 +1026,18 @@ export class ESPLoader extends EventTarget {
         }
       } else {
         if (step.dtr !== undefined) {
-          webusb
-            ? await this.setDTRWebUSB(step.dtr)
-            : await this.setDTR(step.dtr);
+          if (webusb) {
+            await this.setDTRWebUSB(step.dtr);
+          } else {
+            await this.setDTR(step.dtr);
+          }
         }
         if (step.rts !== undefined) {
-          webusb
-            ? await this.setRTSWebUSB(step.rts)
-            : await this.setRTS(step.rts);
+          if (webusb) {
+            await this.setRTSWebUSB(step.rts);
+          } else {
+            await this.setRTS(step.rts);
+          }
         }
       }
       if (step.delayMs) await sleep(step.delayMs);
@@ -1558,7 +1562,7 @@ export class ESPLoader extends EventTarget {
               `Connected CDC/JTAG successfully with ${strategy.name} reset.`,
             );
             return;
-          } catch (error) {
+          } catch (_error) {
             throw new Error("Sync timeout or abandoned");
           }
         }
@@ -2492,7 +2496,7 @@ export class ESPLoader extends EventTarget {
 
       // Restart Readloop
       this.readLoop();
-    } catch (e) {
+    } catch (_e) {
       //      this.logger.error(`Reconfigure port error: ${e}`);
       //      throw new Error(`Unable to change the baud rate to ${baud}: ${e}`);
     } finally {
@@ -3285,7 +3289,7 @@ export class ESPLoader extends EventTarget {
     // Wait for pending writes to complete
     try {
       await this._writeChain;
-    } catch (err) {
+    } catch (_err) {
       //      this.logger.debug(`Pending write error during disconnect: ${err}`);
     }
 
@@ -3294,7 +3298,7 @@ export class ESPLoader extends EventTarget {
       try {
         await this._writer.close();
         this._writer.releaseLock();
-      } catch (err) {
+      } catch (_err) {
         //        this.logger.debug(`Writer close/release error: ${err}`);
       }
       this._writer = undefined;
@@ -3305,7 +3309,7 @@ export class ESPLoader extends EventTarget {
         const writer = this.port.writable.getWriter();
         await writer.close();
         writer.releaseLock();
-      } catch (err) {
+      } catch (_err) {
         //        this.logger.debug(`Direct writer close error: ${err}`);
       }
     }
@@ -3334,7 +3338,7 @@ export class ESPLoader extends EventTarget {
       // Only cancel if reader is still active
       try {
         this._reader.cancel();
-      } catch (err) {
+      } catch (_err) {
         // Reader already released, resolve immediately
         clearTimeout(timeout);
         resolve(undefined);
@@ -3365,7 +3369,7 @@ export class ESPLoader extends EventTarget {
     // Wait for pending writes to complete
     try {
       await this._writeChain;
-    } catch (err) {
+    } catch (_err) {
       //      this.logger.debug(`Pending write error during release: ${err}`);
     }
 

package/src/node-usb-adapter.ts

@@ -87,7 +87,7 @@ export function createNodeUSBAdapter(
         if (device.configDescriptor?.bConfigurationValue !== 1) {
           device.setConfiguration(1);
         }
-      } catch (err) {
+      } catch (_err) {
         // Already configured
       }
 
@@ -145,7 +145,7 @@ export function createNodeUSBAdapter(
         if (usbInterface.isKernelDriverActive()) {
           usbInterface.detachKernelDriver();
         }
-      } catch (err) {
+      } catch (_err) {
         // Ignore - may not be supported on all platforms
       }
 
@@ -189,7 +189,7 @@ export function createNodeUSBAdapter(
       if (vendorId === 0x10c4) {
         try {
           // Clear halt on endpoints
-          await new Promise<void>((resolve, reject) => {
+          await new Promise<void>((resolve, _reject) => {
             device.controlTransfer(
               0x02, // Clear Feature, Endpoint
               0x01, // ENDPOINT_HALT
@@ -203,7 +203,7 @@ export function createNodeUSBAdapter(
             );
           });
 
-          await new Promise<void>((resolve, reject) => {
+          await new Promise<void>((resolve, _reject) => {
             device.controlTransfer(
               0x02, // Clear Feature, Endpoint
               0x01, // ENDPOINT_HALT
@@ -216,7 +216,7 @@ export function createNodeUSBAdapter(
               },
             );
           });
-        } catch (err) {
+        } catch (_err) {
           // Ignore
         }
       }
@@ -234,7 +234,7 @@ export function createNodeUSBAdapter(
         try {
           endpointIn.stopPoll();
           endpointIn.removeAllListeners();
-        } catch (err) {
+        } catch (_err) {
           // Ignore
         }
       }
@@ -242,7 +242,7 @@ export function createNodeUSBAdapter(
       if (readableStream) {
         try {
           await readableStream.cancel();
-        } catch (err) {
+        } catch (_err) {
           // Ignore
         }
         readableStream = null;
@@ -251,7 +251,7 @@ export function createNodeUSBAdapter(
       if (writableStream) {
         try {
           await writableStream.close();
-        } catch (err) {
+        } catch (_err) {
           // Ignore
         }
         writableStream = null;
@@ -264,14 +264,14 @@ export function createNodeUSBAdapter(
         try {
           const usbInterface = device.interface(interfaceNumber);
           usbInterface.release(true, () => {});
-        } catch (err) {
+        } catch (_err) {
           // Ignore
         }
       }
 
       try {
         device.close();
-      } catch (err) {
+      } catch (_err) {
         // Ignore
       }
     },
@@ -469,7 +469,7 @@ export function createNodeUSBAdapter(
           try {
             logger.error(`USB read error: ${err.message}`);
             // Don't close on error, just log it
-          } catch (e) {
+          } catch (_e) {
             // Ignore errors in error handler
           }
         });
@@ -477,7 +477,7 @@ export function createNodeUSBAdapter(
         endpointIn!.on("end", () => {
           try {
             controller.close();
-          } catch (err) {
+          } catch (_err) {
             // Ignore errors when closing controller
           }
         });
@@ -488,7 +488,7 @@ export function createNodeUSBAdapter(
           try {
             endpointIn.stopPoll();
             endpointIn.removeAllListeners();
-          } catch (err) {
+          } catch (_err) {
             // Ignore
           }
         }

package/src/util/console-color.ts

@@ -29,6 +29,7 @@ export class ColoredConsole {
 
   addLine(line: string) {
     // biome-ignore lint/suspicious/noControlCharactersInRegex: ANSI escape sequences
+    // eslint-disable-next-line no-control-regex
     const re = /(?:\x1B|\\x1B)(?:\[(.*?)[@-~]|\].*?(?:\x07|\x1B\\))/g;
     let i = 0;
 

package/sw.js

@@ -1,5 +1,5 @@
 // Service Worker for ESP32Tool PWA
-const CACHE_NAME = 'esp32tool-v1.4.1';
+const CACHE_NAME = 'esp32tool-v1.5.0';
 const RUNTIME_CACHE = 'esp32tool-runtime';
 
 // Core files to cache on install (relative paths work for any deployment path)
@@ -17,6 +17,7 @@ const CORE_ASSETS = [
   
   // JavaScript
   './js/script.js',
+  './js/hex-editor.js',
   './js/utilities.js',
   './js/webusb-serial.js',
   './js/modules/esptool.js',