Reformat with prettier, fixed note syntax

This commit is contained in:
nigel 2021-07-26 17:07:56 +01:00
parent 819b3bcfcb
commit 753b52def6

View file

@ -3,6 +3,7 @@ id: mqtt
title: MQTT Settings
sidebar_label: MQTT
---
import Tabs from '@theme/Tabs';
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
| Setting | Acceptable Values | Default |
| :-----: | :---------------: | :-----: |
| mqtt_disabled | `true`, `false` | `false` |
| mqtt_server | `string` | `""` |
| is_uplink_enabled | `true`, `false` | `false` |
| is_downlink_enabled | `true`, `false` | `false` |
| 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
@ -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.
## 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
```
groupId="settings"
defaultValue="cli"
values={[
{label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'},
]}>
<TabItem value="cli">
```bash title="Enable MQTT server to mesh"
meshtastic --set is_downlink_enabled True
```
```bash title="Set server"
meshtastic --set mqtt_server 192.168.123.234
```
```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">
```bash title="Enable MQTT server to mesh"
meshtastic --set is_downlink_enabled True
```
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>
</Tabs>