Merge upstream preserve features

.env.example

@@ -5,6 +5,28 @@ ADMIN_NODES='!aae8900d'
 # The root URL of the Meshflow API
 STORAGE_API_ROOT='http://localhost:8000'
 STORAGE_API_TOKEN=...
+# Features
+ENABLE_TCP_PROXY=true
+# Handshake Cache size for TCP proxy (how many historical packets to cache to allow new clients to catch up quickly)
+PROXY_HANDSHAKE_CACHE_SIZE=100
+# Rolling Cache size for TCP proxy (how many recent packets to keep in the rolling buffer)
+PROXY_ROLLING_CACHE_SIZE=100
+ENABLE_FEATURE_NODE_TOTALS=true
+FREQUENCY_OF_NODE_REPORTS=3
+CHANNEL_FOR_NODE_TOTAL_BROADCAST=2
+
+# Commands
+ENABLE_COMMAND_PING=true
+ENABLE_COMMAND_TR=true
+ENABLE_COMMAND_HELLO=true
+ENABLE_COMMAND_HELP=true
+ENABLE_COMMAND_NODES=true
+ENABLE_COMMAND_WHOAMI=true
+ENABLE_COMMAND_PREFS=true
+ENABLE_COMMAND_ADMIN=true
+ENABLE_COMMAND_STATUS=true
+
+# API Version (usually 1 or 2)
 STORAGE_API_VERSION=2
 
 # Use these if you want to upload to a second API (usually used during testing)
@@ -15,10 +37,10 @@ STORAGE_API_VERSION=2
 # Use this if you want to receive commands from the Meshflow server (e.g. traceroute)
 MESHFLOW_WS_URL=ws://localhost:8000
 
-# Comma-separated portnums to skip when submitting packets to the API (e.g. custom or rejected ports)
+# Comma-separated portnums to skip when submitting packets to the API (e.g. custom or rejected portnums)
 IGNORE_PORTNUMS=345,ROUTING_APP
 
-# Traceroute config
+# Traceroute config (for WebSocket commands)
 TR_HOPS_LIMIT=5
 # Min seconds between traceroutes (firmware enforces ~30s; we rate-limit client-side)
 TR_MIN_INTERVAL_SEC=30

README.md

@@ -1,5 +1,9 @@
 # Meshtastic Bot
 
+### Although this is based on https://github.com/pskillen/meshtastic-bot I have personalised it a lot to my own setup for commands, auto replies and automations etc 
+
+I am now working on Node-totals which I hope to be able to report the number of nodes my remote nodes can see.
+
 Meshtastic Bot is a Python-based bot for interacting with Meshtastic devices. It listens for messages, processes commands, and responds with appropriate actions. This guide is focused on helping you run the bot as-is, with minimal setup.
 
 ## Quick Start: Run with Docker
@@ -12,34 +16,39 @@ The easiest way to run Meshtastic Bot is using Docker. This method requires mini
 - Create a `.env` file in your project directory with the required environment variables:
 
 ```
-MESHTASTIC_NODE_IP=your_meshtastic_node_ip
+MESHTASTIC_IP=your_meshtastic_node_ip
 ADMIN_NODES=comma_separated_admin_node_ids
-STORAGE_API_ROOT=your_storage_api_url
-STORAGE_API_TOKEN=your_storage_api_token
+STORAGE_API_ROOT=https://meshflow.pskillen.xyz
+STORAGE_API_TOKEN=your_storage_api_token from above site
 # Optionally, you can upload to a second API as well
 STORAGE_API_2_ROOT=your_storage_api_2_url
 STORAGE_API_2_TOKEN=your_storage_api_2_token
+
+# Feature Toggles
+ENABLE_TCP_PROXY=true
+
+# Command Toggles (set to false to disable)
+ENABLE_COMMAND_PING=true
+ENABLE_COMMAND_TR=true
+ENABLE_COMMAND_HELLO=true
+ENABLE_COMMAND_HELP=true
+ENABLE_COMMAND_NODES=true
+ENABLE_COMMAND_WHOAMI=true
+ENABLE_COMMAND_PREFS=true
+ENABLE_COMMAND_ADMIN=true
+ENABLE_COMMAND_STATUS=true
 ```
 
 ### 2. Use This `docker-compose.yaml`
 
 ```yaml
-version: '3.8'
-
 services:
   bot:
     image: ghcr.io/pskillen/meshtastic-bot:latest
     container_name: meshtastic-bot
     restart: unless-stopped
-    environment:
-      - MESHTASTIC_IP=${MESHTASTIC_NODE_IP}
-      - ADMIN_NODES=${ADMIN_NODES}
-      - STORAGE_API_ROOT=${STORAGE_API_ROOT}
-      - STORAGE_API_TOKEN=${STORAGE_API_TOKEN}
-      - STORAGE_API_VERSION=2
-      - STORAGE_API_2_ROOT=${STORAGE_API_2_ROOT}
-      - STORAGE_API_2_TOKEN=${STORAGE_API_2_TOKEN}
-      - STORAGE_API_2_VERSION=2
+    env_file:
+      - meshtastic-bot.env
     volumes:
       - mesh_bot_data:/app/data
 
@@ -57,6 +66,46 @@ The bot will now run in the background. Data will be persisted locally in the `m
 
 ---
 
