Class ToRadio

Packets/commands to the radio will be written (reliably) to the toRadio characteristic. Once the write completes the phone can assume it is handled.

Generated

from message meshtastic.ToRadio

Hierarchy

Constructors

constructor

Properties

payloadVariant fields runtime typeName

Methods

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

Constructors

constructor

  • new ToRadio(data?): ToRadio

  • Parameters

    • Optionaldata: PartialMessage<ToRadio>

    Returns ToRadio

Properties

payloadVariant

payloadVariant:
    | {
        case: "packet";
        value: MeshPacket;
    }
    | {
        case: "wantConfigId";
        value: number;
    }
    | {
        case: "disconnect";
        value: boolean;
    }
    | {
        case: "xmodemPacket";
        value: XModem;
    }
    | {
        case: "mqttClientProxyMessage";
        value: MqttClientProxyMessage;
    }
    | {
        case: "heartbeat";
        value: Heartbeat;
    }
    | {
        case: undefined;
        value?: undefined;
    }

Log levels, chosen to match python logging conventions.

Type declaration

  • case: "packet"
  • value: MeshPacket

    Send this packet on the mesh

    Generated

    from field: meshtastic.MeshPacket packet = 1;

Type declaration

  • case: "wantConfigId"
  • value: number

    Phone wants radio to send full node db to the phone, This is typically the first packet sent to the radio when the phone gets a bluetooth connection. The radio will respond by sending back a MyNodeInfo, a owner, a radio config and a series of FromRadio.node_infos, and config_complete the integer you write into this field will be reported back in the config_complete_id response this allows clients to never be confused by a stale old partially sent config.

    Generated

    from field: uint32 want_config_id = 3;

Type declaration

  • case: "disconnect"
  • value: boolean

    Tell API server we are disconnecting now. This is useful for serial links where there is no hardware/protocol based notification that the client has dropped the link. (Sending this message is optional for clients)

    Generated

    from field: bool disconnect = 4;

Type declaration

  • case: "xmodemPacket"
  • value: XModem

    Generated

    from field: meshtastic.XModem xmodemPacket = 5;

Type declaration

  • case: "mqttClientProxyMessage"
  • value: MqttClientProxyMessage

    MQTT Client Proxy Message (for client / phone subscribed to MQTT sending to device)

    Generated

    from field: meshtastic.MqttClientProxyMessage mqttClientProxyMessage = 6;

Type declaration

  • case: "heartbeat"
  • value: Heartbeat

    Heartbeat message (used to keep the device connection awake on serial)

    Generated

    from field: meshtastic.Heartbeat heartbeat = 7;

Generated

from oneof meshtastic.ToRadio.payload_variant

Static Readonlyfields

fields: FieldList

Static Readonlyruntime

runtime: ProtoRuntime

Static ReadonlytypeName

typeName: "meshtastic.ToRadio" = "meshtastic.ToRadio"

Methods

clone

  • clone(): ToRadio

  • Create a deep copy.

    Returns ToRadio

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

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

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

    Returns MessageType<ToRadio>

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

  • Parameters

    • bytes: Uint8Array
    • Optionaloptions: Partial<BinaryReadOptions>

    Returns ToRadio

StaticfromJson

  • fromJson(jsonValue, options?): ToRadio

  • Parameters

    • jsonValue: JsonValue
    • Optionaloptions: Partial<JsonReadOptions>

    Returns ToRadio

StaticfromJsonString

  • fromJsonString(jsonString, options?): ToRadio

  • Parameters

    • jsonString: string
    • Optionaloptions: Partial<JsonReadOptions>

    Returns ToRadio

Settings

Member Visibility

On This Page

Constructors
Properties
Methods