Revise README for Meshtastic Bot details

Updated project description and usage instructions.
This commit is contained in:
Knud Schrøder
2025-11-05 21:09:31 +01:00
committed by GitHub
parent 2e246c675b
commit 9ea8a6761a

View File

@@ -1,2 +1,19 @@
# MeshtasticBot
Minimal Meshtastic TCP bot that replies to direct text commands like ping, mail, info, and help — simple, extendable, and logs all actions.
### 🛰️ Meshtastic Bot
A minimal Python-based Meshtastic bot that connects via TCP to your radio (e.g., `192.168.0.156:4403`).
It listens for direct text messages and responds to simple commands like:
* `ping` → replies with `pong` and signal stats (SNR, RSSI, hops)
* `mail` → shows mail command help
* `info` → displays bot info
* `help` → lists available commands
All actions are logged to **`meshtastic_bot.log`** and printed in the console.
Easily extendable with new commands via the clean handler structure.
**Run:**
```bash
pip install meshtastic pypubsub
python meshtastic_bot.py
```