mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2025-01-27 05:39:00 -08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Reformat with prettier, fixed note syntax

Browse source
This commit is contained in:
nigel 2021-07-26 17:07:56 +01:00
parent 819b3bcfcb
commit 753b52def6
1 changed files with 32 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

59
website/docs/software/settings/mqtt.md
View file

@ -3,6 +3,7 @@ id: mqtt
title: MQTT Settings title: MQTT Settings
sidebar_label: MQTT sidebar_label: MQTT
--- ---
import Tabs from '@theme/Tabs'; import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; import TabItem from '@theme/TabItem';
@ -20,12 +21,12 @@ If your device is connected to WiFi you can enable it to forward messages along
## Settings ## Settings
| Setting | Acceptable Values | Default | | Setting | Acceptable Values | Default |
| :-----: | :---------------: | :-----: | | :-----------------: | :---------------: | :-----: |
| mqtt_disabled | `true`, `false` | `false` | | mqtt_disabled | `true`, `false` | `false` |
| mqtt_server | `string` | `""` | | mqtt_server | `string` | `""` |
| is_uplink_enabled | `true`, `false` | `false` | | is_uplink_enabled | `true`, `false` | `false` |
| is_downlink_enabled | `true`, `false` | `false` | | is_downlink_enabled | `true`, `false` | `false` |
### mqtt_disabled ### mqtt_disabled
@ -44,35 +45,39 @@ This is a channel specific setting. If your channel has this set to `true` and y
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. 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 ## Details
<!--- TODO ---> <!--- TODO --->
## Examples ## Examples
<Tabs <Tabs
groupId="settings" groupId="settings"
defaultValue="cli" defaultValue="cli"
values={[ values={[
{label: 'CLI', value: 'cli'}, {label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'}, {label: 'Android', value: 'android'},
]}> ]}>
<TabItem value="cli"> <TabItem value="cli">
```bash title="Set server"
meshtastic --set mqtt_server 192.168.123.234
```
```bash title="Enable MQTT server to mesh" ```bash title="Set server"
meshtastic --set is_downlink_enabled True meshtastic --set mqtt_server 192.168.123.234
``` ```
```bash title="View raw encoded messages using mosquitto" ```bash title="Enable MQTT server to mesh"
mosquitto_sub -h 192.168.123.234 -v -t msh/# meshtastic --set is_downlink_enabled True
``` ```
:::note FIXME some documentation says msh/# , some says mesh/# . As of 1.2.39 the messages are on msh/#
</TabItem>
<TabItem value="android">
TODO ```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> </TabItem>
</Tabs> </Tabs>