mirror of
https://github.com/meshtastic/meshtastic.git
synced 2024-11-14 09:34:25 -08:00
84 lines
2.5 KiB
Markdown
84 lines
2.5 KiB
Markdown
---
|
|
id: mqtt
|
|
title: MQTT Settings
|
|
sidebar_label: MQTT
|
|
---
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
:::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](https://github.com/meshtastic/Meshtastic-device) repository or comment on our forum.
|
|
:::
|
|
|
|
:::caution
|
|
You may want to change your [GPS location sharing settings](gps#location_share) 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.
|
|
|
|
## Settings
|
|
|
|
| Setting | Acceptable Values | Default |
|
|
| :-----------------: | :---------------: | :-----: |
|
|
| mqtt_disabled | `true`, `false` | `false` |
|
|
| mqtt_server | `string` | `""` |
|
|
| is_uplink_enabled | `true`, `false` | `false` |
|
|
| is_downlink_enabled | `true`, `false` | `false` |
|
|
|
|
### mqtt_disabled
|
|
|
|
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.
|
|
|
|
### mqtt_server
|
|
|
|
The server to use for our MQTT global message gateway feature. If not set, the default server will be used
|
|
|
|
### is_uplink_enabled
|
|
|
|
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`.
|
|
|
|
### is_downlink_enabled
|
|
|
|
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 to the mesh from this device.
|
|
|
|
## Details
|
|
|
|
<!--- TODO --->
|
|
|
|
## Examples
|
|
|
|
<Tabs
|
|
groupId="settings"
|
|
defaultValue="cli"
|
|
values={[
|
|
{label: 'CLI', value: 'cli'},
|
|
{label: 'Android', value: 'android'},
|
|
]}>
|
|
<TabItem value="cli">
|
|
|
|
```bash title="Set server"
|
|
meshtastic --set mqtt_server 192.168.123.234
|
|
```
|
|
|
|
```bash title="Enable MQTT server to mesh"
|
|
meshtastic --ch-set uplink_enabled true --ch-set downlink_enabled true
|
|
```
|
|
|
|
```bash title="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/#
|
|
:::
|
|
</TabItem>
|
|
<TabItem value="android">
|
|
|
|
TODO
|
|
|
|
</TabItem>
|
|
</Tabs>
|