Skip to content
/ emesh Public

Encryption and funny APIs for meshtastic serial devices: moved from thecookingsenpai for migration using CloneReclone.bash

License

Notifications You must be signed in to change notification settings

tcsenpai/emesh

Repository files navigation

eMesh

A human-usable fast and universal GUI for Meshtastic nodes

What is eMesh?

eMesh is an interface initially made for myself to be able to better control, understand and play with devices used in the Meshtastic Project. A brief and absolutely not definitive list of supported devices is provided in the next section.

Compatible devices

Any device that is compatible with the current Meshtastic for Python version should be supported without any problems. However, is important to note that our tests have been made against the following devices:

• LilyGo LORA32

Features

  • A fully functional GUI for Meshtastic even if you are using the terminal (thanks Textualize for its Textual library)
  • Conda support for both CLI and TUI versions
  • Serial Port connection (serial or usb over serial)
  • Support for beaconing (emitting a signal every X seconds)
    • Support for beaconing time customization
  • Possibility of specifying the serial port to use
  • Listening and showing messages in a clear and clean way
  • Easy to use chat-like interface with advanced commands

Installation and usage

git clone https://github.com/thecookingsenpai/emesh
cd emesh

TUI Version (textual GUI)

NOTE: This is the suggested way of running emesh on capable machines (from raspberry pi zero to infinite)

Using pip:

pip install -r requirements.txt
python gui.py

Using conda (suggested):

conda env create --file environment.yaml
conda activate emesh-env
python gui.py

CLI Version

NOTE: This is the suggested way of running emesh on low specs machines (sub-raspberry pi zero)

Using pip:

pip install -r requirements_cli.txt
python term.py

Using conda (suggested):

conda env create --file environment_cli.yaml
conda activate emesh-env-cli
python term.py

License

MIT License

Copyright (c) 2023 TheCookingSenpai

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Encryption and funny APIs for meshtastic serial devices: moved from thecookingsenpai for migration using CloneReclone.bash

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages