mirror
/
mmrelaynode
kopia lustrzana https://github.com/mate-dev/mmrelaynode
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność

Update README.md

newFW
Jeremiah K 2023-12-27 12:35:53 -06:00 zatwierdzone przez GitHub
rodzic 2cc159d11c
commit c7dc6b6c8a
1 zmienionych plików z 6 dodań i 3 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

9
README.md
Wyświetl plik

@ -1,5 +1,7 @@
## MMRELAYNODE ## MMRELAYNODE
### A Dockerized Relay for Meshtastic and Matrix featuring an Integrated Virtual Meshtastic Node communicating via MQTT ### *A Dockerized Relay for Meshtastic and Matrix featuring an Integrated Virtual Meshtastic Node communicating via MQTT*
#### **Introduction**
This project utilizes a virtual node built using [Meshtastic firmware](https://github.com/meshtastic/firmware). It emulates the capabilities of a physical device, facilitating direct communication with a conventional mesh network through the firmware's built-in MQTT functionality. This project utilizes a virtual node built using [Meshtastic firmware](https://github.com/meshtastic/firmware). It emulates the capabilities of a physical device, facilitating direct communication with a conventional mesh network through the firmware's built-in MQTT functionality.
@ -7,9 +9,9 @@ The relay operations are provided by the [Meshtastic <=> Matrix Relay](https://g
Discover more about Meshtastic on their official site: [https://meshtastic.org](https://meshtastic.org). Discover more about Meshtastic on their official site: [https://meshtastic.org](https://meshtastic.org).
This project consists of two containers `mmrealynode-app` and `mmrelaynode-device`. #### **Installation & Setup**
Start by copying `docker-compose-sample.yaml` to `docker-compose.yaml` and tailor it to your needs. This project consists of two containers `mmrealynode-app` and `mmrelaynode-device`. Start by copying `docker-compose-sample.yaml` to `docker-compose.yaml` and tailor it to your needs.
For container setup: For container setup:
@ -22,6 +24,7 @@ docker compose restart
*Important: Restart the containers after the initial launch. This reboot enables the virtual Meshtastic node to apply the changes from the `MESHTATIC_COMMAND_X:` commands after being executed by the script.* *Important: Restart the containers after the initial launch. This reboot enables the virtual Meshtastic node to apply the changes from the `MESHTATIC_COMMAND_X:` commands after being executed by the script.*
#### **Additional Operational Commands***
To view outputs from `command_wrapper.py` & `MESHTASTIC_COMMAND_X` commands: To view outputs from `command_wrapper.py` & `MESHTASTIC_COMMAND_X` commands:
``` ```