a gps position

Generated

from message meshtastic.Position

Hierarchy

Constructors

  • Parameters

    Returns Position

Properties

HDOP: number

TODO: REPLACE

Generated

from field: uint32 HDOP = 12;

PDOP: number

Horizontal, Vertical and Position Dilution of Precision, in 1/100 units

  • PDOP is sufficient for most cases
  • for higher precision scenarios, HDOP and VDOP can be used instead, in which case PDOP becomes redundant (PDOP=sqrt(HDOP^2 + VDOP^2)) TODO: REMOVE/INTEGRATE

Generated

from field: uint32 PDOP = 11;

VDOP: number

TODO: REPLACE

Generated

from field: uint32 VDOP = 13;

altitude: number

In meters above MSL (but see issue #359)

Generated

from field: int32 altitude = 3;

altitudeGeoidalSeparation: number

Geoidal separation in meters

Generated

from field: sint32 altitude_geoidal_separation = 10;

altitudeHae: number

HAE altitude in meters - can be used instead of MSL altitude

Generated

from field: sint32 altitude_hae = 9;

altitudeSource: Position_AltSource

TODO: REPLACE

Generated

from field: meshtastic.Position.AltSource altitude_source = 6;

fixQuality: number

GPS fix quality (from NMEA GxGGA statement or similar)

Generated

from field: uint32 fix_quality = 17;

fixType: number

GPS fix type 2D/3D (from NMEA GxGSA statement)

Generated

from field: uint32 fix_type = 18;

gpsAccuracy: number

GPS accuracy (a hardware specific constant) in mm multiplied with DOP to calculate positional accuracy Default: "'bout three meters-ish" :)

Generated

from field: uint32 gps_accuracy = 14;

groundSpeed: number

Ground speed in m/s and True North TRACK in 1/100 degrees Clarification of terms:

  • "track" is the direction of motion (measured in horizontal plane)
  • "heading" is where the fuselage points (measured in horizontal plane)
  • "yaw" indicates a relative rotation about the vertical axis TODO: REMOVE/INTEGRATE

Generated

from field: uint32 ground_speed = 15;

groundTrack: number

TODO: REPLACE

Generated

from field: uint32 ground_track = 16;

latitudeI: number

The new preferred location encoding, multiply by 1e-7 to get degrees in floating point

Generated

from field: sfixed32 latitude_i = 1;

locationSource: Position_LocSource

TODO: REPLACE

Generated

from field: meshtastic.Position.LocSource location_source = 5;

longitudeI: number

TODO: REPLACE

Generated

from field: sfixed32 longitude_i = 2;

nextUpdate: number

Estimated/expected time (in seconds) until next update:

  • if we update at fixed intervals of X seconds, use X
  • if we update at dynamic intervals (based on relative movement etc), but "AT LEAST every Y seconds", use Y

Generated

from field: uint32 next_update = 21;

satsInView: number

GPS "Satellites in View" number

Generated

from field: uint32 sats_in_view = 19;

sensorId: number

Sensor ID - in case multiple positioning sensors are being used

Generated

from field: uint32 sensor_id = 20;

seqNumber: number

A sequence number, incremented with each Position message to help detect lost updates if needed

Generated

from field: uint32 seq_number = 22;

time: number

This is usually not sent over the mesh (to save space), but it is sent from the phone so that the local device can set its time if it is sent over the mesh (because there are devices on the mesh without GPS or RTC). seconds since 1970

Generated

from field: fixed32 time = 4;

timestamp: number

Positional timestamp (actual timestamp of GPS solution) in integer epoch seconds

Generated

from field: fixed32 timestamp = 7;

timestampMillisAdjust: number

Pos. timestamp milliseconds adjustment (rarely available or required)

Generated

from field: int32 timestamp_millis_adjust = 8;

fields: FieldList
runtime: ProtoRuntime
typeName: "meshtastic.Position" = "meshtastic.Position"

Methods

  • Create a deep copy.

    Returns Position

  • Compare with a message of the same type.

    Parameters

    Returns boolean

  • Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting existing keys.

    If a message field is already present, it will be merged with the new data.

    Parameters

    • bytes: Uint8Array
    • Optional options: Partial<BinaryReadOptions>

    Returns this

  • Parse a message from a JSON value.

    Parameters

    • jsonValue: JsonValue
    • Optional options: Partial<JsonReadOptions>

    Returns this

  • Parse a message from a JSON string.

    Parameters

    • jsonString: string
    • Optional options: Partial<JsonReadOptions>

    Returns this

  • Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

    Returns MessageType<Position>

  • Serialize the message to binary data.

    Parameters

    • Optional options: Partial<BinaryWriteOptions>

    Returns Uint8Array

  • Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).

    Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.

    This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.

    Returns JsonValue

  • Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

  • Serialize the message to a JSON string.

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

  • Parameters

    Returns boolean

  • Parameters

    • bytes: Uint8Array
    • Optional options: Partial<BinaryReadOptions>

    Returns Position

  • Parameters

    • jsonValue: JsonValue
    • Optional options: Partial<JsonReadOptions>

    Returns Position

  • Parameters

    • jsonString: string
    • Optional options: Partial<JsonReadOptions>

    Returns Position

Generated using TypeDoc