Class FromRadio

Packets from the radio to the phone will appear on the fromRadio characteristic. It will support READ and NOTIFY. When a new packet arrives the device will BLE notify? It will sit in that descriptor until consumed by the phone, at which point the next item in the FIFO will be populated.

Generated

from message meshtastic.FromRadio

Hierarchy

Constructors

constructor

Properties

id payloadVariant fields runtime typeName

Methods

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

Constructors

constructor

  • new FromRadio(data?): FromRadio

  • Parameters

    Returns FromRadio

Properties

id

id: number

The packet id, used to allow the phone to request missing read packets from the FIFO, see our bluetooth docs

Generated

from field: uint32 id = 1;

payloadVariant

payloadVariant:
    | {
        case: "packet";
        value: MeshPacket;
    }
    | {
        case: "myInfo";
        value: MyNodeInfo;
    }
    | {
        case: "nodeInfo";
        value: NodeInfo;
    }
    | {
        case: "config";
        value: Config;
    }
    | {
        case: "logRecord";
        value: LogRecord;
    }
    | {
        case: "configCompleteId";
        value: number;
    }
    | {
        case: "rebooted";
        value: boolean;
    }
    | {
        case: "moduleConfig";
        value: ModuleConfig;
    }
    | {
        case: "channel";
        value: Channel;
    }
    | {
        case: "queueStatus";
        value: QueueStatus;
    }
    | {
        case: "xmodemPacket";
        value: XModem;
    }
    | {
        case: "metadata";
        value: DeviceMetadata;
    }
    | {
        case: "mqttClientProxyMessage";
        value: MqttClientProxyMessage;
    }
    | {
        case: "fileInfo";
        value: FileInfo;
    }
    | {
        case: "clientNotification";
        value: ClientNotification;
    }
    | {
        case: undefined;
        value?: undefined;
    }

Log levels, chosen to match python logging conventions.

Type declaration

  • case: "packet"
  • value: MeshPacket

    Log levels, chosen to match python logging conventions.

    Generated

    from field: meshtastic.MeshPacket packet = 2;

Type declaration

  • case: "myInfo"
  • value: MyNodeInfo

    Tells the phone what our node number is, can be -1 if we've not yet joined a mesh. NOTE: This ID must not change - to keep (minimal) compatibility with <1.2 version of android apps.

    Generated

    from field: meshtastic.MyNodeInfo my_info = 3;

Type declaration

  • case: "nodeInfo"
  • value: NodeInfo

    One packet is sent for each node in the on radio DB starts over with the first node in our DB

    Generated

    from field: meshtastic.NodeInfo node_info = 4;

Type declaration

  • case: "config"
  • value: Config

    Include a part of the config (was: RadioConfig radio)

    Generated

    from field: meshtastic.Config config = 5;

Type declaration

  • case: "logRecord"
  • value: LogRecord

    Set to send debug console output over our protobuf stream

    Generated

    from field: meshtastic.LogRecord log_record = 6;

Type declaration

  • case: "configCompleteId"
  • value: number

    Sent as true once the device has finished sending all of the responses to want_config recipient should check if this ID matches our original request nonce, if not, it means your config responses haven't started yet. NOTE: This ID must not change - to keep (minimal) compatibility with <1.2 version of android apps.

    Generated

    from field: uint32 config_complete_id = 7;

Type declaration

  • case: "rebooted"
  • value: boolean

    Sent to tell clients the radio has just rebooted. Set to true if present. Not used on all transports, currently just used for the serial console. NOTE: This ID must not change - to keep (minimal) compatibility with <1.2 version of android apps.

    Generated

    from field: bool rebooted = 8;

Type declaration

  • case: "moduleConfig"
  • value: ModuleConfig

    Include module config

    Generated

    from field: meshtastic.ModuleConfig moduleConfig = 9;

Type declaration

  • case: "channel"
  • value: Channel

    One packet is sent for each channel

    Generated

    from field: meshtastic.Channel channel = 10;

Type declaration

  • case: "queueStatus"
  • value: QueueStatus

    Queue status info

    Generated

    from field: meshtastic.QueueStatus queueStatus = 11;

Type declaration

  • case: "xmodemPacket"
  • value: XModem

    File Transfer Chunk

    Generated

    from field: meshtastic.XModem xmodemPacket = 12;

Type declaration

  • case: "metadata"
  • value: DeviceMetadata

    Device metadata message

    Generated

    from field: meshtastic.DeviceMetadata metadata = 13;

Type declaration

  • case: "mqttClientProxyMessage"
  • value: MqttClientProxyMessage

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

    Generated

    from field: meshtastic.MqttClientProxyMessage mqttClientProxyMessage = 14;

Type declaration

  • case: "fileInfo"
  • value: FileInfo

    File system manifest messages

    Generated

    from field: meshtastic.FileInfo fileInfo = 15;

Type declaration

  • case: "clientNotification"
  • value: ClientNotification

    Notification message to the client

    Generated

    from field: meshtastic.ClientNotification clientNotification = 16;

Generated

from oneof meshtastic.FromRadio.payload_variant

Static Readonlyfields

fields: FieldList

Static Readonlyruntime

runtime: ProtoRuntime

Static ReadonlytypeName

typeName: "meshtastic.FromRadio" = "meshtastic.FromRadio"

Methods

clone

  • clone(): FromRadio

  • Create a deep copy.

    Returns FromRadio

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

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

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

    Returns MessageType<FromRadio>

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

  • Parameters

    • bytes: Uint8Array
    • Optionaloptions: Partial<BinaryReadOptions>

    Returns FromRadio

StaticfromJson

  • fromJson(jsonValue, options?): FromRadio

  • Parameters

    • jsonValue: JsonValue
    • Optionaloptions: Partial<JsonReadOptions>

    Returns FromRadio

StaticfromJsonString

  • fromJsonString(jsonString, options?): FromRadio

  • Parameters

    • jsonString: string
    • Optionaloptions: Partial<JsonReadOptions>

    Returns FromRadio

Settings

Member Visibility

On This Page

Constructors
Properties
Methods