core-data/org.meshtastic.core.data.ai/AiFunctionProvider

AiFunctionProvider

Platform-agnostic contract defining operations that AI systems can invoke.

This interface abstracts the app capabilities exposed to system AI assistants. On Android, the implementation is wired to AppFunctions. On other platforms, equivalent mechanisms (App Intents on iOS, MCP on Desktop) can implement this.

Inheritors

AiFunctionProviderImpl

Types

Companion

object Companion

Functions

getChannelInfo

abstract suspend fun getChannelInfo(): GetChannelInfoResult

List all available mesh channels and their configurations.

getDeviceStatus

abstract suspend fun getDeviceStatus(): GetDeviceStatusResult

Get status and metrics of the local mesh radio device.

getMeshMetrics

abstract suspend fun getMeshMetrics(): GetMeshMetricsResult

Get aggregate network metrics and statistics for the entire mesh.

getMeshStatus

abstract suspend fun getMeshStatus(): MeshStatusResult

Get the current mesh network status summary.

getNodeDetails

abstract suspend fun getNodeDetails(nodeId: String): GetNodeDetailsResult

Get detailed telemetry and status for a specific mesh node.

getNodeList

abstract suspend fun getNodeList(): GetNodeListResult

List all nodes currently visible on the mesh network.

getRecentMessages

abstract suspend fun getRecentMessages(contactName: String? = null, limit: Int = DEFAULT_MESSAGE_LIMIT): GetRecentMessagesResult

Get recent messages from the mesh network.

getUnreadSummary

abstract suspend fun getUnreadSummary(): GetUnreadSummaryResult

Get a summary of unread messages grouped by contact.

sendMessage

abstract suspend fun sendMessage(text: String, recipientName: String? = null, channelName: String? = null): SendMessageResult

Send a text message over the mesh network.