core/org.meshtastic.sdk/RadioClient/Builder

Builder

class Builder(source)

DSL builder for RadioClient.

transport and storage are required; all other settings have sensible defaults.

val client = RadioClient.Builder()
    .transport(TcpTransport(host = "192.168.1.42", port = 4403))
    .storage(InMemoryStorageProvider())
    .build()

Since

0.1.0

Constructors

constructor()

Functions

fun autoReconnect(config: AutoReconnectConfig): RadioClient.Builder

Configure the auto-reconnect supervisor with a pre-built AutoReconnectConfig.

fun autoReconnect(enabled: Boolean = true, initialBackoff: Duration = 1.seconds, maxBackoff: Duration = 60.seconds, maxAttempts: Int? = null, backoffMultiplier: Double = 2.0, jitter: Double = 0.2): RadioClient.Builder

Configure the engine's built-in auto-reconnect supervisor.

autoSyncTimeOnConnect

fun autoSyncTimeOnConnect(enabled: Boolean): RadioClient.Builder

Enable or disable automatic time sync on connect.

fun build(): RadioClient

Build and return a RadioClient.

fun clock(clock: Clock): RadioClient.Builder

Set a custom clock (useful for testing deterministic time-based behaviour).

coroutineContext

fun coroutineContext(ctx: CoroutineContext): RadioClient.Builder

Override the coroutine context for the engine actor and helper coroutines.

disableBleHeartbeat

fun disableBleHeartbeat(): RadioClient.Builder

Disable BLE heartbeats.

fun logger(sink: LogSink): RadioClient.Builder

Set a custom logger.

presenceTimeout

fun presenceTimeout(timeout: Duration): RadioClient.Builder

Configure the online/offline presence timeout for node presence events.

protocolLogging

fun protocolLogging(level: LogLevel, redactor: PayloadRedactor = PayloadRedactor.Default): RadioClient.Builder

Enable protocol-level logging.

fun rpcTimeout(duration: Duration): RadioClient.Builder

Configure the per-RPC timeout for AdminApi / TelemetryApi / RoutingApi calls.

fun sendTimeout(duration: Duration): RadioClient.Builder

Configure the per-send ACK timeout.

fun storage(provider: StorageProvider): RadioClient.Builder

Set the storage provider (required).

fun transport(transport: RadioTransport): RadioClient.Builder

Set a pre-built RadioTransport instance directly.