TAKPacket-SDK/org.meshtastic.tak/TakPacketV2Data

TakPacketV2Data

data class TakPacketV2Data(val cotTypeId: Int = CotTypeMapper.COTTYPE_OTHER, val cotTypeStr: String? = null, val how: Int = CotTypeMapper.COTHOW_UNSPECIFIED, val callsign: String = "", val team: Int = 0, val role: Int = 0, val latitudeI: Int = 0, val longitudeI: Int = 0, val altitude: Int = 0, val speed: Int = 0, val course: Int = 0, val battery: Int = 0, val geoSrc: Int = 0, val altSrc: Int = 0, val uid: String = "", val deviceCallsign: String = "", val staleSeconds: Int = 0, val takVersion: String = "", val takDevice: String = "", val takPlatform: String = "", val takOs: String = "", val endpoint: String = "", val phone: String = "", val remarks: String = "", val environment: TakPacketV2Data.EnvironmentData? = null, val sensorFov: TakPacketV2Data.SensorFovData? = null, val marti: List<String> = emptyList(), val payload: TakPacketV2Data.Payload = Payload.None)(source)

Platform-agnostic data model for a TAKPacketV2 — the SDK's internal representation, decoupled from any specific protobuf library.

The parser (CotXmlParser) produces it from CoT XML; the builder (CotXmlBuilder) renders it back; TakPacketV2Serializer converts it to/from protobuf wire bytes (each platform uses its native protobuf library).

Shape: 26 envelope fields (the always-present scalars below) plus a single payload of type Payload (a sealed hierarchy with one variant per oneof arm). Two optional top-level annotations — environment and sensorFov — attach to any payload variant. PLI is implicit: there is no bool pli field; a packet whose payload is Payload.None (modeled here as Payload.Pli) and whose cotTypeId is an a-f-* friendly type IS a PLI position report.

All numeric fields carry the wire units documented per-property below (degrees×1e7 coordinates, cm/s speed, degrees×100 course, meters-HAE altitude); the data model stores already-converted integers, not floats.

Constructors

TakPacketV2Data

constructor(cotTypeId: Int = CotTypeMapper.COTTYPE_OTHER, cotTypeStr: String? = null, how: Int = CotTypeMapper.COTHOW_UNSPECIFIED, callsign: String = "", team: Int = 0, role: Int = 0, latitudeI: Int = 0, longitudeI: Int = 0, altitude: Int = 0, speed: Int = 0, course: Int = 0, battery: Int = 0, geoSrc: Int = 0, altSrc: Int = 0, uid: String = "", deviceCallsign: String = "", staleSeconds: Int = 0, takVersion: String = "", takDevice: String = "", takPlatform: String = "", takOs: String = "", endpoint: String = "", phone: String = "", remarks: String = "", environment: TakPacketV2Data.EnvironmentData? = null, sensorFov: TakPacketV2Data.SensorFovData? = null, marti: List<String> = emptyList(), payload: TakPacketV2Data.Payload = Payload.None)

Types

EnvironmentData

data class EnvironmentData(val temperatureCelsius: Double? = null, val windDirectionDeg: Int? = null, val windSpeedMetersPerSec: Double? = null)

Weather annotation from a CoT <environment> detail element.

Payload

sealed class Payload

The packet's payload variant — the SDK-side model of the TAKPacketV2 payload_variant oneof. Exactly one subtype is present per packet.

SensorFovData

data class SensorFovData(val type: TakPacketV2Data.SensorFovData.SensorType = SensorType.Unspecified, val azimuthDeg: Int = 270, val rangeMeters: Int? = null, val fovHorizontalDeg: Int = 45, val fovVerticalDeg: Int? = null, val elevationDeg: Int = 0, val rollDeg: Int? = null, val model: String? = null)

Sensor field-of-view cone from a CoT <sensor> detail element.

Properties

altitude

val altitude: Int

altitude in meters HAE (height above ellipsoid); may be negative.

altSrc

val altSrc: Int

altitude source as a GeoPointSource enum int.

battery

val battery: Int

battery charge, 0–100 percent (0 = not reported).

callsign

val callsign: String

the unit / operator callsign.

cotTypeId

val cotTypeId: Int

well-known CoT type as a CotType enum int (see CotTypeMapper); CotTypeMapper.COTTYPE_OTHER when the type is unknown.

cotTypeStr

val cotTypeStr: String?

raw CoT type string, set only when cotTypeId is CotTypeMapper.COTTYPE_OTHER so unknown types round-trip losslessly; null otherwise.

course

val course: Int

course over ground in degrees × 100 (0..36000); clamped to ≥ 0.

deviceCallsign

val deviceCallsign: String

device identifier from <uid Droid="…"/>.

endpoint

val endpoint: String

contact endpoint; not carried over the mesh (normalized to empty on parse, defaulted to the TAK server-reply form on build).

environment

val environment: TakPacketV2Data.EnvironmentData?

Observed weather annotation from <environment> CoT detail element. Attaches to any payload variant. null means the source XML had no <environment> element — preserved as proto3 optional on the wire.

geoSrc

val geoSrc: Int

position source as a GeoPointSource enum int (see the GEOSRC_* constants in CotXmlParser).

how

val how: Int

coordinate-generation method as a CotHow enum int (see CotTypeMapper).

latitudeI

val latitudeI: Int

latitude in degrees × 1e7 (sfixed32 wire convention).

longitudeI

val longitudeI: Int

longitude in degrees × 1e7 (sfixed32 wire convention).