diff --git a/.gitignore b/.gitignore index f96a4ce..cf935b2 100755 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ *.key *.pem -textual \ No newline at end of file +textual +.trunk +__pycache__ \ No newline at end of file diff --git a/README.md b/README.md index f25e7c6..2acc076 100755 --- a/README.md +++ b/README.md @@ -15,8 +15,8 @@ Any device that is compatible with the current Meshtastic for Python version sho ### Features - [x] A fully functional GUI for Meshtastic even if you are using the terminal (thanks [Textualize for its Textual library](https://github.com/Textualize/textual)) +- [x] Conda support for both CLI and TUI versions - [x] Serial Port connection (serial or usb over serial) -- [ ] Bluetooth connection (not yet, maybe not ever) - [x] Support for beaconing (emitting a signal every X seconds) - [ ] Support for beaconing time customization - [x] Possibility of specifying the serial port to use @@ -28,13 +28,38 @@ Any device that is compatible with the current Meshtastic for Python version sho 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 -You can also play with term.py and emesh.py and use directly +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 -If you really hate GUIs. ### License diff --git a/environment.yaml b/environment.yaml new file mode 100644 index 0000000..95b413e --- /dev/null +++ b/environment.yaml @@ -0,0 +1,15 @@ +# run: conda env create --file environment.yml +name: emesh-env +dependencies: +- python=3.10 +- anaconda +- pip +- pip: + - pytap2 + - pubsub + - meshtastic + - cryptography + - deterministic-rsa-keygen + - python-dotenv + - textual + - textual-dev \ No newline at end of file diff --git a/environment_cli.yaml b/environment_cli.yaml new file mode 100644 index 0000000..2a98c49 --- /dev/null +++ b/environment_cli.yaml @@ -0,0 +1,13 @@ +# run: conda env create --file environment_cli.yml +name: emesh-env-cli +dependencies: +- python=3.10 +- anaconda +- pip +- pip: + - pytap2 + - pubsub + - meshtastic + - cryptography + - deterministic-rsa-keygen + - python-dotenv \ No newline at end of file diff --git a/requirements_cli.txt b/requirements_cli.txt new file mode 100755 index 0000000..5760fcd --- /dev/null +++ b/requirements_cli.txt @@ -0,0 +1,8 @@ +pytap2 +pubsub +meshtastic +cryptography +deterministic-rsa-keygen +python-dotenv + +