diff --git a/docs/getting-started/meshtastic-flasher.md b/docs/getting-started/meshtastic-flasher.md index 234eadf8..dd7641e3 100644 --- a/docs/getting-started/meshtastic-flasher.md +++ b/docs/getting-started/meshtastic-flasher.md @@ -15,17 +15,9 @@ The following operating systems are currently supported: Windows, Mac, and Ubunt ## Prerequisites -* Python 3 is required -* Download the App (Windows or Mac) +### Verify `python3` is installed -### Check Data Cable - -Plug your device into your computer using a USB cable and then do the following: -:::important -You may need to install a driver from Silicon Labs for the [CP210X USB to UART bridge](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers) - -Some newer boards may require the drivers for the [CH9102 Windows](http://www.wch.cn/downloads/CH343SER_ZIP.html) or [Direct Download](https://github.com/Xinyuan-LilyGO/CH9102_Driver) for Windows 7. For [CH9102 Mac](http://www.wch.cn/downloads/CH34XSER_MAC_ZIP.html). Click the big blue button with the down arrow. Be sure to open up the application and click "Install" after the package is installed. Also, reboot. -::: +#### Check `python3` version - + -Connect your Meshtastic device to your USB port, open a `Terminal` and enter the following command: - -```bash -lsusb -``` - -You should see something like: `ID 10c4:ea60 Silicon Labs CP210x UART Bridge` for CP210X or `ID 1a86:55d4 QinHeng Electronics USB Single Serial` for CH9102 + ```bash title="Check python3 version" + python3 --version + # If version is less than v3.6, please update python3 + ``` -Navigate to `Apple Menu  > About This Mac > System Report... > Hardware > USB`. You should see something like `CP210X USB to UART Bridge Controller`. If not download the appropriate drivers + ```bash title="Check python3 version" + python3 --version + # If version is less than v3.6, please update python3 + ``` -Navigate to `Device Manager > Ports (COM & LPT)`. You should see something like `Silicon Labs CP210X USB to UART Bridge (COM5)`. If not download the appropriate drivers + ```bash title="Check python3 version" + python3 --version + # If version is less than v3.9+, please update python3 + ``` + + + + +#### Install `python3` + + + + + TODO + + + + + - [Download directly from python.org](https://www.python.org/downloads/macos/) + - [Homebrew](https://brew.sh/) + - [MacPorts](https://www.macports.org/) + + + + + - [Download directly from python.org](https://www.python.org/downloads/windows/) @@ -72,43 +96,35 @@ values={[ ]}> -```bash title="Install Meshtastic Flasher" -python3 --version -# ensure you are using at least python v3.6 -# change to a directory where you want to create a python virtual environment -mkdir some_dir -cd some_dir -# if the following command fails, it might tell you what package to install -python3 -m venv venv -# activate the python virtual environment -source venv/bin/activate -# your prompt should change - it should include "(venv) in the front -# upgrade pip -pip install --upgrade pip -pip install meshtastic-flasher -``` + ```bash title="Install Meshtastic Flasher" + python3 --version + # ensure you are using at least python v3.6 + # change to a directory where you want to create a python virtual environment + mkdir some_dir + cd some_dir + # if the following command fails, it might tell you what package to install + python3 -m venv venv + # activate the python virtual environment + source venv/bin/activate + # your prompt should change - it should include "(venv) in the front + # upgrade pip + pip install --upgrade pip + pip install meshtastic-flasher + ``` -```bash title="Running Meshtastic Flasher" -meshtastic-flasher -``` + ```bash title="Running Meshtastic Flasher" + meshtastic-flasher + ``` -This application requires that you have `python3` installed. There are many ways to do this: - -* install from https://www.python.org/downloads/macos/ , or -* use brew - see https://brew.sh/ , or -* use macports - see https://www.macports.org/ - -To install `meshtastic-flasher`, download Meshtastic-flasher.app.zip from https://github.com/meshtastic/Meshtastic-gui-installer/releases/tag/macapp1.0.0 , unzip and drag to /Applications. + To install `meshtastic-flasher`, download Meshtastic-flasher.app.zip from https://github.com/meshtastic/Meshtastic-gui-installer/releases/tag/macapp1.0.0 , unzip and drag to /Applications. -To install python3, see https://www.python.org/downloads/windows/ - -To install meshtastic-flasher, download meshtastic-flasher.zip from https://github.com/meshtastic/Meshtastic-gui-installer/releases/tag/winapp1.0.0, unzip and run. + To install meshtastic-flasher, download meshtastic-flasher.zip from https://github.com/meshtastic/Meshtastic-gui-installer/releases/tag/winapp1.0.0, unzip and run.