Merge branch 'master' into portnum
|
@ -14,6 +14,7 @@ The MQTT module config options are: Enabled, Server Address, Username, Password,
|
|||
|
||||
## Settings
|
||||
|
||||
|
||||
## MQTT Module Config Values
|
||||
|
||||
### Enabled
|
||||
|
@ -48,8 +49,8 @@ If true, we attempt to establish a secure connection using TLS.
|
|||
|
||||
The root topic to use for MQTT messages. This is useful if you want to use a single MQTT server for multiple meshtastic networks and separate them via ACLs.
|
||||
|
||||
## MQTT Module Config Client Availability
|
||||
|
||||
## MQTT Module Config Client Availability
|
||||
<Tabs
|
||||
groupId="settings"
|
||||
defaultValue="apple"
|
||||
|
@ -128,3 +129,141 @@ All MQTT module config options are available for the Web UI.
|
|||
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
|
||||
|
||||
## Connect to the Default Public Server
|
||||
|
||||
<Tabs
|
||||
defaultValue="apple"
|
||||
values={[
|
||||
{label: 'Android', value: 'android'},
|
||||
{label: 'Apple', value: 'apple'},
|
||||
{label: 'CLI', value: 'cli'},
|
||||
{label: 'Web', value: 'web'},
|
||||
]}>
|
||||
|
||||
<TabItem value="android">
|
||||
|
||||
<h3>1. Enable the MQTT Module</h3>
|
||||
|
||||
Navigate to: Vertical Ellipsis (3 dots top right) > Radio configuration > MQTT: Turn on the slider for **MQTT enabled** and tap **Send**.
|
||||
|
||||
[![MQTT Settings](/img/modules/mqtt/android_mqtt_sm.png)](/img/modules/mqtt/android_mqtt.png)
|
||||
|
||||
*Optional:* To use your phone's internet connection to send and receive packets over the web, also enable the slider for **MQTT Client Proxy** and skip the Configure Network Settings step below.
|
||||
|
||||
[![Client Proxy](/img/modules/mqtt/android_mqtt_proxy_sm.png)](/img/modules/mqtt/android_mqtt_proxy.png)
|
||||
|
||||
:::caution
|
||||
|
||||
Though this option may be visible in your UI, Client Proxy is not yet functional with the Android App.
|
||||
|
||||
:::
|
||||
|
||||
<h3>2. Enable Channel Uplink & Downlink</h3>
|
||||
|
||||
Navigate to: Vertical Ellipsis (3 dots top right) > Radio configuration > Channels > LongFast: Turn on the sliders for **Uplink enabled** and **Downlink enabled**, then tap **Save** and tap **Send**.
|
||||
|
||||
[![Channel Settings](/img/modules/mqtt/android_channel_sm.png)](/img/modules/mqtt/android_channel.png)
|
||||
|
||||
<h3>3. Configure Network Settings</h3>
|
||||
|
||||
Navigate to: Vertical Ellipsis (3 dots top right) > Radio configuration > Network: Turn on the slider for **WiFi enabled**, Enter the **SSID** and **PSK** for your network, then tap **Send**.
|
||||
|
||||
[![Network Settings](/img/modules/mqtt/android_network_sm.png)](/img/modules/mqtt/android_network.png)
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="apple">
|
||||
|
||||
<h3>1. Enable the MQTT Module</h3>
|
||||
|
||||
Navigate to Settings > MQTT: Turn on the slider for MQTT enabled and tap **Save**
|
||||
|
||||
[![MQTT Settings 1](/img/modules/mqtt/apple_mqtt_1_sm.png)](/img/modules/mqtt/apple_mqtt_1.png)
|
||||
[![MQTT Settings 2](/img/modules/mqtt/apple_mqtt_2_sm.png)](/img/modules/mqtt/apple_mqtt_2.png)
|
||||
|
||||
*Optional:* To use your phone's internet connection to send and receive packets over the web, also enable the slider for **MQTT Client Proxy** and skip the Configure Network Settings step below.
|
||||
|
||||
[![Client Proxy](/img/modules/mqtt/apple_mqtt_1_proxy_sm.png)](/img/modules/mqtt/apple_mqtt_1_proxy.png)
|
||||
|
||||
<h3>2. Enable Channel Uplink & Downlink</h3>
|
||||
|
||||
Navigate to Settings > Channels > Primary Channel: Turn on the sliders for **Uplink enabled** and **Downlink enabled** - Tap **Save**
|
||||
|
||||
[![Channel Settings](/img/modules/mqtt/apple_channel_sm.png)](/img/modules/mqtt/apple_channel.png)
|
||||
|
||||
<h3>3. Configure Network Settings</h3>
|
||||
|
||||
Navigate to Settings > Network: Turn on the slider for **WiFi enabled** - Enter your **SSID** and **PSK** for your network - Tap **Save**
|
||||
|
||||
[![Network Settings](/img/modules/mqtt/apple_network_sm.png)](/img/modules/mqtt/apple_network.png)
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="cli">
|
||||
|
||||
<h3>1. Enable the MQTT Module</h3>
|
||||
|
||||
```shell
|
||||
meshtastic --set mqtt.enabled true
|
||||
```
|
||||
|
||||
<h3>2. Enable Channel Uplink & Downlink</h3>
|
||||
|
||||
```shell
|
||||
meshtastic --ch-set uplink_enabled true --ch-index 0
|
||||
meshtastic --ch-set downlink_enabled true --ch-index 0
|
||||
```
|
||||
|
||||
or chained together:
|
||||
```shell
|
||||
meshtastic --ch-set uplink_enabled true --ch-index 0 --ch-set downlink_enabled true --ch-index 0
|
||||
```
|
||||
|
||||
<h3>3. Configure Network Settings</h3>
|
||||
|
||||
```shell
|
||||
meshtastic --set network.wifi_enabled true
|
||||
meshtastic --set network.wifi_ssid "your network"
|
||||
meshtastic --set network.wifi_psk yourpassword
|
||||
```
|
||||
|
||||
or chained together:
|
||||
```shell
|
||||
meshtastic --set network.wifi_enabled true --set network.wifi_ssid "your network" --set network.wifi_psk yourpassword
|
||||
```
|
||||
|
||||
</TabItem>
|
||||
<TabItem value="web">
|
||||
|
||||
<h3>1. Enable the MQTT Module</h3>
|
||||
|
||||
Navigate to Config > Module Config > MQTT - Turn on the slider for MQTT enabled - Click the **Save** icon.
|
||||
|
||||
[![MQTT Settings](/img/modules/mqtt/web_mqtt_sm.png)](/img/modules/mqtt/web_mqtt.png)
|
||||
|
||||
*Optional:* To use your client's internet connection to send and receive packets over the web, also enable the slider for **Proxy to Client Enabled** and skip the Configure Network Settings step below.
|
||||
|
||||
[![Client Proxy](/img/modules/mqtt/web_mqtt_proxy_sm.png)](/img/modules/mqtt/web_mqtt_proxy.png)
|
||||
|
||||
:::caution
|
||||
|
||||
Though this option may be visible in your UI, Client Proxy is not yet functional with the Web Client.
|
||||
|
||||
:::
|
||||
|
||||
|
||||
<h3>2. Enable Channel Uplink & Downlink</h3>
|
||||
|
||||
Navigate to Channels > Primary: Turn on the sliders for **Uplink Enabled** and **Downlink Enabled** - Click the **Save** icon.
|
||||
|
||||
[![Channel Settings](/img/modules/mqtt/web_channel_sm.png)](/img/modules/mqtt/web_channel.png)
|
||||
|
||||
<h3>3. Configure Network Settings</h3>
|
||||
|
||||
Navigate to Config > Device Config > Network: Turn on the slider for **Enabled** - Enter your **SSID** and **PSK** for your network - Click the **Save** icon.
|
||||
|
||||
[![Network Settings](/img/modules/mqtt/web_network_sm.png)](/img/modules/mqtt/web_network.png)
|
||||
|
||||
</TabItem>
|
||||
</Tabs>
|
|
@ -199,8 +199,4 @@ You've finished setting up and adding two devices to the admin channel. Remember
|
|||
For further reading, I recommend starting out with the [Meshtastic Python CLI Guide](/docs/software/python/cli/) if you haven't already gone through this (hopefully you have since you are reading this). But for a full reference to the settings you can change, please see:
|
||||
|
||||
[Settings Overview](/docs/settings) and
|
||||
[Complete list of user settings in Protobufs](https://buf.build/meshtastic/protobufs/docs/main:meshtastic#meshtastic.User)
|
||||
|
||||
## Areas for future development
|
||||
|
||||
In the future we will add a "dead man's timer" to this feature so that the remote node will revert any changes if you fail to send a special "commit changes" command. This will protect against sending bad settings to nodes that you can't physically access. Instead, if the node does not receive a commit message within 10 minutes it will revert all changes and (hopefully) rejoin the mesh.
|
||||
[Complete list of user settings in Protobufs](https://buf.build/meshtastic/protobufs/docs/main:meshtastic#meshtastic.User)
|
BIN
static/img/modules/mqtt/android_channel.png
Normal file
After Width: | Height: | Size: 95 KiB |
BIN
static/img/modules/mqtt/android_channel_sm.png
Normal file
After Width: | Height: | Size: 59 KiB |
BIN
static/img/modules/mqtt/android_mqtt.png
Normal file
After Width: | Height: | Size: 126 KiB |
BIN
static/img/modules/mqtt/android_mqtt_proxy.png
Normal file
After Width: | Height: | Size: 127 KiB |
BIN
static/img/modules/mqtt/android_mqtt_proxy_sm.png
Normal file
After Width: | Height: | Size: 17 KiB |
BIN
static/img/modules/mqtt/android_mqtt_sm.png
Normal file
After Width: | Height: | Size: 104 KiB |
BIN
static/img/modules/mqtt/android_network.png
Normal file
After Width: | Height: | Size: 120 KiB |
BIN
static/img/modules/mqtt/android_network_sm.png
Normal file
After Width: | Height: | Size: 32 KiB |
BIN
static/img/modules/mqtt/apple_channel.png
Normal file
After Width: | Height: | Size: 68 KiB |
BIN
static/img/modules/mqtt/apple_channel_sm.png
Normal file
After Width: | Height: | Size: 53 KiB |
BIN
static/img/modules/mqtt/apple_mqtt_1.png
Normal file
After Width: | Height: | Size: 142 KiB |
BIN
static/img/modules/mqtt/apple_mqtt_1_proxy.png
Normal file
After Width: | Height: | Size: 144 KiB |
BIN
static/img/modules/mqtt/apple_mqtt_1_proxy_sm.png
Normal file
After Width: | Height: | Size: 15 KiB |
BIN
static/img/modules/mqtt/apple_mqtt_1_sm.png
Normal file
After Width: | Height: | Size: 68 KiB |
BIN
static/img/modules/mqtt/apple_mqtt_2.png
Normal file
After Width: | Height: | Size: 172 KiB |
BIN
static/img/modules/mqtt/apple_mqtt_2_sm.png
Normal file
After Width: | Height: | Size: 73 KiB |
BIN
static/img/modules/mqtt/apple_network.png
Normal file
After Width: | Height: | Size: 103 KiB |
BIN
static/img/modules/mqtt/apple_network_sm.png
Normal file
After Width: | Height: | Size: 45 KiB |
BIN
static/img/modules/mqtt/web_channel.png
Normal file
After Width: | Height: | Size: 406 KiB |
BIN
static/img/modules/mqtt/web_channel_sm.png
Normal file
After Width: | Height: | Size: 60 KiB |
BIN
static/img/modules/mqtt/web_mqtt.png
Normal file
After Width: | Height: | Size: 711 KiB |
BIN
static/img/modules/mqtt/web_mqtt_proxy.png
Normal file
After Width: | Height: | Size: 714 KiB |
BIN
static/img/modules/mqtt/web_mqtt_proxy_sm.png
Normal file
After Width: | Height: | Size: 69 KiB |
BIN
static/img/modules/mqtt/web_mqtt_sm.png
Normal file
After Width: | Height: | Size: 438 KiB |
BIN
static/img/modules/mqtt/web_network.png
Normal file
After Width: | Height: | Size: 559 KiB |
BIN
static/img/modules/mqtt/web_network_sm.png
Normal file
After Width: | Height: | Size: 96 KiB |