Ryan Malloy
dbed318124
Standalone PlatformIO project using MeshCore as a library. Features: - Heltec LoRa32 V3 support (ESP32-S3 + SX1262) - OLED display integration - OTA firmware updates via WiFi - Serial CLI for configuration Uses symlinked MeshCore library from ../MeshCore
128 lines
2.5 KiB
Markdown
128 lines
2.5 KiB
Markdown
# Serial Commands
|
|
|
|
Connect at **115200 baud**:
|
|
|
|
```bash
|
|
screen /dev/ttyUSB0 115200
|
|
```
|
|
|
|
Commands are entered without a prompt. Type and press Enter.
|
|
|
|
---
|
|
|
|
## System Commands
|
|
|
|
| Command | Description |
|
|
|---------|-------------|
|
|
| `ver` | Show firmware version |
|
|
| `board` | Show board/hardware info |
|
|
| `reboot` | Restart the device |
|
|
| `erase` | Factory reset (serial only, not remote) |
|
|
|
|
---
|
|
|
|
## Network Commands
|
|
|
|
| Command | Description |
|
|
|---------|-------------|
|
|
| `advert` | Send advertisement to mesh |
|
|
| `neighbors` | List known neighbor nodes |
|
|
| `neighbor.remove <id>` | Remove a neighbor by ID |
|
|
|
|
---
|
|
|
|
## Time/Clock Commands
|
|
|
|
| Command | Description |
|
|
|---------|-------------|
|
|
| `clock` | Show current RTC time |
|
|
| `clock sync` | Sync clock from mesh |
|
|
| `time <epoch>` | Set time (Unix epoch seconds) |
|
|
|
|
---
|
|
|
|
## GPS Commands
|
|
|
|
| Command | Description |
|
|
|---------|-------------|
|
|
| `gps` | Show GPS status |
|
|
| `gps on` | Enable GPS module |
|
|
| `gps off` | Disable GPS module |
|
|
| `gps sync` | Sync time from GPS |
|
|
| `gps setloc` | Set location from GPS fix |
|
|
| `gps advert none` | Don't include GPS in adverts |
|
|
| `gps advert share` | Share GPS location in adverts |
|
|
| `gps advert prefs` | Use preference setting |
|
|
|
|
---
|
|
|
|
## Configuration Commands
|
|
|
|
| Command | Description |
|
|
|---------|-------------|
|
|
| `get af` | Get airtime fairness setting |
|
|
| `set af <0-100>` | Set airtime fairness (0=off, 100=max) |
|
|
| `password <old> <new>` | Change admin password |
|
|
|
|
---
|
|
|
|
## Sensor Commands
|
|
|
|
| Command | Description |
|
|
|---------|-------------|
|
|
| `sensor list` | List detected sensors |
|
|
| `sensor get <name>` | Read a sensor value |
|
|
| `sensor set <name> <value>` | Configure a sensor |
|
|
|
|
---
|
|
|
|
## Radio Commands
|
|
|
|
| Command | Description |
|
|
|---------|-------------|
|
|
| `tempradio <params>` | Temporarily change radio settings |
|
|
|
|
---
|
|
|
|
## OTA Update
|
|
|
|
| Command | Description |
|
|
|---------|-------------|
|
|
| `start ota` | Start WiFi AP and OTA server |
|
|
|
|
After running, connect to `MeshCore-OTA` WiFi and browse to `http://192.168.4.1/update`.
|
|
|
|
---
|
|
|
|
## Logging Commands
|
|
|
|
| Command | Description |
|
|
|---------|-------------|
|
|
| `log start` | Start packet logging to SPIFFS |
|
|
| `log stop` | Stop packet logging |
|
|
| `clear stats` | Clear statistics counters |
|
|
|
|
---
|
|
|
|
## Example Session
|
|
|
|
```
|
|
ver
|
|
-> MeshCore v1.10.0
|
|
|
|
neighbors
|
|
-> 3 neighbors:
|
|
1. AABBCCDD (-65 dBm, 2 hops)
|
|
2. EEFF0011 (-78 dBm, 1 hop)
|
|
3. 22334455 (-82 dBm, 3 hops)
|
|
|
|
clock
|
|
-> 2025-01-25 11:45:32 UTC
|
|
|
|
advert
|
|
-> Advertisement sent
|
|
|
|
start ota
|
|
-> Started: http://192.168.4.1/update
|
|
```
|