Files
meshcore-open/documentation/navigation.md
T
zjs81 aa00a863c3 Refresh documentation and update Dutch translation
Documentation:
- Correct web transport support: USB via Web Serial in Chrome only; no
  BLE or TCP in the browser.
- Fix region scope semantics, routing modes (Auto/Flood/Manual), the
  156-byte DM limit, repeater CLI framing, the guessed-location algorithm,
  radio stats contents and settings labels.
- Add regions, image messages, radio statistics and troubleshooting guides.
- Restore coding conventions, localization workflow, storage scoping and
  transport entry points to CLAUDE.md/AGENTS.md; align build/CI commands.
- Replace the obsolete docs/BLE_PROTOCOL.md with a pointer to the
  maintained protocol reference.

Dutch (nl):
- Translate the 79 missing strings and correct existing mistranslations,
  typos and grammar (e.g. "Uitzoomen", "Handmatig", "Slowaaks", frequency
  range 150-2500 MHz).
- Use consistent terminology and informal "je" throughout; keep mesh terms
  such as repeater, node, flood, hop and advert in English.

Fixes #538
2026-09-27 13:12:23 -07:00

3.8 KiB

Navigation

App Flow

The app follows this general flow:

Launch → Scanner Screen → [Connect via BLE/USB/TCP] → Channels Screen

After connecting, the three main screens (Contacts, Channels, Map) are accessible via a persistent bottom navigation bar called the QuickSwitchBar.

Quick Switch Bar

The QuickSwitchBar is a Material 3 NavigationBar with a frosted-glass visual treatment (blur backdrop, transparent theme, rounded corners). It appears at the bottom of all three main screens.

Index Icon Label Screen
0 People Contacts ContactsScreen
1 Tag Channels ChannelsScreen
2 Map Map MapScreen

Tapping a tab replaces the current screen with a subtle fade + slight horizontal nudge transition (220ms forward, 200ms reverse). The back button is suppressed on all three main screens — navigation between them is flat, not stacked. All icons use outline variants (people_outline, tag, map_outlined) following Material 3 conventions.

Disconnection

  • The disconnect button (available in the overflow menu of each main screen) shows a confirmation dialog before disconnecting
  • If the device disconnects unexpectedly, the app automatically navigates back to the Scanner screen (fires after the current frame completes via a post-frame callback)
  • This auto-navigation behavior (DisconnectNavigationMixin) is shared across all main screens

Theme and Locale

  • Theme mode is user-configurable in App Settings (System / Light / Dark) — not locked to system
  • Language can be overridden to one of 18 supported languages, or follow the system locale
  • On web, if a non-Chromium browser is detected, the app shows a ChromeRequiredScreen instead of the Scanner (the web client needs Chrome for Web Serial USB)

Full Navigation Graph

ScannerScreen (root, always on stack)
  ├─ [BLE connect] → push → ChannelsScreen
  ├─ [TCP icon button] → push → TcpScreen
  │     └─ [TCP connected] → pushReplacement → ChannelsScreen
  └─ [USB icon button] → push → UsbScreen
        └─ [USB connected] → pushReplacement → ChannelsScreen

ContactsScreen (selected=0)
  ├─ [quick-switch 1] → pushReplacement → ChannelsScreen
  ├─ [quick-switch 2] → pushReplacement → MapScreen
  ├─ [tap contact] → push → ChatScreen
  ├─ [overflow > Settings] → push → SettingsScreen
  └─ [overflow > Discovered] → push → DiscoveryScreen

ChannelsScreen (selected=1)
  ├─ [quick-switch 0] → pushReplacement → ContactsScreen
  ├─ [quick-switch 2] → pushReplacement → MapScreen
  ├─ [tap channel] → push → ChannelChatScreen
  └─ [overflow > Settings] → push → SettingsScreen

MapScreen (selected=2)
  ├─ [quick-switch 0] → pushReplacement → ContactsScreen
  ├─ [quick-switch 1] → pushReplacement → ChannelsScreen
  ├─ [radar menu item] → enters in-map path trace mode (push → PathTraceMapScreen after path is built)
  ├─ [terrain menu item] → push → LineOfSightMapScreen
  └─ [long-press] → share marker sheet

Settings (push from any main screen)
  └─ [App Settings] → push → AppSettingsScreen
        └─ [Offline Map Cache] → push → MapCacheScreen

Screens using disconnect navigation trigger popUntil(route.isFirst), returning to the Scanner.

Additional settings destinations

Settings → Regions opens region management. Settings → Radio stats opens companion statistics, including self-telemetry access. Settings → Telemetry opens telemetry for your own radio directly. App Settings contains image model setup and translation model controls. Contact QR scanning is available from Contacts; community QR scanning is available from Channels.