From e487744e1c61a82c7b00239816605f76f8a6fd9d Mon Sep 17 00:00:00 2001 From: Mike Kinney Date: Tue, 1 Feb 2022 18:05:33 -0800 Subject: [PATCH] add initial info --- docs/getting-started/meshtastic-flasher.md | 47 ++++++++++++++++------ 1 file changed, 34 insertions(+), 13 deletions(-) diff --git a/docs/getting-started/meshtastic-flasher.md b/docs/getting-started/meshtastic-flasher.md index bb2f0243..b536aabd 100644 --- a/docs/getting-started/meshtastic-flasher.md +++ b/docs/getting-started/meshtastic-flasher.md @@ -8,7 +8,7 @@ import TabItem from '@theme/TabItem'; ## Prerequisites -Install Meshtastic Flasher by [downloading the executable file](https://github.com/meshtastic/Meshtastic-gui-installer/releases) or installing using `pip`. +Install Meshtastic Flasher by either [downloading the executable file](https://github.com/meshtastic/Meshtastic-gui-installer/releases) or installing using `pip`. The following operating systems are: Windows, Mac, and Ubuntu. @@ -31,6 +35,10 @@ values={[ pip install meshtastic-flasher ``` + ```bash title="Running Meshtastic Flasher" + meshtastic-flasher + ``` + @@ -38,19 +46,32 @@ values={[ pip install meshtastic-flasher ``` + ```bash title="Running Meshtastic Flasher" + meshtastic-flasher + ``` + ## Flashing the Device - - - - - - + +The Meshtastic Flasher will flash the latest firmware to esp32 and nrf52 devices. This is a newly developed application (as of February 1, 2022), so there may be some issues discovered as it is tested by users. + +There are three steps: + +* Click the "GET VERSIONS" button to get the versions available (from GitHub). +* Click the "DETECT DEVICE" button to determine the port and device variant connected. +* Click the "FLASH" button to flash the version selected, using the port selected to the device. + +## Issues? + +If you run into an issue, please create a ticket here: [Flasher Issues](https://github.com/meshtastic/Meshtastic-gui-installer/issues) + +The code can be found at the [Meshtastic-gui-installer repo](https://github.com/meshtastic/Meshtastic-gui-installer) + +## Known limitations + +The following are known limitations: + +* Raspberry Pi is not available, since it is arm-based and there are no pre-built libraries for [PySide](https://wiki.qt.io/Qt_for_Python) +* Ubuntu 20.04 is the version used for testing, it may work with other versions