Package-level declarations
Types
Link copied to clipboard
data class BootloaderOtaQuirk(val hwModel: Int, val hwModelSlug: String? = null, val requiresBootloaderUpgradeForOta: Boolean = false, val infoUrl: String? = null)
Link copied to clipboard
Defines the capabilities and feature support based on the device firmware version.
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
data class Contact(val contactKey: String, val shortName: String, val longName: String, val lastMessageTime: Long?, val lastMessageText: String?, val unreadCount: Int, val messageCount: Int, val isMuted: Boolean, val isUnmessageable: Boolean, val nodeColors: ERROR CLASS: Symbol not found for Pair<kotlin/Int, kotlin/Int>?? = null) : <ERROR CLASS> ERROR CLASS: Symbol not found for CommonParcelable
Link copied to clipboard
Link copied to clipboard
data class DataPacket(var to: String? = ID_BROADCAST, var bytes: ERROR CLASS: Symbol not found for ByteString??, var dataType: Int, var from: String? = ID_LOCAL, var time: Long = nowMillis, var id: Int = 0, var status: MessageStatus? = MessageStatus.UNKNOWN, var hopLimit: Int = 0, var channel: Int = 0, var wantAck: Boolean = true, var hopStart: Int = 0, var snr: Float = 0.0f, var rssi: Int = 0, var replyId: Int? = null, var relayNode: Int? = null, var relays: Int = 0, var viaMqtt: Boolean = false, var emoji: Int = 0, var sfppHash: ERROR CLASS: Symbol not found for ByteString?? = null, var transportMechanism: Int = 0) : <ERROR CLASS> ERROR CLASS: Symbol not found for CommonParcelable
A parcelable version of the protobuf MeshPacket + Data subpacket.
Link copied to clipboard
data class DeviceHardware(val activelySupported: Boolean = false, val architecture: String = "", val displayName: String = "", val hasInkHud: Boolean? = null, val hasMui: Boolean? = null, val hwModel: Int = 0, val hwModelSlug: String = "", val images: List<String>? = null, val partitionScheme: String? = null, val platformioTarget: String = "", val requiresDfu: Boolean? = null, val requiresBootloaderUpgradeForOta: Boolean? = null, val bootloaderInfoUrl: String? = null, val supportLevel: Int? = null, val tags: List<String>? = null)
Link copied to clipboard
Link copied to clipboard
Represent the different ways a device can connect to the client.
Link copied to clipboard
Provide structured access to parse and compare device version strings
Link copied to clipboard
data class EnvironmentMetrics(val time: Int = currentTime(), val temperature: Float?, val relativeHumidity: Float?, val soilTemperature: Float?, val soilMoisture: Int?, val barometricPressure: Float?, val gasResistance: Float?, val voltage: Float?, val current: Float?, val iaq: Int?, val lux: Float? = null, val uvLux: Float? = null) : <ERROR CLASS> ERROR CLASS: Symbol not found for CommonParcelable
Link copied to clipboard
Address identifiers for all supported radio backend implementations.
Link copied to clipboard
Represents activity on the mesh network.
Link copied to clipboard
Link copied to clipboard
data class Message(val uuid: Long, val receivedTime: Long, val node: Node, val text: String, val fromLocal: Boolean, val time: String, val read: Boolean, val status: MessageStatus?, val routingError: Int, val packetId: Int, val emojis: List<Reaction>, val snr: Float, val rssi: Int, val hopsAway: Int, val replyId: Int?, val originalMessage: Message? = null, val viaMqtt: Boolean = false, val relayNode: Int? = null, val relays: Int = 0, val filtered: Boolean = false, val transportMechanism: Int = 0)
Link copied to clipboard
enum MessageStatus : <ERROR CLASS> ERROR CLASS: Symbol not found for CommonParcelable, Enum<MessageStatus>
Link copied to clipboard
data class MyNodeInfo(val myNodeNum: Int, val hasGPS: Boolean, val model: String?, val firmwareVersion: String?, val couldUpdate: Boolean, val shouldUpdate: Boolean, val currentPacketId: Long, val messageTimeoutMsec: Int, val minAppVersion: Int, val maxChannels: Int, val hasWifi: Boolean, val channelUtilization: Float, val airUtilTx: Float, val deviceId: String?, val pioEnv: String? = null) : <ERROR CLASS> ERROR CLASS: Symbol not found for CommonParcelable
Link copied to clipboard
data class NetworkDeviceHardware(val activelySupported: Boolean = false, val architecture: String = "", val displayName: String = "", val hasInkHud: Boolean? = null, val hasMui: Boolean? = null, val hwModel: Int = 0, val hwModelSlug: String = "", val images: List<String>? = null, val key: String? = null, val partitionScheme: String? = null, val platformioTarget: String = "", val requiresDfu: Boolean? = null, val supportLevel: Int? = null, val tags: List<String>? = null, val variant: String? = null)
Link copied to clipboard
Link copied to clipboard
data class NetworkFirmwareReleases(val pullRequests: List<NetworkFirmwareRelease> = listOf(), val releases: Releases = Releases())
Link copied to clipboard
data class Node(val num: Int, val metadata: ERROR CLASS: Symbol not found for DeviceMetadata?? = null, val user: ERROR CLASS: Symbol not found for User = User(), val position: Position = Position(), val snr: Float = Float.MAX_VALUE, val rssi: Int = Int.MAX_VALUE, val lastHeard: Int = 0, val deviceMetrics: DeviceMetrics = DeviceMetrics(), val channel: Int = 0, val viaMqtt: Boolean = false, val hopsAway: Int = -1, val isFavorite: Boolean = false, val isIgnored: Boolean = false, val isMuted: Boolean = false, val environmentMetrics: EnvironmentMetrics = EnvironmentMetrics(), val powerMetrics: ERROR CLASS: Symbol not found for PowerMetrics = PowerMetrics(), val paxcounter: ERROR CLASS: Symbol not found for Paxcount = Paxcount(), val publicKey: ERROR CLASS: Symbol not found for ByteString?? = null, val notes: String = "", val manuallyVerified: Boolean = false, val nodeStatus: String? = null, val lastTransport: Int = 0)
Domain model representing a node in the mesh network.
Link copied to clipboard
data class NodeInfo(val num: Int, var user: MeshUser? = null, var position: Position? = null, var snr: Float = Float.MAX_VALUE, var rssi: Int = Int.MAX_VALUE, var lastHeard: Int = 0, var deviceMetrics: DeviceMetrics? = null, var channel: Int = 0, var environmentMetrics: EnvironmentMetrics? = null, var hopsAway: Int = 0, var nodeStatus: String? = null) : <ERROR CLASS> ERROR CLASS: Symbol not found for CommonParcelable
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
interface RadioController
Central interface for controlling the radio and mesh network.
Link copied to clipboard
Exception thrown when an operation is attempted while not connected to a mesh radio.
Link copied to clipboard
data class Reaction(val replyId: Int, val user: ERROR CLASS: Symbol not found for User, val emoji: String, val timestamp: Long, val snr: Float, val rssi: Int, val hopsAway: Int, val packetId: Int = 0, val status: MessageStatus = MessageStatus.UNKNOWN, val routingError: Int = 0, val relays: Int = 0, val relayNode: Int? = null, val to: String? = null, val channel: Int = 0, val sfppHash: ERROR CLASS: Symbol not found for ByteString?? = null)
Link copied to clipboard
Regulatory regions for radio usage
Link copied to clipboard
data class Releases(val alpha: List<NetworkFirmwareRelease> = listOf(), val stable: List<NetworkFirmwareRelease> = listOf())
Link copied to clipboard
Link copied to clipboard
Properties
Link copied to clipboard
val ERROR CLASS: Symbol not found for MeshPacket.fullRouteDiscovery: ERROR CLASS: Symbol not found for RouteDiscovery??
Link copied to clipboard
val ERROR CLASS: Symbol not found for MeshPacket.neighborInfo: ERROR CLASS: Symbol not found for NeighborInfo??
Link copied to clipboard
Functions
Link copied to clipboard
fun evaluateTracerouteMapAvailability(forwardRoute: List<Int>, returnRoute: List<Int>, positionedNodeNums: Set<Int>): TracerouteMapAvailability
Link copied to clipboard
Link copied to clipboard
fun ERROR CLASS: Symbol not found for MeshPacket.getFullTracerouteResponse(getUser: (nodeNum: Int) -> String, headerTowards: String = "Route traced toward destination:", headerBack: String = "Route traced back to us:"): String?
Returns a traceroute response string only when the result is complete (both directions).
Link copied to clipboard
fun ERROR CLASS: Symbol not found for MeshPacket.getNeighborInfoResponse(getUser: (nodeNum: Int) -> String, header: String = "Neighbors:"): String?
fun ERROR CLASS: Symbol not found for NeighborInfo.getNeighborInfoResponse(getUser: (nodeNum: Int) -> String, header: String = "Neighbors:"): String
Link copied to clipboard
fun getStringResFrom(role: ERROR CLASS: Symbol not found for MemberRole): ERROR CLASS: Symbol not found for StringResource
fun getStringResFrom(team: ERROR CLASS: Symbol not found for Team): ERROR CLASS: Symbol not found for StringResource
Link copied to clipboard
Link copied to clipboard