mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2025-02-02 08:42:11 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

added mqtt details

Browse source
This commit is contained in:
Foster Irwin 2021-05-04 10:22:20 -06:00
parent 1d96e658fc
commit fd419c11f7
1 changed files with 24 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
website/docs/settings/mqtt.md
View file

@ -3,27 +3,47 @@ id: mqtt
title: MQTT Settings
sidebar_label: MQTT
---
:::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` | `true` |
| 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.
The server to use for our MQTT global message gateway feature. If not set, the default server will be used
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 --->
### CLI Examples
<!--- TODO --->