Package-level declarations

Device configuration and control RPCs.

Receiver type for AdminApi.editSettings — exposes the subset of admin writes that may be batched inside a begin_edit_settings / commit_edit_settings envelope.

Result of an admin (configuration) RPC operation.

Tunables for the engine's built-in auto-reconnect supervisor.

Curated battery health and state information.

Type-safe wrapper for channel indices.

Static helpers for encoding and parsing Meshtastic channel URLs (https://meshtastic.org/e/#...).

Aggregate of configuration and device metadata received during the handshake.

Handshake phase for progress reporting.

Lifecycle of the SDK's connection to a device.

Device storage backend.

Which flow type dropped messages.

A framed packet ready for transmission or received from the device.

Key-verification prompt details surfaced via MeshEvent.KeyVerification.

A geographic coordinate pair with an optional altitude.

Severity level for log messages.

Functional interface for consuming log messages.

Side-channel event from the SDK engine.

DSL marker for the SendBuilder outbound-packet builder. Restricts implicit-receiver scoping so that nested DSLs do not accidentally capture builder methods from an outer scope.

Sealed hierarchy of Meshtastic SDK exceptions.

Tracks the lifecycle of a packet enqueued via RadioClient.send.

Type-safe wrapper for message/packet IDs (uint32).

A delta notification of node state changes.

Fields that may change in a NodeInfo.

Type-safe wrapper for Meshtastic node identifiers (uint32).

Strategy for redacting sensitive payload data in protocol logs.

The main entry point to the Meshtastic SDK.

Physical layer metrics for a received packet.

Interface that transports (BLE, TCP, serial, etc.) must implement.

Mesh route discovery and neighbor enumeration RPCs.

Builder for an outbound MeshPacket. Created by RadioClient.send (DSL form).

Reason a packet could not be delivered.

Outcome of awaiting a MessageHandle.

Lifecycle state of a packet sent via RadioClient.send.

Persisted session passkey.

Storage provider factory.

Telemetry RPCs and observation.

A type-safe wrapper for the different categories of telemetry data reported by the mesh.

Deterministic identity for a transport configuration.

Specification of which radio to connect to and how.

State of the transport connection.

Pure codec for wire framing and protobuf serialization.

Single source of truth for the Meshtastic STREAM_API wire-framing constants shared by every stream-oriented transport (TCP, USB-CDC serial, BLE).

Maximum application-layer payload length (bytes).

The default Pre-Shared Key (AES-128) used for the Meshtastic primary channel.

Returns the display-friendly hex ID of this node (e.g., "!aabbccdd").

Returns a human-friendly display name for this HardwareModel (e.g., "T-Beam").

Returns true if this is NodeId.BROADCAST.

Returns true if this is a specific node address (neither local nor broadcast).

Returns the long name of this node (e.g., "James Arich").

Returns the short name of this node (e.g., "ABCD").

Human-readable, action-hinting message for a wire-level Routing.Error. Suitable for direct surfacing in logs, snackbars, or developer tools without further translation.

Decodes the payload as AdminMessage if MeshPacket.decoded.portnum matches PortNum.ADMIN_APP.

Decodes the payload as NodeInfo if MeshPacket.decoded.portnum matches PortNum.NODEINFO_APP.

Decodes the payload as User if MeshPacket.decoded.portnum matches PortNum.NODEINFO_APP.

Decodes the payload as Position if MeshPacket.decoded.portnum matches PortNum.POSITION_APP.

Decodes the payload as Routing if MeshPacket.decoded.portnum matches PortNum.ROUTING_APP.

Decodes the payload as Telemetry if MeshPacket.decoded.portnum matches PortNum.TELEMETRY_APP.

Decodes the payload as a UTF-8 string if MeshPacket.decoded.portnum matches PortNum.TEXT_MESSAGE_APP.

Suspend until the device finishes streaming its NodeDB during handshake, then return the current node-snapshot map.

Connect and suspend until the handshake settles, returning the resolved ConfigBundle (HLP-34).

Decode this packet's decoded.payload using the supplied Wire adapter.

Decode the payload as AdminMessage iff decoded.portnum == ADMIN_APP.

Decode the payload as a full NodeInfo iff decoded.portnum == NODEINFO_APP.

Decode the payload as a Position iff decoded.portnum == POSITION_APP.

Decode the payload as Routing iff decoded.portnum == ROUTING_APP.

Decode the payload as Telemetry iff decoded.portnum == TELEMETRY_APP.

Decode the payload as UTF-8 text iff decoded.portnum == TEXT_MESSAGE_APP.

Decode the payload as a User (NodeInfo user record) iff decoded.portnum == NODEINFO_APP.

Returns a standard PRIMARY Channel configuration (index 0, empty name, default PSK).

Converts a 32-bit unsigned firmware timestamp (seconds since epoch) to an SDK Instant. Returns null if the timestamp is 0 (the firmware's "never/unset" sentinel).

Parses an 8-character hex string (optionally prefixed with ! or 0x) into a NodeId. Returns null if the string is not a valid 8-character hex value.

Computes the 8-bit hash of name and psk, used by firmware to identify channels on the wire.

Plain-language message for any SendFailure. Never empty.

Returns true if this is NodeId.LOCAL or matches the supplied own ID. Useful for filtering packets originating from the host.

Returns a human-friendly relative time string (e.g., "5m ago", "2h ago").

Returns a relative time string, or "never" if the instant is null.

Request the current Position from node from.

Re-enqueue the same packet that produced this MessageHandle. The engine assigns a fresh MessageId and returns a new handle, leaving the original handle's terminal state unchanged.

DSL form of RadioClient.send. Builds a MeshPacket via SendBuilder and enqueues it.

Send a unicast text message to to. Defaults wantAck to true.

Send a PKI-encrypted unicast text message to to.

Send a Position payload to to (defaults to broadcast).

Returns a signal quality estimate from 1 (poor) to 5 (excellent) based on SNR.

Tag categorising the recommended remediation for a Routing.Error. Returns null when no error was reported (NONE).

Converts protobuf DeviceMetrics to BatteryStatus.

Converts protobuf Telemetry to BatteryStatus by inspecting its DeviceMetrics.

Encode this FromRadio envelope to its wire byte representation.

Encode this MeshPacket to its wire byte representation.

Encode this ToRadio envelope to its wire byte representation.

Converts an SDK Instant to a 32-bit unsigned firmware timestamp.

Decode a FromRadio envelope from raw wire bytes. Returns null on parse failure.

Returns the 8-character hex representation of this NodeId (e.g., "aabbccdd"). Does not include the ! or 0x prefix.

Converts a protobuf Position to an SDK LatLng.

Decode a MeshPacket from raw wire bytes. Returns null if this is not a valid MeshPacket proto encoding (any decoding Throwable is swallowed).

Extracts RadioMetrics from a MeshPacket. Returns null if metrics are missing.

Maps a protobuf Telemetry packet to its corresponding type-safe TelemetryReading.

Decode a ToRadio envelope from raw wire bytes. Returns null on parse failure.

Converts this ChannelSet into a base64-url-safe Meshtastic share link.