core/org.meshtastic.sdk/MeshtasticException

MeshtasticException

sealed class MeshtasticException : Exception(source)

Sealed hierarchy of Meshtastic SDK exceptions.

Every subclass exposes optional transportIdentity and operation fields populated from the engine and transport modules so callers can attribute a failure without parsing the message string. Use tag to add context fluently when constructing from helpers.

Inheritors

HandshakeTimeout

StorageUnavailable

AlreadyConnected

PayloadTooLarge

Types

AlreadyConnected

class AlreadyConnected : MeshtasticException

connect() called while already connected.

object Companion

Helpers for attaching diagnostic context.

class FirmwareTooOld(val required: Int, val present: Int) : MeshtasticException

Device reports a firmware version incompatible with this SDK.

HandshakeTimeout

class HandshakeTimeout(val stage: String) : MeshtasticException

Handshake timed out before completing.

class NotConnected : MeshtasticException

Operation attempted while the client is not connected.

PayloadTooLarge

class PayloadTooLarge(val maxBytes: Int) : MeshtasticException

Payload exceeds the device's maximum data length (typically 233 bytes).

class Protocol(reason: String, cause: Throwable? = null) : MeshtasticException

Protocol violation: malformed wire data, handshake failure, unexpected packet structure.

StorageUnavailable

class StorageUnavailable(message: String = "Storage unavailable", cause: Throwable? = null) : MeshtasticException

Storage backend became unavailable during operation.

class Transport(reason: String, cause: Throwable? = null) : MeshtasticException

Transport-level error: connection refused, network unreachable, I/O failure, etc.

Properties

expect open val cause: Throwable?

expect open val message: String?

var operation: String?

A short operation tag (e.g. "connect", "engine.disconnect").

transportIdentity

var transportIdentity: TransportIdentity?

The TransportIdentity that produced this failure, if known.

Functions

fun <T : MeshtasticException> T.withContext(transportIdentity: TransportIdentity? = null, operation: String? = null): T

Attach diagnostic context. Returns this for fluent use.