@toit/esptool.js

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>@toit/esptool.js</title> <meta name="description" content="Documentation for @toit/esptool.js"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="assets/css/main.css"> <script async src="assets/js/search.js" id="search-script"></script> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base="."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="index.html" class="title">@toit/esptool.js</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> All <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <h1>@toit/esptool.js</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <div class="tsd-panel tsd-typography"> <a href="#esptooljs" id="esptooljs" style="color: inherit; text-decoration: none;"> <h1>esptool.js</h1> </a> <a href="https://www.npmjs.org/package/@toit/esptool.js"><img src="https://img.shields.io/npm/v/@toit/esptool.js.svg?style=flat-square" alt="npm"></a> <a href="https://www.npmjs.org/package/@toit/esptool.js"><img src="https://img.shields.io/npm/l/@toit/esptool.js.svg?style=flat-square" alt="npm"></a> <a href="https://toitware.github.io/esptool.js"><img src="https://img.shields.io/badge/-typedoc-blue?style=flat-square" alt="typedoc"></a> <a href="https://github.com/toitware/esptool.js"><img src="https://img.shields.io/github/stars/toitware/esptool.js.svg?style=flat-square" alt="GitHub"></a> TypeScript port of the esptool. The <a href="https://github.com/espressif/esptool">esptool</a> is originally written in python, and we have here ported it to TypeScript. This implementation is used in the <a href="https://console.toit.io">Toit Console</a> to allow users to flash and monitor ESP32: <a href="https://www.youtube.com/watch?v=ZsD59Tg2oCQ"><img src="https://img.youtube.com/vi/ZsD59Tg2oCQ/0.jpg" alt="Flash ESP32 with web serial"></a> Blog post on why we started this project: <a href="https://blog.toit.io/flash-your-esp32-from-the-browser-using-web-serial-5eccb1483b9c">Flash your ESP32 from the browser using Web Serial</a>. <a href="#example" id="example" style="color: inherit; text-decoration: none;"> <h2>Example</h2> </a> The code is written as a library, here is an examples showcasing how you can flash an ESP32 using the library: <pre><code class="language-typescript">export type Partition = { name: string; data: Uint8Array; offset: number; }; // TODO: Here you have to specify the partitions you want to flash to the ESP32. const partitions: Partition[] = []; await port.open({ baudRate: 115200 }); try { const loader = new EspLoader(port, { debug: true, logger: console }); options.logger.log("connecting..."); await loader.connect(); try { options.logger.log("connected"); options.logger.log("writing device partitions"); const chipName = await loader.chipName(); const macAddr = await loader.macAddr(); await loader.loadStub(); await loader.setBaudRate(options.baudRate, 921600); if (options.erase) { options.logger.log("erasing device flash..."); await loader.eraseFlash(); options.logger.log("successfully erased device flash"); } for (let i = 0; i < partitions.length; i++) { options.logger.log("\nWriting partition: " + partitions[i].name); await loader.flashData(partitions[i].data, partitions[i].offset, function (idx, cnt) { if (options.progressCallback) { options.progressCallback(partitions[i].name, idx, cnt); } }); await sleep(100); } options.logger.log("successfully written device partitions"); options.logger.log("flashing succeeded"); } finally { await loader.disconnect(); } } finally { await port.close(); } </code></pre> <a href="#development" id="development" style="color: inherit; text-decoration: none;"> <h2>Development</h2> </a> To have automatic checks for copyright and MIT notices, run <pre><code>$ git config core.hooksPath .githooks </code></pre> If a file doesn't need a copyright/MIT notice, use the following to skip the check: <pre><code>git commit --no-verify </code></pre> <a href="#similar-projects" id="similar-projects" style="color: inherit; text-decoration: none;"> <h2>Similar projects</h2> </a> <ul> <li><a href="https://github.com/espressif/esptool-js">Espressif esptool-js</a>: new project with similar purpose, but still not written as a proper library. </li> <li><a href="https://github.com/adafruit/Adafruit_WebSerial_ESPTool">Adafruit Adafruit ESPTool</a>: the source of inspration for us, big shout-out thanks for spearheading the effort. The implementation is written as a application and hard to use as a library. </li> </ul> </div> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class=" "> <a href="modules.html">Modules</a> </li> <li class=" tsd-kind-module"> <a href="modules/errors.html">errors</a> </li> <li class=" tsd-kind-module"> <a href="modules/index.html">index</a> </li> <li class=" tsd-kind-module"> <a href="modules/reader.html">reader</a> </li> <li class=" tsd-kind-module"> <a href="modules/stubs.html">stubs</a> </li> <li class=" tsd-kind-module"> <a href="modules/util.html">util</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-variable">Variable</li> <li class="tsd-kind-function">Function</li> <li class="tsd-kind-type-alias">Type alias</li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class">Class</li> <li class="tsd-kind-class tsd-has-type-parameter">Class with type parameter</li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum">Enumeration</li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface">Interface</li> </ul> </div> </div> </footer> <div class="container tsd-generator"> Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a> </div> <div class="overlay"></div> <script src="assets/js/main.js"></script> </body> </html>