Merge pull request #60 from nigelorr/master

Add CLI examples
This commit is contained in:
Sacha Weatherstone 2021-08-02 17:33:50 +10:00 committed by GitHub
commit 61e15dee4b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

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
@ -50,20 +51,33 @@ This is a channel specific setting. If your channel has this set to `true` and y
## 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">
TODO ```bash title="Set server"
meshtastic --set mqtt_server 192.168.123.234
```
</TabItem> ```bash title="Enable MQTT server to mesh"
<TabItem value="android"> 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> </TabItem>
</Tabs> </Tabs>