Class Data

(Formerly called SubPacket) The payload portion fo a packet, this is the actual bytes that are sent inside a radio packet (because from/to are broken out by the comms library)

Generated

from message meshtastic.Data

Hierarchy

Constructors

constructor

Properties

bitfield? dest emoji payload portnum replyId requestId source wantResponse fields runtime typeName

Methods

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

Constructors

constructor

  • new Data(data?): Data

  • Parameters

    • Optionaldata: PartialMessage<Data>

    Returns Data

Properties

Optionalbitfield

bitfield?: number

Bitfield for extra flags. First use is to indicate that user approves the packet being uploaded to MQTT.

Generated

from field: optional uint32 bitfield = 9;

dest

dest: number

The address of the destination node. This field is is filled in by the mesh radio device software, application layer software should never need it. RouteDiscovery messages must populate this. Other message types might need to if they are doing multihop routing.

Generated

from field: fixed32 dest = 4;

emoji

emoji: number

Defaults to false. If true, then what is in the payload should be treated as an emoji like giving a message a heart or poop emoji.

Generated

from field: fixed32 emoji = 8;

payload

payload: Uint8Array

TODO: REPLACE

Generated

from field: bytes payload = 2;

portnum

portnum: PortNum

Formerly named typ and of type Type

Generated

from field: meshtastic.PortNum portnum = 1;

replyId

replyId: number

If set, this message is intened to be a reply to a previously sent message with the defined id.

Generated

from field: fixed32 reply_id = 7;

requestId

requestId: number

Only used in routing or response messages. Indicates the original message ID that this message is reporting failure on. (formerly called original_id)

Generated

from field: fixed32 request_id = 6;

source

source: number

The address of the original sender for this message. This field should only be populated for reliable multihop packets (to keep packets small).

Generated

from field: fixed32 source = 5;

wantResponse

wantResponse: boolean

Not normally used, but for testing a sender can request that recipient responds in kind (i.e. if it received a position, it should unicast back it's position). Note: that if you set this on a broadcast you will receive many replies.

Generated

from field: bool want_response = 3;

Static Readonlyfields

fields: FieldList

Static Readonlyruntime

runtime: ProtoRuntime

Static ReadonlytypeName

typeName: "meshtastic.Data" = "meshtastic.Data"

Methods

clone

  • clone(): Data

  • Create a deep copy.

    Returns Data

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
          | Data
          | PlainMessage<Data>

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

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

    Returns MessageType<Data>

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

    • a: undefined | Data | PlainMessage<Data>
    • b: undefined | Data | PlainMessage<Data>

    Returns boolean

StaticfromBinary

  • fromBinary(bytes, options?): Data

  • Parameters

    • bytes: Uint8Array
    • Optionaloptions: Partial<BinaryReadOptions>

    Returns Data

StaticfromJson

  • fromJson(jsonValue, options?): Data

  • Parameters

    • jsonValue: JsonValue
    • Optionaloptions: Partial<JsonReadOptions>

    Returns Data

StaticfromJsonString

  • fromJsonString(jsonString, options?): Data

  • Parameters

    • jsonString: string
    • Optionaloptions: Partial<JsonReadOptions>

    Returns Data

Settings

Member Visibility

On This Page

Constructors
Properties
Methods