mirror of
https://github.com/meshtastic/Meshtastic-Android.git
synced 2026-09-19 02:04:31 -04:00
61 lines
3.5 KiB
HTML
61 lines
3.5 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en" dir="ltr">
|
||
<head>
|
||
<meta charset="UTF-8">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||
<title>App Functions</title>
|
||
<link rel="stylesheet" href="../styles/docs.css">
|
||
</head>
|
||
<body data-page="app-functions" data-locale="en">
|
||
<pre class="markdown-content"># App Functions
|
||
|
||
App Functions expose Meshtastic capabilities to the Android system and to on-device AI assistants (such as Gemini) through the Android App Functions API. With them enabled, an assistant can discover and trigger mesh workflows for you — for example sending a message or checking your mesh status — without you opening the app. App Functions are available on **Google-flavor Android builds only**.
|
||
|
||
> ℹ️ **Note:** This is separate from the in-app **Chirpy** assistant. App Functions let the *system* AI assistant act on your mesh; Chirpy is a conversational assistant inside the Meshtastic app itself.
|
||
|
||
## Enabling App Functions
|
||
|
||
Control App Functions from **Settings → System AI**. The screen has:
|
||
|
||
- A **master toggle** labeled **"Allow AI access"**, with the subtitle *"Let system AI assistants (e.g. Gemini) discover and use mesh functions"*. When off, no functions are exposed to the system.
|
||
- An **individual toggle for each function**, so you can expose only the capabilities you want.
|
||
|
||
> ⚠️ **Important:** App Functions ship switched on. On a Google-flavor build the master toggle and every individual function, **Send message** included, start enabled — so an assistant can read your mesh data and send messages to your mesh until you turn **Allow AI access** off.
|
||
|
||
The functions are grouped into a **Write** section (functions that change something or send data to your mesh) and a **Read** section (functions that only return information).
|
||
|
||
|
||
|
||
The screenshot has **Send message** and **Get recent messages** switched off to illustrate per-function control; a fresh install shows every switch on.
|
||
|
||
### Write Functions
|
||
|
||
Function | What it does |
|
||
----------|--------------|
|
||
**Send message** | Sends a text message to a contact (direct message) or to a channel. The mesh carries at most 233 bytes of text, so keep assistant-composed messages short. |
|
||
|
||
### Read Functions
|
||
|
||
Function | What it returns |
|
||
----------|-----------------|
|
||
**Get mesh status** | Whether you're connected to a radio, and how many nodes are online. |
|
||
**Get node list** | The list of nodes on your mesh. |
|
||
**Get channel info** | Information about your channels. |
|
||
**Get device status** | Status of your connected radio. |
|
||
**Get node details** | Detailed information about a specific node. |
|
||
**Get mesh metrics** | Telemetry and metrics from your mesh. |
|
||
**Get recent messages** | Recent messages from your conversations. |
|
||
**Get unread summary** | A summary of unread messages. |
|
||
|
||
## Privacy
|
||
|
||
> 🔒 **Privacy:** The **Send message** function lets an assistant send messages to your mesh on your behalf, and the read functions expose node, message, and metric data to it. Because all of them start enabled, the choice you make here is what to turn off rather than what to turn on. Each function has its own toggle, and **Allow AI access** turns all of them off at once.
|
||
|
||
## Related Topics
|
||
|
||
- [Messages & Channels](messages-and-channels) — sending messages directly in the app
|
||
- [Nodes](nodes) — the node list the read functions draw from
|
||
- [Node Metrics](node-metrics) — the telemetry behind Get mesh metrics
|
||
</pre>
|
||
</body>
|
||
</html> |