an0n.eu/meshtastic-mqtt-client
1
0
Fork 0
forked from iarv/meshtastic-mqtt-client
Code Pull Requests Activity

Update README.md

Browse Source
This commit is contained in:
Carlos Alfredo Diaz
2022-07-26 21:33:24 -04:00
committed by GitHub
parent 71bc29441a
commit 965e711975
1 changed files with 35 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@@ -7,3 +7,38 @@ https://github.com/joshpirihi/meshtastic-mqtt
![Full page](https://user-images.githubusercontent.com/6488786/181139834-7cf71745-b981-492f-9545-8916f83b5ef7.png)
The script requires:
python and pip to be installed on the server
for linux (apt):
```
sudo apt install python3 ipmitool python3-pip
```
as well as the following modules with pip:
yaml, paho-mqtt and python-daemon (which are all on ports):
```
sudo pip install yaml paho-mqtt pySimpleGUI protobuf
```
Once installed, just copy this repo (you can use git clone), complete the YAML file and rename it config.yaml in the /config/ folder, make the script executable and run it.There's an example config file (config - example.yaml), you can directly modify and rename it config.yaml.
It must contain:
An MQTT configuration with IP, user, password, otherwise it will run until:
```
MQTT:
MQTT_ip: MQTT BROKER IP
MQTT_USER: 'MQTT user'
MQTT_PW: 'MQTTPASSWORD'
```
Your Meshtastic configuration, basically channel id, client id and gateway id:
```
MESHTASTIC:
CHANNEL_ID: 'ShortFast' # the name of your channel
CLIENT_ID: '12345678' #the id for your program to use
GATEWAY_ID: '!12345678' # Your gateway's id
```
And you're set.