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 and LilyGo T-Echo bootloaders.

Example showing esp32 device:

Screen Shot 2022-02-24 at 12 39 59 PM

Example showing a RAK WisBlock Core RAK4631:

Screen Shot 2022-02-24 at 12 41 05 PM

Settings

Screen Shot 2022-02-24 at 12 41 51 PM

To install:

Note: The "single executable" installation option has been deprecated as of March 10, 2022.

Advanced options

To go into the Advanced Options page, press the "A" key or click on the "Advanced Options" in the top left of the main screen

Capabilities:

  • Update mode for esp32 devices: Instead of doing a complete flash, you can do an "update"
  • view the equivalent of meshtastic --info
  • send a simple text message
  • backup the connected device configuration to yaml file
  • restore configuration from yaml file to the connected device

Device Settings

  • Click on the "Device Settings" at the top of the main screen to change settings.
  • "Factory Reset" is availaable in the Admin tab
  • "Hotkeys" and "Tips" are also options

Installation for Development

  • Steps to install from PyPi - typically used for development

First clone repo and change into the Meshtastic-gui-installer directory.

python3 -m venv venv
source venv/bin/activate
# or if on windows: venv\scripts\activate
pip install --upgrade pip
pip install .

To run, type in "meshtastic-flasher"

To lint (for developers)

pylint *.py

or

make lint

To test (for developers)

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, 8.1, 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.

Note to Developers

Please keep code as simple as possible.

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.98.tar.gz (72.2 kB view hashes)

Uploaded Source

Built Distribution

meshtastic_flasher-1.0.98-py3-none-any.whl (86.9 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