meshtastic/docs/getting-started/meshtastic-flasher.md

---
id: meshtastic-flasher
title: Using Meshtastic Flasher
sidebar_label: Using Meshtastic Flasher
pagination_next: getting-started/clients
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

## 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.

## Prerequisites

### Verify `python3` is installed

#### Check `python3` version

<Tabs
groupId="operating-system"
defaultValue="linux"
values={[
{label: 'Linux', value: 'linux'},
{label: 'macOS', value: 'macos'},
{label: 'Windows', value: 'windows'},
]}>
  <TabItem value="linux">

  ```bash title="Check python3 version"
  python3 --version
  # If version is less than v3.6, please update python3
  ```

  </TabItem>
  <TabItem value="macos">

  ```bash title="Check python3 version"
  python3 --version
  # If version is less than v3.6, please update python3
  ```

  </TabItem>
  <TabItem value="windows">

  ```bash title="Check python3 version"
  python3 --version
  # If version is less than v3.9+, please update python3
  ```

  </TabItem>
</Tabs>

#### Install `python3`

<Tabs
groupId="operating-system"
defaultValue="linux"
values={[
{label: 'Linux', value: 'linux'},
{label: 'macOS', value: 'macos'},
{label: 'Windows', value: 'windows'},
]}>
  <TabItem value="linux">

  TODO

  </TabItem>
  <TabItem value="macos">

  - [Download directly from python.org](https://www.python.org/downloads/macos/)
  - [Homebrew](https://brew.sh/)
  - [MacPorts](https://www.macports.org/)

  </TabItem>
  <TabItem value="windows">

  - [Download directly from python.org](https://www.python.org/downloads/windows/)

  </TabItem>
</Tabs>

### Install App

This is the preferred installation method for `meshtastic-flasher`.

<Tabs
groupId="operating-system"
defaultValue="linux"
values={[
{label: 'Linux', value: 'linux'},
{label: 'macOS', value: 'macos'},
{label: 'Windows', value: 'windows'},
]}>
<TabItem value="linux">

  ```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
  ```

  </TabItem>
  <TabItem value="macos">

  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.

  </TabItem>
  <TabItem value="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.


  </TabItem>
</Tabs>

### Install using `pip`

This option is typically for developers.

<Tabs
groupId="operating-system"
defaultValue="linux"
values={[
{label: 'Linux', value: 'linux'},
{label: 'macOS', value: 'macos'},
{label: 'Windows', value: 'windows'},
]}>
<TabItem value="linux">

```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
```

  </TabItem>
  <TabItem value="macos">

```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
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
```

  </TabItem>
  <TabItem value="windows">

```bash title="Install Meshtastic Flasher"
# 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
```

```bash title="Running Meshtastic Flasher"
meshtastic-flasher
```

  </TabItem>
</Tabs>

## 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
- see [README](https://github.com/meshtastic/Meshtastic-gui-installer/blob/master/README.md) for more details