{"_id":"@cubicap/esptool-js","_rev":"1-5b1640bf12cf9322e91f4e6f4caacd72","name":"@cubicap/esptool-js","dist-tags":{"latest":"0.3.2"},"versions":{"0.3.1":{"name":"@cubicap/esptool-js","version":"0.3.1","module":"lib/index.js","main":"lib/index.js","types":"lib/index.d.ts","license":"Apache-2.0","type":"module","scripts":{"build":"npm run clean && tsc && rollup --config --bundleConfigAsCjs","clean":"rimraf lib bundle.js","format":"prettier --write \"src/**/*.ts\"","lint":"eslint . --ext .ts","lintAndFix":"eslint . --ext .ts --fix","prepare":"npm run build","test":"echo \"Error: no test specified\"","prepublishOnly":"npm run test && npm run lint"},"repository":{"type":"git","url":"git+https://github.com/cubicap/esptool-js.git"},"bugs":{"url":"https://github.com/cubicap/esptool-js/issues"},"dependencies":{"pako":"^2.1.0","tslib":"^2.4.1"},"devDependencies":{"@rollup/plugin-babel":"^6.0.2","@rollup/plugin-commonjs":"^23.0.2","@rollup/plugin-json":"^6.0.0","@rollup/plugin-node-resolve":"^15.0.1","@rollup/plugin-terser":"^0.1.0","@types/pako":"^2.0.0","@types/w3c-web-serial":"^1.0.3","@typescript-eslint/eslint-plugin":"^5.43.0","@typescript-eslint/parser":"^5.43.0","babel-loader":"^9.1.0","eslint":"^8.28.0","eslint-config-prettier":"^8.5.0","eslint-plugin-prettier":"^4.2.1","prettier":"^2.7.1","rimraf":"^3.0.2","rollup":"^3.3.0","serialport":"^12.0.0","typescript":"^4.8.4"},"gitHead":"4557aa0300b4b8e13307008f191662de8cda4e6b","description":"A fork of esptool-js attempting to make the tool work as a library in the node.js environment.","homepage":"https://github.com/cubicap/esptool-js#readme","_id":"@cubicap/esptool-js@0.3.1","_nodeVersion":"18.11.0","_npmVersion":"8.19.2","dist":{"integrity":"sha512-otXLx5Cuq1dcCG4zrrxcxrblJImaeRWBH1wt4y1imOt7+rKjOxA/WzcAIDfxFSpHRMyvio1P7+21aaZXVfu+PQ==","shasum":"e985a66f0d4b82aed711430a7dc3e729cbba8f14","tarball":"https://registry.npmjs.org/@cubicap/esptool-js/-/esptool-js-0.3.1.tgz","fileCount":46,"unpackedSize":298514,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCsv4vbn1IDFw7Hxe20dIZA8QC8hGQ9kpXRv3sqmn9GgwIgUQEbgzoWolsiHIg/pQ2TX6b+JiyirjBHc37xrF5Hl34="}]},"_npmUser":{"name":"cubicap","email":"cubicap@email.cz"},"directories":{},"maintainers":[{"name":"cubicap","email":"cubicap@email.cz"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/esptool-js_0.3.1_1697333954037_0.2098874893001259"},"_hasShrinkwrap":false},"0.3.2":{"name":"@cubicap/esptool-js","version":"0.3.2","module":"lib/index.js","main":"lib/index.js","types":"lib/index.d.ts","license":"Apache-2.0","type":"module","scripts":{"build":"npm run clean && tsc && rollup --config --bundleConfigAsCjs","clean":"rimraf lib bundle.js","format":"prettier --write \"src/**/*.ts\"","lint":"eslint . --ext .ts","lintAndFix":"eslint . --ext .ts --fix","prepare":"npm run build","test":"echo \"Error: no test specified\"","prepublishOnly":"npm run test && npm run lint"},"repository":{"type":"git","url":"git+https://github.com/cubicap/esptool-js.git"},"bugs":{"url":"https://github.com/cubicap/esptool-js/issues"},"dependencies":{"pako":"^2.1.0","tslib":"^2.4.1"},"devDependencies":{"@rollup/plugin-babel":"^6.0.2","@rollup/plugin-commonjs":"^23.0.2","@rollup/plugin-json":"^6.0.0","@rollup/plugin-node-resolve":"^15.0.1","@rollup/plugin-terser":"^0.1.0","@types/pako":"^2.0.0","@types/w3c-web-serial":"^1.0.3","@typescript-eslint/eslint-plugin":"^5.43.0","@typescript-eslint/parser":"^5.43.0","babel-loader":"^9.1.0","eslint":"^8.28.0","eslint-config-prettier":"^8.5.0","eslint-plugin-prettier":"^4.2.1","prettier":"^2.7.1","rimraf":"^3.0.2","rollup":"^3.3.0","serialport":"^12.0.0","typescript":"^4.8.4"},"gitHead":"861966be6782c39f184bcf4ae34ce12c9a8319ca","description":"A fork of esptool-js attempting to make the tool work as a library in the node.js environment.","homepage":"https://github.com/cubicap/esptool-js#readme","_id":"@cubicap/esptool-js@0.3.2","_nodeVersion":"18.11.0","_npmVersion":"8.19.2","dist":{"integrity":"sha512-ffVbukmg9MQP/Qku8Wxn224GhN8dNryZ4nR8CSXsfKPxeqcIvvY7wT5omy4YxsrC0Oki6/7aXbQJAQMW1whUnQ==","shasum":"268706353a707c4d8b30f38bced5df847515da47","tarball":"https://registry.npmjs.org/@cubicap/esptool-js/-/esptool-js-0.3.2.tgz","fileCount":46,"unpackedSize":301662,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCMPB/MW7iFufMFCjt6YAFh1ZJguVpqzzDb5rFjPnflZgIhALFooCYVD7nAsh/88z1blw5BuMjJJvE8Q90jOlH0ynqy"}]},"_npmUser":{"name":"cubicap","email":"cubicap@email.cz"},"directories":{},"maintainers":[{"name":"cubicap","email":"cubicap@email.cz"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/esptool-js_0.3.2_1697334183290_0.167468928435488"},"_hasShrinkwrap":false}},"time":{"created":"2023-10-15T01:39:13.895Z","0.3.1":"2023-10-15T01:39:14.220Z","modified":"2023-10-15T01:43:03.665Z","0.3.2":"2023-10-15T01:43:03.475Z"},"maintainers":[{"name":"cubicap","email":"cubicap@email.cz"}],"description":"A fork of esptool-js attempting to make the tool work as a library in the node.js environment.","homepage":"https://github.com/cubicap/esptool-js#readme","repository":{"type":"git","url":"git+https://github.com/cubicap/esptool-js.git"},"bugs":{"url":"https://github.com/cubicap/esptool-js/issues"},"license":"Apache-2.0","readme":"# esptool-js-node\n\nA fork of esptool-js attempting to make the tool work as a library in the node.js environment.\n\n# Javascript implementation of esptool\n\nThis repository contains a Javascript implementation of [esptool](https://github.com/espressif/esptool), a serial flasher utility for Espressif chips. `esptool-js` is based on [Web Serial API](https://wicg.github.io/serial/) and works in Google Chrome and Microsoft Edge [version 89 or later](https://developer.mozilla.org/en-US/docs/Web/API/Serial#browser_compatibility) browsers.\n\n**NOTE:** Unlike the Python-based esptool, `esptool-js` doesn't implement generation of binary images out of ELF files, and doesn't include companion tools similar to [espefuse.py](https://github.com/espressif/esptool/wiki/espefuse) and [espsecure.py](https://github.com/espressif/esptool/wiki/espsecure).\n\n## Usage\n\n**CDN**\n\n`https://unpkg.com/esptool-js/lib/index.js?module`\n\n**NPM**\n\n`npm install --save esptool-js`\n\n**Yarn**\n\n`yarn add --save esptool-js`\n\nCheck an example project [here](./examples/typescript).\n\n## Define port filters for device using WebSerial\n\n```js\nconst portFilters: { usbVendorId?: number | undefined, usbProductId?: number | undefined }[] = [];\nconst device = await navigator.serial.requestPort({ filters: portFilters });\n```\n\n## Inject a Terminal to use with esptool-js\n\n```js\n// You can use any JavaScript compatible terminal by wrapping it in a helper object like this:\nlet espLoaderTerminal = {\n  clean() {\n    // Implement the clean function call for your terminal here.\n  },\n  writeLine(data) {\n    // Implement the writeLine function call for your terminal here.\n  },\n  write(data) {\n    // Implement the write function call for your terminal here.\n  },\n};\n```\n\nYou can pass this terminal object to `ESPLoader` constructor as shown in the [examples projects](./examples/).\n\n## Live demo\n\nVisit https://espressif.github.io/esptool-js/ to see this tool in action.\n\n## Testing it locally\n\n```sh\nnpm install\nnpm run build\ncd examples/typescript\nnpm install\nnpm run dev # Run local sever with example code\n```\n\nThen open `http://localhost:1234` in a Chrome browser. The `npm run build` step builds the `lib` used in the example `examples/typescript/index.html`. Update this reference as described in [Usage](#usage) section.\n\n## License\n\nThe code in this repository is Copyright (c) 2023 Espressif Systems (Shanghai) Co. Ltd. It is licensed under Apache 2.0 license, as described in [LICENSE](LICENSE) file.\n","readmeFilename":"README.md"}