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 <noreply@anthropic.com>
This commit is contained in:
MarekWo
2026-01-15 12:26:58 +01:00
parent 4814b43566
commit b8a77285ab
2 changed files with 6 additions and 3 deletions
+3 -2
View File
@@ -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)
+3 -1
View File
@@ -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/<your-device-id>`
- `MC_DEVICE_NAME=<your-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