Skip to main content

1.2 MQTT Settings

note

This is still under development, use at your own risk. Report any bugs you see by creating an issue on the meshtastic/Meshtastic-device repository or comment on our forum.

caution

You may want to change your GPS location sharing settings if you are enabling this. It will broadcast your location over the internet.

Overview

If your device is connected to WiFi you can enable it to forward messages along to an MQTT server. This allows users on the local mesh to communicate with users on the internet.

Be sure to checkout this MQTT too.

Settings

SettingAcceptable ValuesDefault
downlink_enabledtrue, falsefalse
mqtt_disabledtrue, falsefalse
mqtt_encryption_enabledtrue, falsefalse
mqtt_passwordstring""
mqtt_serverstring""
mqtt_usernamestring""
uplink_enabledtrue, falsefalse

This is a channel specific setting. If your channel has this set to true and you are connected to WiFi, the device will forward along messages from the MQTT server specified here to the mesh from this device.

Enable downlink_enabled on PRIMARY channel
meshtastic --ch-set downlink_enabled true --ch-index 0
Disable downlink_enabled on PRIMARY channel
meshtastic --ch-set downlink_enabled false --ch-index 0
Enable downlink_enabled on OTHER channel
meshtastic --ch-set downlink_enabled true --ch-index 1
Disable downlink_enabled on OTHER channel
meshtastic --ch-set downlink_enabled false --ch-index 1

mqtt_disabled

If a meshtastic node is able to reach the internet it will normally attempt to gateway any channels that are marked as uplink_enabled or downlink_enabled. But if this flag is set, all MQTT features will be disabled and no servers will be contacted.

Enable/Disable MQTT

Enable MQTT (Default)
meshtastic --set mqtt_disabled false
Disable MQTT
meshtastic --set mqtt_disabled true

mqtt_encryption_enabled

Determines whether or not the device sends the packets encrypted to/from your MQTT server.

tip

If you are using the default Meshtastic MQTT server, this setting will take no effect. All packets will continue to be encrypted regardless of this setting. Only custom servers will honor this setting.

Enable/Disable MQTT Encryption

Publish decrypted packets to MQTT (Default)
meshtastic --set mqtt_encryption_enabled false
Publish encrypted packets to MQTT
meshtastic --set mqtt_encryption_enabled true

mqtt_password

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 large4cats.

Configure mqtt_password

Set mqtt_password
meshtastic --set mqtt_password mypassword
Set mqtt_password (with spaces)
meshtastic --set mqtt_password "my password"
Unset mqtt_password (Default)
meshtastic --set mqtt_password ""

mqtt_server

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

Enable/Disable MQTT Server

tip

When the mqtt_server is set to "", it will default to mqtt.meshtastic.org

Enable MQTT Server - Public Meshtastic MQTT Server (Default)
meshtastic --set mqtt_server ""
Enable MQTT Server - Personal MQTT Server (by IP)
meshtastic --set mqtt_server 198.168.0.2
Enable MQTT Server - Personal MQTT Server (by URL)
meshtastic --set mqtt_server mqtt.mydomain.com

mqtt_username

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 meshdev.

Configure mqtt_username

Set mqtt_username
meshtastic --set mqtt_username myusername
Set mqtt_username (with spaces)
meshtastic --set mqtt_username "my username"
Unset mqtt_username (Default)
meshtastic --set mqtt_username ""

This is a channel specific setting. If your channel has this set to true and you are connected to WiFi, the device will forward along messages to whatever MQTT server is specified in mqtt_server.

Enable uplink_enabled on PRIMARY channel
meshtastic --ch-set uplink_enabled true --ch-index 0
Disable uplink_enabled on PRIMARY channel
meshtastic --ch-set uplink_enabled false --ch-index 0
Enable uplink_enabled on OTHER channel
meshtastic --ch-set uplink_enabled true --ch-index 1
Disable uplink_enabled on OTHER channel
meshtastic --ch-set uplink_enabled false --ch-index 1

Details

Examples

Set server
meshtastic --set mqtt_server 192.168.123.234
Enable MQTT server to mesh
meshtastic --ch-set uplink_enabled true --ch-set downlink_enabled true --ch-index 0
View raw encoded messages using mosquitto
mosquitto_sub -h 192.168.123.234 -v -t msh/#
note

FIXME some documentation says msh/# , some says mesh/# . As of 1.2.39 the messages are on msh/#