Graphical user interface to flash Meshtastic firmware to devices
Project description
Meshtastic-gui-installer
Cross Platform GUI for installing Meshtastic Firmware. It also checks and updates the RAK 4631 bootloader.
Example showing a Heltec (esp32) device:
Example showing a RAK WisBlock Core RAK4631:
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 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\Bin\Activate
pip install meshtastic-flasher
To run, type in "meshtastic-flasher" from a command prompt.
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
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://github.com/meshtastic/Meshtastic-device
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. There is an interesting link here: https://github.com/piwheels/packages/issues/4#issuecomment-772058821
-
Ubuntu 20.04 is the version used for testing, it may work with other versions (Known issue with Wayland https://github.com/meshtastic/Meshtastic-gui-installer/issues/8 )
-
If you just run the
pip install meshtastic-flasher
outside of a fresh python virtual environment (like say on a mac that has usedbrew
to install things) you may get this error:
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 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
Built Distribution
Hashes for meshtastic_flasher-1.0.51.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 04e72c83ed6a786c483442f29fcb3187ccf6569cf8e280a819a5fbb706477545 |
|
MD5 | 3c176d4f2ffed20068d240fe8efd1a6f |
|
BLAKE2b-256 | 4e2de496c4e3c05fd2b1a462c3376941375fad9e42784506e51d1774485838a5 |
Hashes for meshtastic_flasher-1.0.51-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 04fd8604a1290cd3203620a67386a06ea33a09afbccbc659879187be14be9f82 |
|
MD5 | 8ee30599071158e5cad59d9c0c34be36 |
|
BLAKE2b-256 | 91b760e450958458e9bf468aa5f261cf00798529a55745b0fdb6d4bca4198997 |