From b8a77285ab7ff5c27742f016f41ba977fe4b5154 Mon Sep 17 00:00:00 2001 From: MarekWo Date: Thu, 15 Jan 2026 12:26:58 +0100 Subject: [PATCH] docs: Add MC_DEVICE_NAME=auto as recommended setting Updated README.md and .env.example to recommend auto-detection of device name from meshcli prompt instead of manual configuration. Co-Authored-By: Claude Opus 4.5 --- .env.example | 5 +++-- README.md | 4 +++- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/.env.example b/.env.example index 19ac8b2..2eed2db 100644 --- a/.env.example +++ b/.env.example @@ -11,8 +11,9 @@ MC_SERIAL_PORT=/dev/serial/by-id/[YOUR_DEVICE_ID] # Your MeshCore device name (used for .msgs file) -# Example: MarWoj, SP5XYZ, MyNode -MC_DEVICE_NAME=[YOUR_DEVICE_NAME] +# Use "auto" for automatic detection from meshcli (recommended) +# Or specify manually: MarWoj, SP5XYZ, MyNode +MC_DEVICE_NAME=auto # MeshCore configuration directory (where .msgs and settings files are stored) # Default: ./data/meshcore (inside project directory) diff --git a/README.md b/README.md index de9b7ba..d4e5cf4 100644 --- a/README.md +++ b/README.md @@ -69,9 +69,11 @@ For detailed feature documentation, see the [User Guide](docs/user-guide.md). **Required changes in .env:** - `MC_SERIAL_PORT=/dev/serial/by-id/` - - `MC_DEVICE_NAME=` + - `MC_DEVICE_NAME=auto` (recommended) or your device name - `TZ=Europe/Warsaw` (optional, set your timezone) + **Note:** With `MC_DEVICE_NAME=auto`, the system automatically detects your device name from meshcli. This is the recommended setting as it ensures the `.msgs` file always matches your actual device name. + **Leave these as default:** ```bash MC_CONFIG_DIR=./data/meshcore