From 9ea8a6761a3c083df4bc493be79f13209ac6f964 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Knud=20Schr=C3=B8der?= <37827873+dk98174003@users.noreply.github.com> Date: Wed, 5 Nov 2025 21:09:31 +0100 Subject: [PATCH] Revise README for Meshtastic Bot details Updated project description and usage instructions. --- README.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3b90c12..09a5ede 100644 --- a/README.md +++ b/README.md @@ -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 +```