+## Customization
+
+You can enable or disable specific features and commands using environment variables in your `.env` or `meshtastic-bot.env` file. All options default to `true` if not specified.
+
+### Feature Toggles
+- `ENABLE_TCP_PROXY`: Set to `false` to disable the internal TCP proxy. The bot will connect directly to `MESHTASTIC_IP`.
+- `PROXY_HANDSHAKE_CACHE_SIZE`: Number of initial packets to cache for connecting proxy clients (default `100`).
+- `PROXY_ROLLING_CACHE_SIZE`: Number of recent packets to cache in a rolling queue for connecting proxy clients (default `100`).
+
+### Command Toggles
+Set any of the following to `false` to disable the command and hide it from the `!help` menu:
+- `ENABLE_COMMAND_PING`
+- `ENABLE_COMMAND_TR`
+- `ENABLE_COMMAND_HELLO`
+- `ENABLE_COMMAND_HELP`
+- `ENABLE_COMMAND_NODES`
+- `ENABLE_COMMAND_WHOAMI`
+- `ENABLE_COMMAND_PREFS`
+- `ENABLE_COMMAND_ADMIN`
+- `ENABLE_COMMAND_STATUS`
+
+---
+
+## Docker Compose Options
+
+There are two primary ways to run the bot using Docker:
+
+### 1. Standard (`docker-compose.yaml`) - **Recommended for local builds**
+- **Purpose**: Stable use with local source control.
+- **How it works**: It builds the bot locally from the source files in the repository.
+- **Includes**: Integrated **Watchtower** service which automatically checks for and applies updates to the `meshtastic-bot` container every hour.
+- **Environment**: Configuration is pulled from your `.env` file.
+
+### 2. Remote/Pre-built (`docker-compose-remote.yaml`)
+- **Purpose**: Quick deployment using the official container.
+- **How it works**: Pulls the pre-built image from the **GitHub Container Registry** (`ghcr.io`). 
+- **Configuration**: Uses `meshtastic-bot.env` for environment variables and a named Docker volume (`mesh_bot_data`) for persistence.
+
+---
+
 ## Native Installation (Advanced/Development)
 
 If you prefer to run the bot natively (e.g., for development or customization):
@@ -85,17 +134,39 @@ If you prefer to run the bot natively (e.g., for development or customization):
 
 ## Usage
 
-The bot listens for messages and responds to commands. You can interact with it via supported Meshtastic channels.
+The bot listens for messages and responds to commands as a direct message. You can interact with it via supported Meshtastic channels.
 
 ### Supported Commands
 
-| Command   | Description                                    |
-|-----------|------------------------------------------------|
-| `!help`   | Displays a list of available commands          |
-| `!hello`  | Displays information about the bot             |
-| `!ping`   | Responds with "Pong!"                          |
-| `!nodes`  | Displays a list of connected nodes, stats, etc |
-| `!whoami` | Displays information about the sender          |
+| Command   | Description                                                   |
+|-----------|---------------------------------------------------------------|
+| `!help`   | Displays a list of available commands                         |
+| `!hello`  | Displays information about the bot                            |
+| `!ping`   | Responds with "Pong!"                                         |
+| `!nodes`  | Displays a list of connected nodes, stats, etc                |
+| `!nodes totals` | Manually triggers a node count report                        |
+| `!whoami` | Displays information about the sender                         |
+| `!tr`     | Performs a traceroute to the sender (outbound & inbound)      |
+| `!status` | Displays bot status and radio connection details              |
+
+## Features
+
+### Node Count Reporting
+The bot monitors mesh visibility and provides automated reporting:
+- **Scheduled Reports:** Every 3 hours, a status update is sent to Channel 2 (GregPrivate) with the current online node count.
+- **Immediate Alerts:** If the visible node count drops to zero, the bot sends an immediate warning.
+- **Manual Check:** Use `!nodes totals` to get an instant report via DM.
+
+### Enhanced Connectivity (TCP Proxy)
+The bot now includes a built-in TCP proxy to manage the connection to the Meshtastic node. This improves stability and allows for automatic reconnection if the radio connection is lost.
+
+### Improved Logging
+Messages received on named Group Channels (e.g., 'LongRange', 'PrivateChat') are now logged with their specific channel name, making it easier to track conversations across different mesh networks.
+
+### Advanced Traceroute
+The `!tr` command has been upgraded to show the full path:
+- **Outbound:** The route from the bot to your node.
+- **Inbound:** The route back from your node to the bot (if available).
 
 ---
 

