Class MapReport

Information about a node intended to be reported unencrypted to a map using MQTT.

Generated

from message meshtastic.MapReport

Hierarchy

Constructors

constructor

Properties

altitude firmwareVersion hasDefaultChannel hwModel latitudeI longName longitudeI modemPreset numOnlineLocalNodes positionPrecision region role shortName fields runtime typeName

Methods

clone equals fromBinary fromJson fromJsonString getType toBinary toJSON toJson toJsonString equals fromBinary fromJson fromJsonString

Constructors

constructor

  • new MapReport(data?): MapReport

  • Parameters

    Returns MapReport

Properties

altitude

altitude: number

Altitude in meters above MSL

Generated

from field: int32 altitude = 11;

firmwareVersion

firmwareVersion: string

Device firmware version string

Generated

from field: string firmware_version = 5;

hasDefaultChannel

hasDefaultChannel: boolean

Whether the node has a channel with default PSK and name (LongFast, MediumSlow, etc...) and it uses the default frequency slot given the region and modem preset.

Generated

from field: bool has_default_channel = 8;

hwModel

hwModel: HardwareModel

Hardware model of the node, i.e. T-Beam, Heltec V3, etc...

Generated

from field: meshtastic.HardwareModel hw_model = 4;

latitudeI

latitudeI: number

Latitude: multiply by 1e-7 to get degrees in floating point

Generated

from field: sfixed32 latitude_i = 9;

longName

longName: string

A full name for this user, i.e. "Kevin Hester"

Generated

from field: string long_name = 1;

longitudeI

longitudeI: number

Longitude: multiply by 1e-7 to get degrees in floating point

Generated

from field: sfixed32 longitude_i = 10;

modemPreset

modemPreset: Config_LoRaConfig_ModemPreset

Modem preset used by the radio (LongFast, MediumSlow, etc...)

Generated

from field: meshtastic.Config.LoRaConfig.ModemPreset modem_preset = 7;

numOnlineLocalNodes

numOnlineLocalNodes: number

Number of online nodes (heard in the last 2 hours) this node has in its list that were received locally (not via MQTT)

Generated

from field: uint32 num_online_local_nodes = 13;

positionPrecision

positionPrecision: number

Indicates the bits of precision for latitude and longitude set by the sending node

Generated

from field: uint32 position_precision = 12;

region

region: Config_LoRaConfig_RegionCode

The region code for the radio (US, CN, EU433, etc...)

Generated

from field: meshtastic.Config.LoRaConfig.RegionCode region = 6;

role

role: Config_DeviceConfig_Role

Role of the node that applies specific settings for a particular use-case

Generated

from field: meshtastic.Config.DeviceConfig.Role role = 3;

shortName

shortName: string

A VERY short name, ideally two characters. Suitable for a tiny OLED screen

Generated

from field: string short_name = 2;

Static Readonlyfields

fields: FieldList

Static Readonlyruntime

runtime: ProtoRuntime

Static ReadonlytypeName

typeName: "meshtastic.MapReport" = "meshtastic.MapReport"

Methods

clone

  • clone(): MapReport

  • Create a deep copy.

    Returns MapReport

equals

  • equals(other): boolean

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

    Parameters

    • other:
          | undefined
          | null
          | MapReport
          | PlainMessage<MapReport>

    Returns boolean

fromBinary

  • fromBinary(bytes, options?): this

  • 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
    • Optionaloptions: Partial<BinaryReadOptions>

    Returns this

fromJson

  • fromJson(jsonValue, options?): this

  • Parse a message from a JSON value.

    Parameters

    • jsonValue: JsonValue
    • Optionaloptions: Partial<JsonReadOptions>

    Returns this

fromJsonString

  • fromJsonString(jsonString, options?): this

  • Parse a message from a JSON string.

    Parameters

    • jsonString: string
    • Optionaloptions: Partial<JsonReadOptions>

    Returns this

getType

  • getType(): MessageType<MapReport>

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

    Returns MessageType<MapReport>

toBinary

  • toBinary(options?): Uint8Array

  • Serialize the message to binary data.

    Parameters

    • Optionaloptions: Partial<BinaryWriteOptions>

    Returns Uint8Array

ProtectedtoJSON

  • toJSON(): JsonValue

  • 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

toJson

  • toJson(options?): JsonValue

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

    Parameters

    • Optionaloptions: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • toJsonString(options?): string

  • Serialize the message to a JSON string.

    Parameters

    • Optionaloptions: Partial<JsonWriteStringOptions>

    Returns string

Staticequals

  • equals(a, b): boolean

  • Parameters

    Returns boolean

StaticfromBinary

  • fromBinary(bytes, options?): MapReport

  • Parameters

    • bytes: Uint8Array
    • Optionaloptions: Partial<BinaryReadOptions>

    Returns MapReport

StaticfromJson

  • fromJson(jsonValue, options?): MapReport

  • Parameters

    • jsonValue: JsonValue
    • Optionaloptions: Partial<JsonReadOptions>

    Returns MapReport

StaticfromJsonString

  • fromJsonString(jsonString, options?): MapReport

  • Parameters

    • jsonString: string
    • Optionaloptions: Partial<JsonReadOptions>

    Returns MapReport

Settings

Member Visibility

On This Page

Constructors
Properties
Methods