deuxyeux/RNode_Flasher
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
liamcottle
2024-07-24 21:27:44 +12:00
parent 39554794a9
commit 5c78914bc3
1 changed files with 5 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -3,10 +3,10 @@
A _work-in-progress_ web based firmware flasher for [Reticulum](https://github.com/markqvist/Reticulum) / [RNode_Firmware](https://github.com/markqvist/RNode_Firmware). A _work-in-progress_ web based firmware flasher for [Reticulum](https://github.com/markqvist/Reticulum) / [RNode_Firmware](https://github.com/markqvist/RNode_Firmware).
- It is written in javascript and uses the [Web Serial APIs](https://developer.mozilla.org/en-US/docs/Web/API/Web_Serial_API). - It is written in javascript and uses the [Web Serial APIs](https://developer.mozilla.org/en-US/docs/Web/API/Web_Serial_API).
- It supports putting a device into DFU mode. - It supports putting relevant devices into DFU mode.
- It supports flashing `application` firmware from a zip file. - It supports flashing firmware from a zip file.
At this time, it does not support flashing bootloaders or softdevices. At this time, it does not support flashing bootloaders or softdevices for the nRF boards.
## How does it work? ## How does it work?
@@ -27,6 +27,7 @@ There was an existing package called [pc-nrf-dfu-js](https://github.com/NordicSe
## How to use it? ## How to use it?
- Open [index.html](./index.html) in your web browser. - Open [index.html](./index.html) in your web browser.
- Select your device.
- Put your device into DFU mode. - Put your device into DFU mode.
- Select a firmware file and click flash. - Select a firmware file and click flash.
- Your device should reboot into the new firmware. - Your device should reboot into the new firmware.
@@ -38,6 +39,7 @@ There was an existing package called [pc-nrf-dfu-js](https://github.com/NordicSe
The following list of devices are supported: The following list of devices are supported:
- RAK4631 - RAK4631
- Heltec v3
## What is needed to set up a new RNode? ## What is needed to set up a new RNode?
@@ -72,13 +74,9 @@ Once the firmware is flashed to the device, you will need to provision the EEPRO
## TODO ## TODO
- support configuring eeprom with device signatures and firmware hashes - support configuring eeprom with device signatures and firmware hashes
- support configuring tnc mode, also useful for the [transport node firmware](https://github.com/attermann/microReticulum_Firmware/commits/transport_node/)
- support other devices, such as ESP32/Heltec V3
- support flashing existing firmware files from api - support flashing existing firmware files from api
- calculate on air bitrate based on tnc settings - calculate on air bitrate based on tnc settings
- try using [web-serial-polyfill](https://github.com/google/web-serial-polyfill) to support flashing from Android device? - try using [web-serial-polyfill](https://github.com/google/web-serial-polyfill) to support flashing from Android device?
- try using [esptool-js](https://github.com/espressif/esptool-js) for flashing ESP32 boards
- host all scripts, cryptojs, vuejs, tailwindcss etc locally to support offline use of flasher
## License ## License