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.

from message meshtastic.FromRadio

Hierarchy

Constructors

  • Parameters

    Returns FromRadio

Properties

id: number

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

from field: uint32 id = 1;

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.

    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.

    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

    from field: meshtastic.NodeInfo node_info = 4;

Type declaration

  • case: "config"
  • value: Config

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

    from field: meshtastic.Config config = 5;

Type declaration

  • case: "logRecord"
  • value: LogRecord

    Set to send debug console output over our protobuf stream

    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.

    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.

    from field: bool rebooted = 8;

Type declaration

  • case: "moduleConfig"
  • value: ModuleConfig

    Include module config

    from field: meshtastic.ModuleConfig moduleConfig = 9;

Type declaration

  • case: "channel"
  • value: Channel

    One packet is sent for each channel

    from field: meshtastic.Channel channel = 10;

Type declaration

  • case: "queueStatus"
  • value: QueueStatus

    Queue status info

    from field: meshtastic.QueueStatus queueStatus = 11;

Type declaration

  • case: "xmodemPacket"
  • value: XModem

    File Transfer Chunk

    from field: meshtastic.XModem xmodemPacket = 12;

Type declaration

  • case: "metadata"
  • value: DeviceMetadata

    Device metadata message

    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)

    from field: meshtastic.MqttClientProxyMessage mqttClientProxyMessage = 14;

Type declaration

  • case: "fileInfo"
  • value: FileInfo

    File system manifest messages

    from field: meshtastic.FileInfo fileInfo = 15;

Type declaration

  • case: "clientNotification"
  • value: ClientNotification

    Notification message to the client

    from field: meshtastic.ClientNotification clientNotification = 16;

from oneof meshtastic.FromRadio.payload_variant

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

Methods

  • Create a deep copy.

    Returns FromRadio

  • 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

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

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

  • Parameters

    • jsonValue: JsonValue
    • Optionaloptions: Partial<JsonReadOptions>

    Returns FromRadio

  • Parameters

    • jsonString: string
    • Optionaloptions: Partial<JsonReadOptions>

    Returns FromRadio