Files
meshcore-open/documentation
zjs81 5fb67abdde Merge dev; fix share-location and discovered-contact import/export; update docs
Merge dev (#588 share location, #436 discovered-contact import/export)
into fix/review-fixes-and-issue-batch. Conflicts: keep the node-scan
button alongside dev's import/export menu; take dev's marker label
prompt.

Share location (#588):
- Never share a missing or 0,0 radio position; hide the chat action and
  show "Your radio has no location set"
- Sanitise marker labels ('|' -> '/', newlines -> spaces) on every path
- One shared MarkerLabelDialog owning its controller/focus node, with
  keyboard submit, replacing three copies
- Map pins default to "Point of interest" again; "Share my location"
  uses the node name
- Location shares honour the send cooldown and handle send errors

Discovered-contact import/export (#436):
- Per-entry decoding with imported/skipped/invalid counts; reject keys
  that are not 32 bytes; skip in-file duplicates and the radio's own key
- Strip routing paths on import and stop exporting them; clamp future
  timestamps; enforce the discovered-contact cap; require a connection;
  2 MB file limit
- Export via in-memory XFile (fixes web); pass sharePositionOrigin for
  iPad (also GPX export and image save); macOS user-selected read-write
  entitlement for save dialogs

Docs: cover share location, import/export, node scan, TCP reconnect,
channel auto-resend options, arrival ordering, badge, password length
and image limits.

Translations for all new strings in every locale.
2026-10-11 01:54:07 -07:00
..

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+18 on October 11, 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 with automatic reconnect
  2. Navigation - App flow, device screen, and quick-switch navigation
  3. Contacts - Contact management, groups, discovery, nearby-node scan, discovered-contact import/export, and sharing
  4. Chat & Messaging - Direct messages, location sharing, message status, reactions, and retries
  5. Channels - Broadcast channels, communities, channel chat, and auto-resend
  6. Map & Location - Node map, shared pins, 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 - App and radio default regions, unscoped sends, 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
  17. Review Mode - Simulated radio and reviewer instructions for Google Play and App Store review

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
  • Share locations as map pins from chat or the map
  • Scan for nearby nodes and import/export discovered contacts
  • 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.