Skip to main content

Graphical user interface to flash Meshtastic firmware to devices

Project description

Meshtastic-gui-installer

Pylint codecov PyPI - Downloads

Cross Platform GUI for installing Meshtastic Firmware. It also checks and updates the RAK 4631 bootloader. The LilyGo T-Echo bootloader is also checked.

Example showing a Heltec (esp32) device:

Screen Shot 2022-02-01 at 4 34 24 PM

Example showing a RAK WisBlock Core RAK4631:

Screen Shot 2022-02-01 at 9 57 24 PM

Installation

  • For the single file executable see Releases. There is a readme.txt that shows the steps to get started.

  • Steps to install from PyPi (if you do not want the single executable method described above):

Linux/Mac:

python3 -m venv venv
source venv/bin/activate
pip install --upgrade pip
pip install meshtastic-flasher

Windows command prompt: (assuming Python3 was installed from https://www.python.org/downloads/ and python --version reports 3.6+):

python -m venv venv
venv\Scripts\Activate
pip install --upgrade pip
pip install meshtastic-flasher

To run, type in "meshtastic-flasher" from a command prompt.

Updating

To update a pip-installed installation, run the following commands:

Linux/Mac:

source venv/bin/activate
pip install --upgrade meshtastic-flasher

Windows command prompt:

venv\Scripts\Activate
pip install --upgrade meshtastic-flasher

Advanced options

To go into the Advanced options page, press the "A" key.

The options are:

  • Update mode for esp32 devices
  • RAK Bootloader update (for RAK4631 nrf52)

Installation for Development

  • Setup virtual environment and install required packages
python3 -m venv venv
source venv/bin/activate
# or if on windows: venv\scripts\activate
pip install --upgrade pip
pip install -r requirements.txt
pip install .

To lint

pylint *.py

or

make lint

To test

pytest

for more info

https://wiki.qt.io/Qt_for_Python

https://pygithub.readthedocs.io/en/latest/introduction.html

https://meshtastic.org/

https://github.com/meshtastic/Meshtastic-device

Tested on

  • Ubuntu 20.04, 21.04, and 22.04 (x86_64)

If you get this error:

qt.qpa.plugin: Could not load the Qt platform "xcb" in "" even though it was found.
This application failed to start because not Qt platform plugin could be initialized. Reinstalling the application may fix this problem.
Available platform plugins are: eglfs, linuxfb, minimal, minimalegl, offscreen, vkkrrdisplay, vnc, wayland-egl, wayland, xcb.
Aborted.

Then this might solve the issue:

sudo apt-get install '^libxcb.*-dev' libx11-xcb-dev libglu1-mesa-dev libxrender-dev libxi-dev libxkbcommon-dev libxkbcommon-x11-dev
  • Fedora 33 (x86_64)
  • Manjaro 21.2.3 (x86_64)
  • Linux Mint 20.3 (x86_64)
  • MacOS (arm and x86)
  • Windows 7, 10, and 11 (may work on other versions)
  • ArchlinuxArm with the following commands:
pacman -S qt6 pyside6
pip install meshtastic-flasher

Known limitations

The following are known limitations:

    from meshtastic_flasher.installer import main
  File "/usr/local/lib/python3.9/site-packages/meshtastic_flasher/installer.py", line 20, in <module>
    from meshtastic.util import detect_supported_devices, findPorts, detect_windows_needs_driver

If you get this error, then install in a python virtual environment as described in the Installation step above.

  • Windows 11 works with CP210x Universal Windows Driver, and you must start the command prompt as Administrator

Note to Devs

Please keep code as simple as possible. PyQT has a tendency to get complicated.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

meshtastic_flasher-1.0.61.tar.gz (45.8 kB view hashes)

Uploaded Source

Built Distribution

meshtastic_flasher-1.0.61-py3-none-any.whl (43.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page