Class Telemetry

Types of Measurements the telemetry module is equipped to handle

Generated

from message meshtastic.Telemetry

Hierarchy

Constructors

constructor

Properties

time variant fields runtime typeName

Methods

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

Constructors

constructor

  • new Telemetry(data?): Telemetry

  • Parameters

    Returns Telemetry

Properties

time

time: number

Seconds since 1970 - or 0 for unknown/unset

Generated

from field: fixed32 time = 1;

variant

variant: {
    case: "deviceMetrics";
    value: DeviceMetrics;
} | {
    case: "environmentMetrics";
    value: EnvironmentMetrics;
} | {
    case: "airQualityMetrics";
    value: AirQualityMetrics;
} | {
    case: "powerMetrics";
    value: PowerMetrics;
} | {
    case: "localStats";
    value: LocalStats;
} | {
    case: undefined;
    value?: undefined;
}

Type declaration

  • case: "deviceMetrics"
  • value: DeviceMetrics

    Key native device metrics such as battery level

    Generated

    from field: meshtastic.DeviceMetrics device_metrics = 2;

Type declaration

  • case: "environmentMetrics"
  • value: EnvironmentMetrics

    Weather station or other environmental metrics

    Generated

    from field: meshtastic.EnvironmentMetrics environment_metrics = 3;

Type declaration

  • case: "airQualityMetrics"
  • value: AirQualityMetrics

    Air quality metrics

    Generated

    from field: meshtastic.AirQualityMetrics air_quality_metrics = 4;

Type declaration

  • case: "powerMetrics"
  • value: PowerMetrics

    Power Metrics

    Generated

    from field: meshtastic.PowerMetrics power_metrics = 5;

Type declaration

  • case: "localStats"
  • value: LocalStats

    Local device mesh statistics

    Generated

    from field: meshtastic.LocalStats local_stats = 6;

Type declaration

  • case: undefined
  • Optional value?: undefined

Generated

from oneof meshtastic.Telemetry.variant

Static Readonly fields

fields: FieldList

Static Readonly runtime

runtime: ProtoRuntime

Static Readonly typeName

typeName: "meshtastic.Telemetry" = "meshtastic.Telemetry"

Methods

clone

  • clone(): Telemetry

  • Create a deep copy.

    Returns Telemetry

equals

  • equals(other): boolean

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

    Parameters

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

    Returns this

fromJson

  • fromJson(jsonValue, options?): this

  • Parse a message from a JSON value.

    Parameters

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

    Returns this

fromJsonString

  • fromJsonString(jsonString, options?): this

  • Parse a message from a JSON string.

    Parameters

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

    Returns this

getType

  • getType(): MessageType<Telemetry>

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

    Returns MessageType<Telemetry>

toBinary

  • toBinary(options?): Uint8Array

  • Serialize the message to binary data.

    Parameters

    • Optional options: Partial<BinaryWriteOptions>

    Returns Uint8Array

Protected toJSON

  • 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

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

toJsonString

  • toJsonString(options?): string

  • Serialize the message to a JSON string.

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

Static equals

  • equals(a, b): boolean

  • Parameters

    Returns boolean

Static fromBinary

  • fromBinary(bytes, options?): Telemetry

  • Parameters

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

    Returns Telemetry

Static fromJson

  • fromJson(jsonValue, options?): Telemetry

  • Parameters

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

    Returns Telemetry

Static fromJsonString

  • fromJsonString(jsonString, options?): Telemetry

  • Parameters

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

    Returns Telemetry

Settings

Member Visibility

Theme

On This Page

constructortimevariantfieldsruntimetypeNamecloneequalsfromBinaryfromJsonfromJsonStringgetTypetoBinarytoJSONtoJsontoJsonStringequalsfromBinaryfromJsonfromJsonString

Generated using TypeDoc