Position Config

Generated

from message meshtastic.Config.PositionConfig

Hierarchy

Constructors

  • Parameters

    Returns Config_PositionConfig

Properties

broadcastSmartMinimumDistance: number

The minimum distance in meters traveled (since the last send) before we can send a position to the mesh if position_broadcast_smart_enabled

Generated

from field: uint32 broadcast_smart_minimum_distance = 10;

broadcastSmartMinimumIntervalSecs: number

The minimum number of seconds (since the last send) before we can send a position to the mesh if position_broadcast_smart_enabled

Generated

from field: uint32 broadcast_smart_minimum_interval_secs = 11;

fixedPosition: boolean

If set, this node is at a fixed position. We will generate GPS position updates at the regular interval, but use whatever the last lat/lon/alt we have for the node. The lat/lon/alt can be set by an internal GPS or with the help of the app.

Generated

from field: bool fixed_position = 3;

gpsAttemptTime: number

Deprecated in favor of using smart / regular broadcast intervals as implicit attempt time

Generated

from field: uint32 gps_attempt_time = 6 [deprecated = true];

Deprecated

gpsEnGpio: number

(Re)define PIN_GPS_EN for your board.

Generated

from field: uint32 gps_en_gpio = 12;

gpsEnabled: boolean

Is GPS enabled for this node?

Generated

from field: bool gps_enabled = 4 [deprecated = true];

Deprecated

Set where GPS is enabled, disabled, or not present

Generated

from field: meshtastic.Config.PositionConfig.GpsMode gps_mode = 13;

gpsUpdateInterval: number

How often should we try to get GPS position (in seconds) or zero for the default of once every 30 seconds or a very large value (maxint) to update only once at boot.

Generated

from field: uint32 gps_update_interval = 5;

positionBroadcastSecs: number

We should send our position this often (but only if it has changed significantly) Defaults to 15 minutes

Generated

from field: uint32 position_broadcast_secs = 1;

positionBroadcastSmartEnabled: boolean

Adaptive position braoadcast, which is now the default.

Generated

from field: bool position_broadcast_smart_enabled = 2;

positionFlags: number

Bit field of boolean configuration options for POSITION messages (bitwise OR of PositionFlags)

Generated

from field: uint32 position_flags = 7;

rxGpio: number

(Re)define GPS_RX_PIN for your board.

Generated

from field: uint32 rx_gpio = 8;

txGpio: number

(Re)define GPS_TX_PIN for your board.

Generated

from field: uint32 tx_gpio = 9;

fields: FieldList
runtime: ProtoRuntime
typeName: "meshtastic.Config.PositionConfig" = "meshtastic.Config.PositionConfig"

Methods

  • Create a deep copy.

    Returns Config_PositionConfig

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

  • 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

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

    Returns Config_PositionConfig

  • Parameters

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

    Returns Config_PositionConfig

  • Parameters

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

    Returns Config_PositionConfig

Generated using TypeDoc