Waypoint message, used to share arbitrary locations across the mesh

Generated

from message meshtastic.Waypoint

Hierarchy

Constructors

  • Parameters

    Returns Waypoint

Properties

description: string

Description of the waypoint - max 100 chars

Generated

from field: string description = 7;

expire: number

Time the waypoint is to expire (epoch)

Generated

from field: uint32 expire = 4;

icon: number

Designator icon for the waypoint in the form of a unicode emoji

Generated

from field: fixed32 icon = 8;

id: number

Id of the waypoint

Generated

from field: uint32 id = 1;

latitudeI?: number

latitude_i

Generated

from field: optional sfixed32 latitude_i = 2;

lockedTo: number

If greater than zero, treat the value as a nodenum only allowing them to update the waypoint. If zero, the waypoint is open to be edited by any member of the mesh.

Generated

from field: uint32 locked_to = 5;

longitudeI?: number

longitude_i

Generated

from field: optional sfixed32 longitude_i = 3;

name: string

Name of the waypoint - max 30 chars

Generated

from field: string name = 6;

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

Methods

  • Create a deep copy.

    Returns Waypoint

  • Compare with a message of the same type. Note that this function disregards extensions and unknown fields.

    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<Waypoint>

  • 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 Waypoint

  • Parameters

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

    Returns Waypoint

  • Parameters

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

    Returns Waypoint

Generated using TypeDoc