Package-level declarations
Types
Envelope of the bundled device_bootloader_ota_quirks.json asset.
Defines the capabilities and feature support based on the device firmware version.
Monotonic counters for connection lifecycle events that cannot be inferred reliably from transient ConnectionState values. A fast disconnect/reconnect may be observed only as the final state, while these counters retain both lifecycle boundaries.
One atomically published view of canonical connection state and its lifecycle evidence.
Type-safe wrapper for contact key strings (channel index + node address).
A data class version of the protobuf MeshPacket + Data subpacket.
A selected-radio address, parsed from its stored form: one InterfaceId character followed by the transport's own identity for the device.
A msh.to device link resolved by the Meshtastic API (/resource/deviceLinks) and cached locally. Every link routes through the msh.to redirect service.
The physical transports a radio can be reached over. Demo Mode reaches no radio and has no DeviceType.
Zero-overhead wrapper providing structured access to parse and compare device version strings.
The event's own firmware release, so a client can surface its version or offer the download (zipUrl).
Display metadata for one event-specific firmware edition (Hamvention, DEFCON, …).
Font-family names for event branding — Google Font family names (e.g. Lato / Atkinson Hyperlegible), not URLs. Captured so the data is available; actually rendering with these fonts is a separate, platform-specific concern (a downloadable-font provider is Google-flavor only), so consumers may ignore them and fall back to the app typeface.
A labeled link for an event (website, schedule, map, …).
Response envelope for event-firmware display metadata. Matches the bundled event_firmware.json and the live GET https://api.meshtastic.org/resource/eventFirmware API (the source of truth), sharing the {version, generatedAt, source, <payload>[]} shape used by NetworkDeviceLinksResponse.
Richer event branding beyond a single accent color. Not all editions carry a full theme.
Named brand colors (#RRGGBB) for an event theme; any may be absent.
Outcome of checking a device's firmware version against the app's minimum requirements.
What the app does about a connected radio's FirmwareCheckStatus.
Authoritative target catalogue referenced by a firmware release's zip_url.
One firmware target declared by a FirmwareReleaseManifest.
Where a firmware-update nudge takes the user.
Fully validated connected-device firmware update information for platform UI and notifications.
Determines whether a connected local device is behind the latest stable firmware and where it can be updated.
The only permitted visual treatment for a firmware update: an informational update nudge.
Connection transports that can determine the Android firmware-update destination.
The rung a board reads at wherever the app names its support status. Top to bottom: hardware the project actively supports, independent maker hardware, then community hardware (including anything not actively supported).
Address identifiers for all supported radio backend implementations.
Nested by architecture, then (for nRF52) by SoftDevice wire value — RP2040 has no SoftDevice concept at all, so it correctly has no sub-key, unlike the old flat {s140_6_1_1, s140_7_3_0, rp2040} shape that mixed a SoftDevice-variant axis with an architecture axis in one object.
Pinned nRF52/RP2040 maintenance UF2 manifest — factory-erase and OTAFIX bootloader self-update images, keyed by hardware. Envelope of resource/maintenanceUf2 and the bundled maintenance_uf2.json seed asset. Each image's own sha256 is checked against its downloaded bytes before any write — see MaintenanceUf2.kt — independently of how this manifest itself is fetched.
Represents activity on the mesh network.
A received Mesh Beacon invitation — an advisory, zero-hop advertisement from another mesh offering a channel to join. Beacons are unsigned and originate from nodes outside the local NodeDB, so this is deliberately not a message/contact; it lives in the Discovery surface instead.
App-level MQTT proxy connection state, decoupled from the MQTT library's internal type.
UI-friendly outcome of a one-shot MQTT broker reachability probe.
A community root whose name says nothing about where it is, with the area it serves as ISO 3166-2 subdivisions, a center and radiusKm, or both.
The MQTT root directory the topic finder places a user with: envelope of resource/mqttRoots and the bundled mqtt_roots.json seed asset, served verbatim from meshtastic/api data/mqttRoots.json.
A single resolved device link from the Meshtastic API.
Response envelope of GET /resource/deviceLinks on the Meshtastic API. The server resolves meshtastic/msh.to's catalog into fully-classified links (type + targets + regions), so the client only stores and filters them — no client-side matching heuristic.
The API also returns a pullRequests array of open firmware PRs. It is deliberately not modelled: nothing in the app offers PR builds, and the list turns over several times a day, so carrying it only churned the bundled asset. The shared kotlinx.serialization.json.Json is configured with ignoreUnknownKeys, so responses still decode.
Domain model representing a node in the mesh network.
Type-safe representation of a mesh node address.
Controls the visual density of the node list.
The node-level map filters, shared by every view that draws nodes over a place: both map renderers and the camera mesh view. lastHeardSeconds of 0 means no limit.
Which security indicator a surface shows beside a node's name (design#149).
The legacy DFU SoftDevice+bootloader package a board takes over BLE, keyed in MaintenanceUf2Manifest by DeviceHardware.platformioTarget: BLE cannot read the drive's Board-ID, so the running node's target picks the row and the bootloader's own DIS Model Number must then equal bleModel before anything is written.
One OtafixAssetEntry.targetOverrides image, named and pinned the same way as its parent row.
Exception thrown when an operation is attempted while not connected to a mesh radio.
Regulatory regions for radio usage
The modem presets the firmware advertised as legal for one LoRa region, decoded from a LoRaRegionPresetMap.
A routing NAK from node from carrying Routing.Error value routingError for our packet requestId.
Durable per-node remote-administration session status, derived from the time of the last admin response that carried a session_passkey from the target node.
The Nordic SoftDevice an nRF52840 board's firmware is linked against. Static hardware fact, derived from the board's build.arduino.ldscript in meshtastic/firmware (nrf52840_s140_v6.ld / _v7.ld).
Properties
Type-safe interpretation of DataPacket.to.
Local display name, never sent. Broadcast name for share and export is user.long_name.
Maps a FirmwareCheckStatus to the gate the app applies.
True when the user has set a local display name for this node.
The illustration the apps show for this hardware: the cased variant when the registry lists one (index 1), else the bare board. The flasher's 3D model, when there is one, is named after the same file.
The broadcast long name while a display name hides it, else null.
The inbound path of a traceroute request that reached us, from its originator to us, with route_back empty. The relays appended themselves on the way and our radio added only its own SNR, so the endpoints are filled in here. Null unless this packet is a traceroute request.
Checks whether this packet is addressed to the broadcast channel.
Longest local display name in UTF-8 bytes. A cross-client limit shared with Apple, not the User.long_name cap.
The @mention wire token: @ followed by a node's hex user id (@!ffccee11). This is the single source of truth for the cross-platform wire format (see meshtastic/design#21) so the compose input, message rendering, and notification paths all detect it identically. The 8-hex run plus the negative lookahead reject a partial match against a longer id.
Last measured noise floor in dBm, or null when this reading has never been reported (LocalStats.noise_floor still holds firmware's 0 "no reading yet" sentinel). Every read of noise_floor should go through this so every consumer treats absence the same way, rather than each site repeating its own != 0 / ?: 0 guard.
The resource prefix every value of a labelled enum shares, one per enum. A consumer that has to tell an enum value's resource from a field's - settings search, which indexes fields and not the values they offer - reads this rather than keeping its own copy of the list.
The SNR (in dB) at or above which a packet sent with this modem preset can still be demodulated — i.e. the spreading-factor-determined demodulation floor. Signal quality should be judged relative to this limit, since the same SNR means very different things per preset: -15 dB is excellent on LongSlow (SF12) yet unusable on ShortFast (SF7).
Type-safe interpretation of DataPacket.from.
Resolves the rung in one place so every surface agrees. DeviceHardware.isMaker is a relationship and wins first, so a maker board never reads as plain supported once the registry promotes it; DeviceHardware.activelySupported is the project's lifecycle flag and decides the other two rungs. A legacy or untiered maker board falls through to that lifecycle check.
Functions
Normalizes the nightly pointer into the common release shape, or null when the pointer carries no usable version. Nightly artifacts are served per-file from the nightly host's root, so there is no release zip.
Resolves the RegionPresetConstraint the firmware advertised for region, or null when there is no constraint information and the client must therefore NOT restrict the preset list. A null result happens when:
Resolves persisted role names back to roles, dropping any the current protobufs no longer define.
The app's preferred default preset for region, or null when it has no region-specific default and the caller should fall back to ChannelOption.DEFAULT / the current preset.
The preset a first-ever setup in region should install, or null to leave the choice alone.
The ack proof rows the message detail sheet shows, or null when no proof was carried - the ordinary case, and every ack from firmware that predates MeshPacket.AckProofStatus.
True when an ack carried a proof and it did not verify, which is an attempted forgery rather than a quiet absence.
Checks whether this packet originated from the local device.
Whether firmware accepts this preset in region, for a radio that sent no LoRaRegionPresetMap. Lite, Narrow and Tiny are legal only in the regions firmware enforces; every other preset is unconstrained here. Not a substitute for the map: callers apply it only when the map is absent.
Clips to at most maxBytes of UTF-8, stepping whole code points so a surrogate pair is never cut in half.
Matches node search text (long/short name, hex id, decimal id, status message) with Unicode-aware case folding.
Merges a user-editable power-channel label into existing at the 0-based channelIndex.
Derives a unique color pair from a node number. Returns (foreground, background) as @ColorInt.
With use_preset on, keeps coding_rate only while it raises the preset's own coding rate, and stores 0 ("use the preset's") otherwise, so a value firmware ignores never sits in the config looking like it applies. A manual config, or a preset with no ChannelOption, comes back unchanged.
Trims and clips input to MAX_DISPLAY_NAME_BYTES; blank input becomes the empty string, which means unset.
One node against every filter.
Returns the modem preset the LoRa form should hold when the region changes from previousRegion to newRegion with current selected.
The routing NAK this packet carries, or null for any other packet, including a plain ACK.
The schema's one-sentence explanation of this enum value, or null where it has none.
The schema's label for this enum value, or null where the schema does not name it. A picker shows this in place of the constant's Kotlin name, and falls back to that name when it is null, so a value the schema has not reached still renders.
The LoRa region to suggest for an ISO 3166-1 alpha-2 countryCode, or null when the country has no clear answer. A starting point the user confirms, never a value written on its own. The same table as the Apple app's.
Pure mapping to the cached domain model. Callers are expected to drop TYPE_INTERNAL links (GitHub, YouTube, …), which never belong to a device's purchase section.
Display name for a traceroute hop. A node missing from the node DB comes back from the repository as a placeholder user with no hardware model and a generated "Meshtastic xxxx" name; that case is named by its full node id. Firmware fills a relay that did not add itself with the broadcast address, which is not a node, so it gets unknownHopLabel. A non-blank local displayName replaces the broadcast long name. A node last heard over MQTT (viaMqtt) is marked MQTT once, since a hop across MQTT is not an RF hop and its signal reading means something else.