core-model/org.meshtastic.core.model/DataPacket

DataPacket

@Serializable

data class DataPacket(var to: String? = NodeAddress.ID_BROADCAST, var bytes: ByteString?, var dataType: Int, var from: String? = NodeAddress.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: ByteString? = null, var transportMechanism: Int = 0, var xeddsaSigned: Boolean = false)(source)

A data class version of the protobuf MeshPacket + Data subpacket.

Constructors

constructor(to: String? = NodeAddress.ID_BROADCAST, bytes: ByteString?, dataType: Int, from: String? = NodeAddress.ID_LOCAL, time: Long = nowMillis, id: Int = 0, status: MessageStatus? = MessageStatus.UNKNOWN, hopLimit: Int = 0, channel: Int = 0, wantAck: Boolean = true, hopStart: Int = 0, snr: Float = 0.0f, rssi: Int = 0, replyId: Int? = null, relayNode: Int? = null, relays: Int = 0, viaMqtt: Boolean = false, emoji: Int = 0, sfppHash: ByteString? = null, transportMechanism: Int = 0, xeddsaSigned: Boolean = false)

constructor(to: String?, channel: Int, text: String, replyId: Int? = null)

Syntactic sugar to make it easy to create text messages

constructor(to: String?, channel: Int, waypoint: Waypoint)

Properties

val alert: String?

@Serializable(with = ByteStringSerializer::class)

var bytes: ByteString?

var channel: Int

var dataType: Int

val DataPacket.destination: NodeAddress

Type-safe interpretation of DataPacket.to.

var errorMessage: String?

If there was an error with this message, this string describes what was wrong.

var from: String?

var hopLimit: Int

val hopsAway: Int

var hopStart: Int

var id: Int

val DataPacket.isBroadcast: Boolean

Checks whether this packet is addressed to the broadcast channel.

var relayNode: Int?

var relays: Int

var replyId: Int?

@Serializable(with = ByteStringSerializer::class)

var sfppHash: ByteString?

val DataPacket.source: NodeAddress

Type-safe interpretation of DataPacket.from.

var status: MessageStatus?

val text: String?

If this is a text message, return the string, otherwise null

var to: String?

transportMechanism

var transportMechanism: Int

The transport mechanism this packet arrived over (see MeshPacket.TransportMechanism).

var viaMqtt: Boolean

var wantAck: Boolean

val waypoint: Waypoint?

var xeddsaSigned: Boolean

True when the radio verified this broadcast's XEdDSA signature (MeshPacket.xeddsa_signed).

Functions

fun DataPacket.isFromLocal(myNodeNum: Int? = null): Boolean

Checks whether this packet originated from the local device.