core/org.meshtastic.sdk/AdminApi

AdminApi

Device configuration and control RPCs.

Each method maps onto a single AdminMessage round-trip with the local device. Failures that are part of the normal operating envelope (timeout, unauthorized, session-key expiry, node unreachable for remote-admin paths) surface as typed AdminResult variants. Catastrophic failures (transport gone, engine torn down) throw MeshtasticException.

Acquired via RadioClient.admin. Available only while the client is connected.

Since

0.1.0

Functions

editSettings

abstract suspend fun <T> editSettings(block: suspend AdminEdit.() -> T): AdminResult<T>

Run block inside a begin_edit_settings / commit_edit_settings envelope so the device applies all writes atomically (avoids reboot-mid-edit corruption).

factoryReset

abstract suspend fun factoryReset(preserveBleBonds: Boolean = true): AdminResult<Unit>

Erase device state and reset to factory defaults.

getChannel

abstract suspend fun getChannel(index: ChannelIndex): AdminResult<Channel>

Read the Channel at index (0..7).

getConfig

abstract suspend fun getConfig(type: AdminMessage.ConfigType): AdminResult<Config>

Read a single Config section from the device.

getModuleConfig

abstract suspend fun getModuleConfig(type: AdminMessage.ModuleConfigType): AdminResult<ModuleConfig>

Read a single ModuleConfig section from the device.

getOwner

abstract suspend fun getOwner(): AdminResult<User>

Read the local node's User (long name / short name / hardware model / public key).

listChannels

abstract suspend fun listChannels(): AdminResult<List<Channel>>

Read every configured channel (indices 0..7).

nodeDbReset

abstract suspend fun nodeDbReset(preserveFavorites: Boolean = true): AdminResult<Unit>

Wipe the device's NodeDB, forcing a fresh discovery cycle on the mesh.

reboot

abstract suspend fun reboot(after: Duration = Duration.ZERO): AdminResult<Unit>

Reboot the device after after (default: immediately).

setChannel

abstract suspend fun setChannel(channel: Channel): AdminResult<Unit>

Write a Channel. The slot is determined by Channel.index.

setConfig

abstract suspend fun setConfig(config: Config): AdminResult<Unit>

Write a Config section to the device.

setFavorite

abstract suspend fun setFavorite(node: NodeId, favorite: Boolean): AdminResult<Unit>

Mark node as a favorite (persisted in firmware NodeDB).

setIgnored

abstract suspend fun setIgnored(node: NodeId, ignored: Boolean): AdminResult<Unit>

Mark node as ignored — packets from it are filtered before reaching apps.

setModuleConfig

abstract suspend fun setModuleConfig(config: ModuleConfig): AdminResult<Unit>

Write a ModuleConfig section to the device.

setOwner

abstract suspend fun setOwner(user: User): AdminResult<Unit>

Update the local node's User. Persists across reboots.

setTime

abstract suspend fun setTime(at: Instant? = null): AdminResult<Unit>

Set the device's wall clock to at (default: Clock.System.now()).

shutdown

abstract suspend fun shutdown(after: Duration = Duration.ZERO): AdminResult<Unit>

Power down the device after after (default: immediately).