d0kuhn/esptool-js-openDTU
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

extend readme

Browse Source
This commit is contained in:
Ivan Grokhotkov 2021-06-17 14:08:07 +02:00 committed by Ivan Grokhotkov
parent e3c9d4d341
commit 68f580a7e7
1 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -1,9 +1,22 @@
# Javascript implementation of esptool
This repository contains a Javascript implementation of [esptool](https://github.com/espressif/esptool), a serial flasher utility for Espressif chips. 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).
`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).
## Live demo
Visit https://espressif.github.io/esptool-js/ to see this tool in action.
## Testing it locally
```
npm install xterm
npm install crypto-js
python2 -m SimpleHTTPServer 8008
npm install
python3 -m http.server 8008
```
Then browse http://localhost:8008
Then open http://localhost:8008 in Chrome or Edge.
## License
The code in this repository is Copyright (c) 2021 Espressif Systems (Shanghai) Co. Ltd. It is licensed under Apache 2.0 license, as described in [LICENSE](LICENSE) file.