Files
meshcore-open/documentation/README.md
T
zjs81 25f8d6ae27 Add notification replies, Android Auto support, and channel mute bell
- Message notifications use Android MessagingStyle with Reply, Mark as read,
  and Mute channel actions, so they work in Android Auto and on watches
- Replies go through the normal send path (length limits, SMAZ, Cyr2Lat,
  retries), split into up to 3 messages, and report failures
- Declare Android Auto notification support and register the action receiver
- Add a bell icon to channel chat to mute/unmute; unify the channel mute key
  so unnamed channels mute correctly
- Update README and docs for Android Auto support
2026-09-27 21:55:43 -07:00

4.0 KiB

MeshCore Open - Feature Documentation

MeshCore Open is an open-source Flutter client for MeshCore LoRa mesh networking devices. These guides describe current user-facing features and their requirements. Reviewed against app 9.5.0+16, including region-display merge 5eca459e, on September 27, 2026. Hardware behavior still depends on platform, radio, and firmware.

Start here

  1. Use compatible MeshCore companion firmware and connect a radio.
  2. Wait for synchronization, then open a channel or contact chat.
  3. For scoped floods, configure regions. For image packets, install the image model.
  4. If a device or feature is unavailable, use troubleshooting.

Table of Contents

  1. Scanner & Connection - BLE scanning, USB serial, and TCP connection
  2. Navigation - App flow, device screen, and quick-switch navigation
  3. Contacts - Contact management, groups, discovery, and sharing
  4. Chat & Messaging - Direct messages, message status, reactions, and retries
  5. Channels - Broadcast channels, communities, and channel chat
  6. Map & Location - Node map, path tracing, line-of-sight, and offline caching
  7. Settings - Device settings, app settings, radio configuration, and exports
  8. Notifications - System notifications, replies from watches and Android Auto, unread badges, and notification preferences
  9. Repeater Management - Repeater hub, status, CLI, telemetry, and neighbors
  10. Additional Features - GIF picker, localization, debug logs, SMAZ compression, and more
  11. Routing Paths - Path encoding, validation, device capability detection, and storage
  12. BLE Protocol & Data Layer - Technical reference for the communication protocol and data architecture
  13. Regions - Default/override scopes, message labels, and reply regions
  14. Image Messages - Model setup, mesh image sending, recovery, and reconstruction
  15. Companion Radio Statistics - Noise, signal metrics, and airtime
  16. Troubleshooting - BLE, USB, browser, and firmware issues

App Overview

MeshCore Open connects to MeshCore LoRa mesh radios over BLE, USB, or TCP. Once connected, users can:

  • Chat with other mesh nodes via encrypted direct messages
  • Broadcast on shared channels (public, hashtag, private, or community-scoped)
  • View nodes on a map with GPS locations, predicted positions, and path traces
  • Manage repeaters with CLI access, telemetry, neighbor info, and settings
  • Share contacts via meshcore:// URIs and QR codes
  • Configure radio settings including frequency, power, bandwidth, and spreading factor
  • Cache offline maps for use without internet connectivity
  • Analyze line-of-sight between nodes with terrain elevation profiles
  • Use Android Auto to hear new messages and reply by voice while driving (Android)

What needs internet?

Feature Internet requirement
Radio messaging, region-scoped sends No internet needed for the mesh transport
Mesh image encoding/reconstruction Local after model installation
On-device translation Local after model installation
Model downloads Internet required
GIF search/display and URL image previews Internet required to retrieve content
Map display Cached tiles work offline; uncached tiles need internet
Terrain LOS analysis Elevation lookup needs internet unless the required data is already cached

Keeping documentation current

When changing a feature, update its access steps, defaults, platform/firmware requirements, failure states, and screenshots. Keep binary framing details in the protocol reference and implementation links. See contribution guidelines.