Class Heartbeat

A heartbeat message is sent to the node from the client to keep the connection alive. This is currently only needed to keep serial connections alive, but can be used by any PhoneAPI.

Generated

from message meshtastic.Heartbeat

Hierarchy

Constructors

constructor

Properties

fields runtime typeName

Methods

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

Constructors

constructor

  • new Heartbeat(data?): Heartbeat

  • Parameters

    Returns Heartbeat

Properties

Static Readonlyfields

fields: FieldList

Static Readonlyruntime

runtime: ProtoRuntime

Static ReadonlytypeName

typeName: "meshtastic.Heartbeat" = "meshtastic.Heartbeat"

Methods

clone

  • clone(): Heartbeat

  • Create a deep copy.

    Returns Heartbeat

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

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

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

    Returns MessageType<Heartbeat>

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?): Heartbeat

  • Parameters

    • bytes: Uint8Array
    • Optionaloptions: Partial<BinaryReadOptions>

    Returns Heartbeat

StaticfromJson

  • fromJson(jsonValue, options?): Heartbeat

  • Parameters

    • jsonValue: JsonValue
    • Optionaloptions: Partial<JsonReadOptions>

    Returns Heartbeat

StaticfromJsonString

  • fromJsonString(jsonString, options?): Heartbeat

  • Parameters

    • jsonString: string
    • Optionaloptions: Partial<JsonReadOptions>

    Returns Heartbeat

Settings

Member Visibility

On This Page

Constructors
Properties
Methods