Optional data: PartialMessage<ModuleConfig_MQTTConfig>The server to use for our MQTT global message gateway feature. If not set, the default server will be used
from field: string address = 2;
If a meshtastic node is able to reach the internet it will normally attempt to gateway any channels that are marked as is_uplink_enabled or is_downlink_enabled.
from field: bool enabled = 1;
Whether to send encrypted or decrypted packets to MQTT. This parameter is only honoured if you also set server (the default official mqtt.meshtastic.org server can handle encrypted packets) Decrypted packets may be useful for external systems that want to consume meshtastic packets
from field: bool encryption_enabled = 5;
Whether to send / consume json packets on MQTT
from field: bool json_enabled = 6;
Optional mapSettings for reporting information about our node to a map via MQTT
from field: meshtastic.ModuleConfig.MapReportSettings map_report_settings = 11;
If true, we will periodically report unencrypted information about our node to a map via MQTT
from field: bool map_reporting_enabled = 10;
MQTT password to use (most useful for a custom MQTT server). If using a custom server, this will be honoured even if empty. If using the default server, this will only be honoured if set, otherwise the device will use the default password
from field: string password = 4;
If true, we can use the connected phone / client to proxy messages to MQTT instead of a direct connection
from field: bool proxy_to_client_enabled = 9;
The root topic to use for MQTT messages. Default is "msh". This is useful if you want to use a single MQTT server for multiple meshtastic networks and separate them via ACLs
from field: string root = 8;
If true, we attempt to establish a secure connection using TLS
from field: bool tls_enabled = 7;
MQTT username to use (most useful for a custom MQTT server). If using a custom server, this will be honoured even if empty. If using the default server, this will only be honoured if set, otherwise the device will use the default username
from field: string username = 3;
Static Readonly fieldsStatic Readonly runtimeStatic Readonly typeCreate a deep copy.
Compare with a message of the same type. Note that this function disregards extensions and unknown fields.
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.
Optional options: Partial<BinaryReadOptions>Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.
Protected toJSONOverride 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.
Static equalsStatic fromOptional options: Partial<BinaryReadOptions>Static fromOptional options: Partial<JsonReadOptions>Static fromOptional options: Partial<JsonReadOptions>Generated using TypeDoc
MQTT Client Config
Generated
from message meshtastic.ModuleConfig.MQTTConfig