Local device mesh statistics

from message meshtastic.LocalStats

Hierarchy

Constructors

  • Parameters

    Returns LocalStats

Properties

airUtilTx: number

Percent of airtime for transmission used within the last hour.

from field: float air_util_tx = 3;

channelUtilization: number

Utilization for the current channel, including well formed TX, RX and malformed RX (aka noise).

from field: float channel_utilization = 2;

numOnlineNodes: number

Number of nodes online (in the past 2 hours)

from field: uint32 num_online_nodes = 7;

numPacketsRx: number

Number of packets received good

from field: uint32 num_packets_rx = 5;

numPacketsRxBad: number

Number of packets received that are malformed or violate the protocol

from field: uint32 num_packets_rx_bad = 6;

numPacketsTx: number

Number of packets sent

from field: uint32 num_packets_tx = 4;

numTotalNodes: number

Number of nodes total

from field: uint32 num_total_nodes = 8;

uptimeSeconds: number

How long the device has been running since the last reboot (in seconds)

from field: uint32 uptime_seconds = 1;

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

Methods

  • Create a deep copy.

    Returns LocalStats

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

    Returns this

  • Parse a message from a JSON value.

    Parameters

    • jsonValue: JsonValue
    • Optionaloptions: Partial<JsonReadOptions>

    Returns this

  • Parse a message from a JSON string.

    Parameters

    • jsonString: string
    • Optionaloptions: 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<LocalStats>

  • Serialize the message to binary data.

    Parameters

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

    • Optionaloptions: Partial<JsonWriteOptions>

    Returns JsonValue

  • Serialize the message to a JSON string.

    Parameters

    • Optionaloptions: Partial<JsonWriteStringOptions>

    Returns string

  • Parameters

    Returns boolean

  • Parameters

    • bytes: Uint8Array
    • Optionaloptions: Partial<BinaryReadOptions>

    Returns LocalStats

  • Parameters

    • jsonValue: JsonValue
    • Optionaloptions: Partial<JsonReadOptions>

    Returns LocalStats

  • Parameters

    • jsonString: string
    • Optionaloptions: Partial<JsonReadOptions>

    Returns LocalStats