meshtastic/docs/getting-started/flashing-firmware/meshtastic-flasher.mdx

210 lines
5.4 KiB
Plaintext
Raw Normal View History

2022-01-31 13:42:48 -08:00
---
id: meshtastic-flasher
2022-02-11 22:40:08 -08:00
title: Using Meshtastic Flasher
sidebar_label: Meshtastic Flasher
2022-05-15 09:11:54 -07:00
pagination_prev: getting-started/flashing-firmware/flashing-firmware
pagination_next: getting-started/flashing-firmware/flashing-nrf52
2022-09-18 19:17:51 -07:00
sidebar_position: 2
2022-01-31 13:42:48 -08:00
---
2022-03-08 23:51:46 -08:00
2022-01-31 13:42:48 -08:00
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
2022-05-06 12:53:23 -07:00
import Link from '@docusaurus/Link';
2022-01-31 13:42:48 -08:00
2022-04-29 14:39:06 -07:00
:::caution
Make sure not to power the radio on without first attaching the antenna! You could damage the radio chip!
:::
2022-02-11 22:40:08 -08:00
## Overview
Meshtastic Flasher (aka m-flasher) is a graphical user interface for flashing [supported devices](/docs/hardware) with Meshtastic.
The following operating systems are currently supported: Windows, Mac, and Ubuntu.
2022-02-11 22:40:08 -08:00
2022-01-31 13:42:48 -08:00
## Prerequisites
2022-03-10 20:11:18 -08:00
### Verify `python3` is installed
2022-01-31 13:42:48 -08:00
2022-03-10 20:11:18 -08:00
#### Check `python3` version
<Tabs
groupId="operating-system"
defaultValue="linux"
values={[
{label: 'Linux', value: 'linux'},
{label: 'macOS', value: 'macos'},
{label: 'Windows', value: 'windows'},
]}>
2022-03-11 06:28:57 -08:00
<TabItem value="linux">
2022-03-10 20:11:18 -08:00
```shell title="Check python3 version"
2022-03-11 06:28:57 -08:00
python3 --version
# If version is less than v3.6, please update python3
```
2022-03-10 20:11:18 -08:00
2022-03-11 06:28:57 -08:00
</TabItem>
<TabItem value="macos">
2022-03-10 20:11:18 -08:00
```shell title="Check python3 version"
2022-03-11 06:28:57 -08:00
python3 --version
# If version is less than v3.6, please update python3
```
2022-03-10 20:11:18 -08:00
2022-03-11 06:28:57 -08:00
</TabItem>
<TabItem value="windows">
2022-03-10 20:11:18 -08:00
```shell title="Check python3 version"
2022-03-11 06:28:57 -08:00
python3 --version
# If version is less than v3.9+, please update python3
```
2022-03-10 20:11:18 -08:00
2022-03-11 06:28:57 -08:00
</TabItem>
2022-03-10 20:11:18 -08:00
</Tabs>
2022-05-06 12:46:29 -07:00
<details>
<summary>
Install/Update `python3`
</summary>
2022-03-10 20:11:18 -08:00
<Tabs
groupId="operating-system"
defaultValue="linux"
values={[
{label: 'Linux', value: 'linux'},
{label: 'macOS', value: 'macos'},
{label: 'Windows', value: 'windows'},
]}>
2022-03-11 06:28:57 -08:00
<TabItem value="linux">
```shell title="Install python3, pip, and venv"
2022-03-11 13:46:33 -08:00
sudo apt update
sudo apt upgrade
sudo apt install -y python3 python3-pip python3-venv
```
2022-03-11 06:28:57 -08:00
</TabItem>
<TabItem value="macos">
2022-03-11 06:28:57 -08:00
- [Download directly from python.org](https://www.python.org/downloads/macos/)
- [Homebrew](https://brew.sh/)
- [MacPorts](https://www.macports.org/)
2022-03-11 06:28:57 -08:00
</TabItem>
<TabItem value="windows">
2022-03-11 06:28:57 -08:00
- [Download directly from python.org](https://www.python.org/downloads/windows/)
2022-03-11 06:28:57 -08:00
</TabItem>
</Tabs>
2022-05-06 12:46:29 -07:00
</details>
### Install App
2022-05-06 12:53:43 -07:00
<summary>
2022-10-08 07:43:30 -07:00
For windows there is an [executable file](https://github.com/meshtastic/Meshtastic-gui-installer/releases/tag/untagged-9a69e6946635cd38df7d) that will manage installing python and flasher updates for you.
2022-10-08 07:46:46 -07:00
For MacOS and Linux it is recommended that you install using `pip`
2022-05-06 12:53:43 -07:00
</summary>
2022-01-31 13:42:48 -08:00
<Tabs
groupId="operating-system"
defaultValue="linux"
values={[
{label: 'Linux', value: 'linux'},
{label: 'macOS', value: 'macos'},
{label: 'Windows', value: 'windows'},
]}>
2022-03-08 23:51:46 -08:00
<TabItem value="linux">
```shell title="Install Meshtastic Flasher"
2022-03-08 23:51:46 -08:00
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
```
```shell title="Running Meshtastic Flasher"
2022-03-08 23:51:46 -08:00
meshtastic-flasher
```
2022-02-01 18:05:33 -08:00
2022-01-31 13:42:48 -08:00
</TabItem>
<TabItem value="macos">
```shell title="Install Meshtastic Flasher"
2022-03-08 23:51:46 -08:00
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
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
```
```shell title="Running Meshtastic Flasher"
2022-03-08 23:51:46 -08:00
meshtastic-flasher
```
2022-02-01 18:05:33 -08:00
2022-01-31 13:42:48 -08:00
</TabItem>
<TabItem value="windows">
```shell title="Install Meshtastic Flasher"
2022-03-08 23:51:46 -08:00
# open a command prompt
# create a new directory for the python virtual environment
cd c:\
mkdir some_dir
cd some_dir
# check that python version is sufficient, must be at least v3.9+
python -m venv venv
# activate the python virtual environment
venv\Scripts\activate
# your prompt should change - it should have (venv) at the beginning
pip install meshtastic-flasher
```
```shell title="Running Meshtastic Flasher"
2022-03-08 23:51:46 -08:00
meshtastic-flasher
```
2022-02-01 18:05:33 -08:00
2022-01-31 13:42:48 -08:00
</TabItem>
</Tabs>
2022-05-06 12:53:43 -07:00
2022-01-31 13:42:48 -08:00
## Flashing the Device
2022-02-01 18:05:33 -08:00
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:
2022-03-08 23:51:46 -08:00
- 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.
2022-02-01 18:05:33 -08:00
## 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:
2022-03-08 23:51:46 -08:00
- 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
- see [README](https://github.com/meshtastic/Meshtastic-gui-installer/blob/master/README.md) for more details