core-network/org.meshtastic.core.network.service/ApiService

ApiService

Client for the Meshtastic public API (device hardware catalog and firmware releases).

Inheritors

Functions

abstract suspend fun getBootloaderOtaQuirks(): BootloaderOtaQuirksResponse

Fetches the nRF52 bootloader/OTA quirk catalog (advisory bootloader-upgrade flags and the SoftDevice-variant gating table) from the Meshtastic API. Decodes directly to the same model the bundled asset seed uses — the server serves this file verbatim, so there is nothing to transform.

getDeviceHardware

abstract suspend fun getDeviceHardware(): List<NetworkDeviceHardware>

Fetches the device hardware catalog from the Meshtastic API.

getDeviceLinks

abstract suspend fun getDeviceLinks(): NetworkDeviceLinksResponse

Fetches the resolved device-links catalog (msh.to purchase links) from the Meshtastic API.

getEventFirmware

abstract suspend fun getEventFirmware(): EventFirmwareResponse

Fetches event-firmware display metadata (editions, welcome messages, links) from the Meshtastic API.

getFirmwareReleaseManifest

abstract suspend fun getFirmwareReleaseManifest(manifestUrl: String): FirmwareReleaseManifest

Fetches the target manifest referenced by a firmware release's zip_url.

getFirmwareReleases

abstract suspend fun getFirmwareReleases(): NetworkFirmwareReleases

Fetches the list of available firmware releases from the Meshtastic API.

getMaintenanceUf2Manifest

abstract suspend fun getMaintenanceUf2Manifest(): MaintenanceUf2Manifest

Fetches the pinned maintenance-UF2 manifest (factory-erase and OTAFIX bootloader self-update images) from the Meshtastic API. Decodes directly to the same model the bundled asset seed uses — the server serves this file verbatim, so there is nothing to transform. Each image's own sha256 is still checked against the downloaded bytes before any write; that is unaffected by how this manifest itself is fetched.

getNightlyFirmware

abstract suspend fun getNightlyFirmware(): NetworkFirmwareNightly?

Fetches the nightly preview build pointer from meshtastic.github.io. Returns null when no nightly is currently published (HTTP 404); throws on transport or server errors so callers can distinguish "gone" from "unreachable".