docker-compose-remote.yaml

@@ -0,0 +1,16 @@
+#----- Docker Compose.yaml ------  
+services:
+  bot:
+    image: ghcr.io/pskillen/meshtastic-bot:latest
+    container_name: meshtastic-bot
+    restart: unless-stopped
+    ports:
+      - "4403:4403"
+    env_file:
+      - meshtastic-bot.env
+    volumes:
+      - ./src:/app/src
+      - mesh_bot_data:/app/data
+
+volumes:
+  mesh_bot_data:

docker-compose.yaml

@@ -1,24 +1,39 @@
 ---
 
 services:
-  meshtastic-bot:
-    image: ghcr.io/pskillen/meshtastic-bot:latest
-    build:
-      context: "./"
+  bot:
+    build: .
     container_name: meshtastic-bot
     restart: unless-stopped
+    ports:
+      - "4403:4403"
     environment:
-      - MESHTASTIC_IP=meshtastic.local
-      - ADMIN_NODES='!aae8900d'  # Change this, unless you want me to be the admin of your bot
-    volumes:
-      - ./data:/app/data
-    depends_on:
-      - watchtower
+      - MESHTASTIC_IP=${MESHTASTIC_IP:-192.168.4.210} # Your Meshtastic Node IP here
+      - STORAGE_API_ROOT=${STORAGE_API_ROOT}
+      - STORAGE_API_TOKEN=${STORAGE_API_TOKEN}
+      - STORAGE_API_VERSION=${STORAGE_API_VERSION}
+      - ENABLE_TCP_PROXY=${ENABLE_TCP_PROXY:-true}
+      - ENABLE_FEATURE_NODE_TOTALS=${ENABLE_FEATURE_NODE_TOTALS:-true}
+      - FREQUENCY_OF_NODE_REPORTS=${FREQUENCY_OF_NODE_REPORTS:-3}
+      - CHANNEL_FOR_NODE_TOTAL_BROADCAST=${CHANNEL_FOR_NODE_TOTAL_BROADCAST:-2}
+      - ENABLE_COMMAND_PING=${ENABLE_COMMAND_PING:-true}
+      - ENABLE_COMMAND_TR=${ENABLE_COMMAND_TR:-true}
+      - ENABLE_COMMAND_HELLO=${ENABLE_COMMAND_HELLO:-true}
+      - ENABLE_COMMAND_HELP=${ENABLE_COMMAND_HELP:-true}
+      - ENABLE_COMMAND_NODES=${ENABLE_COMMAND_NODES:-true}
+      - ENABLE_COMMAND_WHOAMI=${ENABLE_COMMAND_WHOAMI:-true}
+      - ENABLE_COMMAND_PREFS=${ENABLE_COMMAND_PREFS:-true}
+      - ENABLE_COMMAND_ADMIN=${ENABLE_COMMAND_ADMIN:-true}
+      - ENABLE_COMMAND_STATUS=${ENABLE_COMMAND_STATUS:-true}
+    labels:
+      - "com.centurylinklabs.watchtower.enable=false"
 
   watchtower:
     image: containrrr/watchtower
     container_name: watchtower
     restart: unless-stopped
     volumes:
       - /var/run/docker.sock:/var/run/docker.sock
-    command: --interval 3600 meshtastic-bot  # Check for updates every hour
+    environment:
+      - DOCKER_API_VERSION=1.44
+    command: --interval 3600 --label-enable

find_node.py

@@ -0,0 +1,15 @@
+import sqlite3
+import sys
+
+try:
+    conn = sqlite3.connect('/app/data/node_db.sqlite')
+    cursor = conn.cursor()
+    cursor.execute("SELECT long_name, short_name, id FROM nodes WHERE short_name LIKE '%mte4%' OR long_name LIKE '%mte4%'")
+    rows = cursor.fetchall()
+    if not rows:
+        print("No node found with 'mte4' in name.")
+    for row in rows:
+        print(f"Found: {row}")
+    conn.close()
+except Exception as e:
+    print(f"Error: {e}")