Files
MeshCore-Solo/README.md

88 lines
3.9 KiB
Markdown
Raw Normal View History

# Wio Tracker L1 — Extended Companion Radio Firmware
2025-01-13 14:07:48 +11:00
This branch extends the official MeshCore companion radio firmware for the **Seeed Wio Tracker L1**.
2025-01-13 14:07:48 +11:00
## New Features
2025-01-13 14:07:48 +11:00
### Messages Screen
2025-01-13 14:07:48 +11:00
View and send messages using the on-screen keyboard or predefined quick replies. The keyboard supports placeholders that insert live sensor data — `{time}` and `{loc}` are always available; additional placeholders (`{temp}`, `{hum}`, `{pres}`, `{batt}`, `{alt}`, `{lux}`, `{co2}`) appear automatically for sensors that are connected and returning data.
Press Enter on a message to open it in fullscreen. Navigate between messages with left (newer) and right (older).
2025-01-13 14:07:48 +11:00
Hold Enter on a message or channel to open a context menu: change per-channel notification settings (overrides the global sound setting) or mark messages as read.
2025-01-13 14:07:48 +11:00
### Settings Screen
2025-01-13 14:07:48 +11:00
All settings are saved to flash and restored on next boot.
2025-01-13 14:07:48 +11:00
- **Display**
- Brightness
- Auto-off timeout
- Battery display mode (icon, %, V)
- Clock seconds (show/hide — hiding reduces display refresh from 1 s to 60 s)
- **Sound**
- Buzzer: On / Off / **Auto** — Auto mode silences the device while connected via Bluetooth, and re-enables sound when the connection drops
- Volume
- **Home Pages** — toggle visibility of individual home screen pages
- **Radio**
- TX power
- **System**
- Timezone (UTC offset in hours)
- Low battery shutdown threshold
- **GPS**
- Position broadcast interval
- **Contacts**
- Show all DMs or favourites only
- Show all room servers or favourites only
- **Messages**
- Edit up to 10 quick reply templates
2025-01-13 14:07:48 +11:00
### Clock Screen
2025-03-08 13:40:39 +11:00
A dedicated clock page on the home screen shows the current time and date, synchronized from GPS or via Bluetooth. Timezone offset is applied from Settings.
2025-01-13 14:07:48 +11:00
Up to three configurable data fields are displayed below the clock. Available fields: battery voltage, temperature, humidity, pressure, GPS coordinates, altitude, luminosity, CO₂, contact count, and total unread message count.
### Nearby Nodes
Browse nodes that have recently advertised on the mesh. Filter by category (Favourites, All, Companion, Repeater, Room, Sensor). Select a node to see its coordinates, distance, bearing with cardinal direction, type, and last-heard time.
Use **Send my advert** (hold Enter → context menu) to broadcast your position and prompt nearby nodes to respond with theirs.
### Tools Screen
2025-05-18 02:47:09 +12:00
#### Auto-Advert
Periodically broadcasts a 0-hop advert with your GPS position so nearby nodes can track your location automatically. Configurable interval: off / 1 min / 2 min / 5 min / 10 min / 30 min / 1 h.
A blinking **A** indicator appears in the status bar while Auto-Advert is active.
#### Ringtone Editor
2025-01-20 22:03:31 +11:00
A step sequencer for composing custom ringtones stored on the device. Supports up to 32 notes with adjustable pitch, octave, duration, and BPM. Playback preview is available directly from the editor menu.
2025-05-18 02:18:32 +12:00
> Custom ringtones as per-channel or per-contact notification sounds are planned for a future update.
2025-05-18 02:18:32 +12:00
#### Auto-Reply Bot
2025-05-18 02:18:32 +12:00
Automatically replies to incoming messages that contain a configured trigger word (case-insensitive).
2025-05-18 02:18:32 +12:00
- **DM mode** — when enabled, the bot listens to all incoming private messages and replies with the DM reply text.
- **Channel mode** — optionally, select a channel for the bot to monitor. When a trigger is matched, it replies with a separate channel reply text.
- Both modes can be active simultaneously and share the same trigger word but use independent reply texts.
- Replies support placeholders (`{time}`, `{loc}`).
- A 10-second cooldown prevents repeated replies in quick succession.
2025-05-18 02:18:32 +12:00
---
2025-05-18 02:18:32 +12:00
Feel free to explore, share feedback and feature requests!
2025-05-18 02:18:32 +12:00
## Development
2025-05-18 02:18:32 +12:00
This fork tracks the upstream [MeshCore](https://github.com/ripplebiz/MeshCore) repository. To prevent upstream changes from overwriting this README during merges, `README.md` is protected via `.gitattributes`. After cloning, run once:
2025-05-18 02:18:32 +12:00
```sh
git config merge.ours.driver true
```