From 24a7270e50937b284ed6d1bc5fa5d00c7246bca1 Mon Sep 17 00:00:00 2001 From: Copilot <198982749+Copilot@users.noreply.github.com> Date: Sun, 5 Apr 2026 17:59:11 -0700 Subject: [PATCH] Add deep link documentation to README (#1655) Agent-Logs-Url: https://github.com/meshtastic/Meshtastic-Apple/sessions/df28c94e-7e3d-44fc-8264-6ae1b875fb23 Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: garthvh <1795163+garthvh@users.noreply.github.com> --- README.md | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 76 insertions(+) diff --git a/README.md b/README.md index d2ab6c35..6e838ea3 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,82 @@ The last two major operating system versions are supported on iOS, iPadOS and ma ``` 2. Build, test, and commit the changes. +## Deep Links + +The app supports deep links using the `meshtastic:///` URL scheme, for use with shortcuts, intents, and web pages. + +### Messages + +| URL | Description | +|-----|-------------| +| `meshtastic:///messages` | Messages tab | +| `meshtastic:///messages?channelId={channelId}&messageId={messageId}` | Channel messages (`messageId` is optional) | +| `meshtastic:///messages?userNum={userNum}&messageId={messageId}` | Direct messages (`messageId` is optional) | + +### Connect + +| URL | Description | +|-----|-------------| +| `meshtastic:///connect` | Connect tab | + +### Nodes + +| URL | Description | +|-----|-------------| +| `meshtastic:///nodes` | Nodes tab | +| `meshtastic:///nodes?nodenum={nodenum}` | Selected node | + +### Mesh Map + +| URL | Description | +|-----|-------------| +| `meshtastic:///map` | Map tab | +| `meshtastic:///map?nodenum={nodenum}` | Node on map | +| `meshtastic:///map?waypointId={waypointId}` | Waypoint on map | + +### Settings + +Each settings item has an associated deep link. No parameters are supported for settings URLs. + +| URL | Description | +|-----|-------------| +| `meshtastic:///settings/about` | About Meshtastic | +| `meshtastic:///settings/appSettings` | App Settings | +| `meshtastic:///settings/routes` | Routes | +| `meshtastic:///settings/routeRecorder` | Route Recorder | +| **Radio Config** | | +| `meshtastic:///settings/lora` | LoRa Config | +| `meshtastic:///settings/channels` | Channels | +| `meshtastic:///settings/security` | Security Config | +| `meshtastic:///settings/shareQRCode` | Share QR Code | +| **Device Config** | | +| `meshtastic:///settings/user` | User Config | +| `meshtastic:///settings/bluetooth` | Bluetooth Config | +| `meshtastic:///settings/device` | Device Config | +| `meshtastic:///settings/display` | Display Config | +| `meshtastic:///settings/network` | Network Config | +| `meshtastic:///settings/position` | Position Config | +| `meshtastic:///settings/power` | Power Config | +| **Module Config** | | +| `meshtastic:///settings/ambientLighting` | Ambient Lighting | +| `meshtastic:///settings/cannedMessages` | Canned Messages | +| `meshtastic:///settings/detectionSensor` | Detection Sensor | +| `meshtastic:///settings/externalNotification` | External Notification | +| `meshtastic:///settings/mqtt` | MQTT | +| `meshtastic:///settings/paxCounter` | Pax Counter | +| `meshtastic:///settings/rangeTest` | Range Test | +| `meshtastic:///settings/ringtone` | Ringtone | +| `meshtastic:///settings/serial` | Serial | +| `meshtastic:///settings/storeAndForward` | Store & Forward | +| `meshtastic:///settings/telemetry` | Telemetry | +| **TAK** | | +| `meshtastic:///settings/tak` | TAK Config | +| **Logging** | | +| `meshtastic:///settings/debugLogs` | Debug Logs | +| **Developers** | | +| `meshtastic:///settings/appFiles` | App Files | +| `meshtastic:///settings/firmwareUpdates` | Firmware Updates | + ## Release Process For more information on how a new release of Meshtastic is managed, please refer to [RELEASING.md](./RELEASING.md)