TAKPacket-SDK — TypeScript - v0.7.0
    Preparing search index...

    Interface TAKPacketV2

    TAKPacketV2 — the top-level protobuf message for ATAK v2 packets.

    All fields are optional per proto3 semantics. The payload_variant oneof is represented as optional fields — exactly one should be set at a time.

    This interface is structurally compatible with protobuf.Type.create() and protobuf.Type.toObject() so it can be used interchangeably with the runtime reflection API.

    interface TAKPacketV2 {
        aircraft?: AircraftTrack;
        altitude?: number;
        altSrc?: number;
        battery?: number;
        callsign?: string;
        casevac?: CasevacReport;
        chat?: GeoChat;
        cotTypeId?: number;
        cotTypeStr?: string;
        course?: number;
        deviceCallsign?: string;
        emergency?: EmergencyAlert;
        endpoint?: string;
        environment?: TAKEnvironment;
        geoSrc?: number;
        how?: number;
        latitudeI?: number;
        longitudeI?: number;
        marker?: Marker;
        marti?: Marti;
        phone?: string;
        rab?: RangeAndBearing;
        rawDetail?: Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>;
        remarks?: string;
        role?: number;
        route?: Route;
        sensorFov?: SensorFov;
        shape?: DrawnShape;
        speed?: number;
        staleSeconds?: number;
        takDevice?: string;
        takOs?: string;
        takPlatform?: string;
        taktalk?: TakTalkMessage;
        taktalkRoom?: TakTalkRoomData;
        takVersion?: string;
        task?: TaskRequest;
        team?: number;
        uid?: string;
    }
    Index

    Properties

    aircraft? altitude? altSrc? battery? callsign? casevac? chat? cotTypeId? cotTypeStr? course? deviceCallsign? emergency? endpoint? environment? geoSrc? how? latitudeI? longitudeI? marker? marti? phone? rab? rawDetail? remarks? role? route? sensorFov? shape? speed? staleSeconds? takDevice? takOs? takPlatform? taktalk? taktalkRoom? takVersion? task? team? uid?

    Properties

    aircraft?: AircraftTrack

    ADS-B / military air track.

    altitude?: number

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

    altSrc?: number

    Altitude source as a GeoPointSource enum value.

    battery?: number

    Battery charge, 0–100 percent.

    callsign?: string

    User / sender callsign.

    casevac?: CasevacReport

    9-line MEDEVAC / CASEVAC request.

    chat?: GeoChat

    GeoChat message or delivered/read receipt.

    cotTypeId?: number

    Well-known CoT type as a CotType enum value; 0 (CotType_Other) when unknown (see cotTypeStr).

    cotTypeStr?: string

    Original CoT type string, populated only when cotTypeId is 0 so unknown types round-trip.

    course?: number

    Course over ground in degrees×100 (centidegrees).

    deviceCallsign?: string

    Device callsign from <uid Droid="…"/>.

    emergency?: EmergencyAlert

    Emergency / 911 alert.

    endpoint?: string

    Contact endpoint; default TAK endpoints are normalized to empty to save wire bytes.

    environment?: TAKEnvironment

    Optional weather annotation; attaches to any event type (not a payload variant).

    geoSrc?: number

    Position source as a GeoPointSource enum value (GPS / USER / NETWORK).

    how?: number

    Coordinate-generation method as a CotHow enum value.

    latitudeI?: number

    Latitude in degrees×1e7 (signed; e.g. 388895000 = 38.8895°).

    longitudeI?: number

    Longitude in degrees×1e7 (signed; e.g. -770353000 = -77.0353°).

    marker?: Marker

    Fixed marker (spot, waypoint, 2525 symbol, etc.).

    marti?: Marti

    Directed-routing recipient list (CoT …). Absent / undefined = broadcast (default for situational-awareness); populated for TAKTALK m-t-t and directed b-t-f DMs. TAKTALK gates voice TTS playback on this list matching the receiver's callsign, so dropping it silently breaks voice messaging end-to-end.

    phone?: string

    Contact phone number.

    rab?: RangeAndBearing

    Range-and-bearing measurement.

    rawDetail?: Uint8Array<ArrayBufferLike> | Buffer<ArrayBufferLike>

    Raw <detail> bytes fallback for callers building packets directly.

    remarks?: string

    Optional free-text <remarks> for non-chat payload types; stripped first under MTU pressure.

    role?: number

    Role within the team as a MemberRole enum value.

    route?: Route

    Named route with ordered waypoints / control points.

    sensorFov?: SensorFov

    Optional sensor field-of-view annotation; attaches to any event type (not a payload variant).

    shape?: DrawnShape

    User-drawn tactical graphic (circle, rectangle, polygon, etc.).

    speed?: number

    Ground speed in cm/s (ATAK's m/s ×100). Negative ATAK sentinels are clamped to 0.

    staleSeconds?: number

    Seconds from event time to stale time (stale − time), varint-encoded.

    takDevice?: string

    TAK device model.

    takOs?: string

    TAK client OS string.

    takPlatform?: string

    TAK platform (e.g. ATAK-CIV, iTAK, WinTAK).

    taktalk?: TakTalkMessage

    TAKTALK voice/text chat message (m-t-t).

    taktalkRoom?: TakTalkRoomData

    TAKTALK room/membership broadcast (y-).

    takVersion?: string

    TAK client version string.

    task?: TaskRequest

    Tasking / engagement request.

    team?: number

    Team color as a Team enum value.

    uid?: string

    Event UID (the ATAK object identifier).

    Settings

    Member Visibility

    On This Page

    Properties