This message will be proxied over the PhoneAPI for the client to deliver to the MQTT server

Generated

from message meshtastic.MqttClientProxyMessage

Hierarchy

Constructors

  • Parameters

    Returns MqttClientProxyMessage

Properties

payloadVariant: {
    case: "data";
    value: Uint8Array;
} | {
    case: "text";
    value: string;
} | {
    case: undefined;
    value?: undefined;
}

The actual service envelope payload or text for mqtt pub / sub

Type declaration

  • case: "data"
  • value: Uint8Array

    Bytes

    Generated

    from field: bytes data = 2;

Type declaration

  • case: "text"
  • value: string

    Text

    Generated

    from field: string text = 3;

Type declaration

  • case: undefined
  • Optional value?: undefined

Generated

from oneof meshtastic.MqttClientProxyMessage.payload_variant

retained: boolean

Whether the message should be retained (or not)

Generated

from field: bool retained = 4;

topic: string

The MQTT topic this message will be sent /received on

Generated

from field: string topic = 1;

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

Methods

  • Create a deep copy.

    Returns MqttClientProxyMessage

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

    Returns this

  • Parse a message from a JSON value.

    Parameters

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

    Returns this

  • Parse a message from a JSON string.

    Parameters

    • jsonString: string
    • Optional options: 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<MqttClientProxyMessage>

  • Serialize the message to binary data.

    Parameters

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

    • Optional options: Partial<JsonWriteOptions>

    Returns JsonValue

  • Serialize the message to a JSON string.

    Parameters

    • Optional options: Partial<JsonWriteStringOptions>

    Returns string

  • Parameters

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

    Returns MqttClientProxyMessage

  • Parameters

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

    Returns MqttClientProxyMessage

  • Parameters

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

    Returns MqttClientProxyMessage

Generated using TypeDoc