Interface ModuleConfig_MQTTConfig

MQTT Client Config

Generated

from protobuf message ModuleConfig.MQTTConfig

Hierarchy

  • ModuleConfig_MQTTConfig

Properties

address: string

The server to use for our MQTT global message gateway feature. If not set, the default server will be used

Generated

from protobuf field: string address = 2;

disabled: boolean

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. But if this flag is set, all MQTT features will be disabled and no servers will be contacted.

Generated

from protobuf field: bool disabled = 1;

encryptionEnabled: boolean

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

Generated

from protobuf field: bool encryption_enabled = 5;

password: string

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

Generated

from protobuf field: string password = 4;

username: string

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

Generated

from protobuf field: string username = 3;

Generated using TypeDoc