diff --git a/docs/configuration/module-config/mqtt.mdx b/docs/configuration/module-config/mqtt.mdx index b4f70b72..03e4dd9d 100644 --- a/docs/configuration/module-config/mqtt.mdx +++ b/docs/configuration/module-config/mqtt.mdx @@ -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 + + + +## Connect to the Default Public Server + + + + + +

1. Enable the MQTT Module

+ +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. + +::: + +

2. Enable Channel Uplink & Downlink

+ +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) + +

3. Configure Network Settings

+ +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) + + + + +

1. Enable the MQTT Module

+ +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) + +

2. Enable Channel Uplink & Downlink

+ +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) + +

3. Configure Network Settings

+ +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) + + + + +

1. Enable the MQTT Module

+ +```shell +meshtastic --set mqtt.enabled true +``` + +

2. Enable Channel Uplink & Downlink

+ +```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 +``` + +

3. Configure Network Settings

+ +```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 +``` + + + + +

1. Enable the MQTT Module

+ +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. + +::: + + +

2. Enable Channel Uplink & Downlink

+ +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) + +

3. Configure Network Settings

+ +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) + + + \ No newline at end of file diff --git a/docs/configuration/remote-admin.mdx b/docs/configuration/remote-admin.mdx index 415f1854..f498d6e0 100644 --- a/docs/configuration/remote-admin.mdx +++ b/docs/configuration/remote-admin.mdx @@ -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) \ No newline at end of file diff --git a/docs/development/firmware/port-numbers.mdx b/docs/development/firmware/port-numbers.mdx index 6afcb940..c0bfea43 100644 --- a/docs/development/firmware/port-numbers.mdx +++ b/docs/development/firmware/port-numbers.mdx @@ -6,7 +6,7 @@ sidebar_label: Port Numbers Any new app that runs on the device or via sister apps on phones/PCs should pick and use a unique "portnum" for their applications use. -The current list of port numbers can be found listed in the [protobufs](https://buf.build/meshtastic/protobufs/docs/main:meshtastic#meshtastic.CriticalErrorCode) +The current list of port numbers can be found listed in the [protobufs](https://buf.build/meshtastic/protobufs/docs/main:meshtastic#meshtastic.PortNum) ## Assignment diff --git a/static/img/modules/mqtt/android_channel.png b/static/img/modules/mqtt/android_channel.png new file mode 100644 index 00000000..fbf7fec5 Binary files /dev/null and b/static/img/modules/mqtt/android_channel.png differ diff --git a/static/img/modules/mqtt/android_channel_sm.png b/static/img/modules/mqtt/android_channel_sm.png new file mode 100644 index 00000000..a55b11c1 Binary files /dev/null and b/static/img/modules/mqtt/android_channel_sm.png differ diff --git a/static/img/modules/mqtt/android_mqtt.png b/static/img/modules/mqtt/android_mqtt.png new file mode 100644 index 00000000..d10f615c Binary files /dev/null and b/static/img/modules/mqtt/android_mqtt.png differ diff --git a/static/img/modules/mqtt/android_mqtt_proxy.png b/static/img/modules/mqtt/android_mqtt_proxy.png new file mode 100644 index 00000000..ba1738ae Binary files /dev/null and b/static/img/modules/mqtt/android_mqtt_proxy.png differ diff --git a/static/img/modules/mqtt/android_mqtt_proxy_sm.png b/static/img/modules/mqtt/android_mqtt_proxy_sm.png new file mode 100644 index 00000000..f79edeba Binary files /dev/null and b/static/img/modules/mqtt/android_mqtt_proxy_sm.png differ diff --git a/static/img/modules/mqtt/android_mqtt_sm.png b/static/img/modules/mqtt/android_mqtt_sm.png new file mode 100644 index 00000000..794e4adc Binary files /dev/null and b/static/img/modules/mqtt/android_mqtt_sm.png differ diff --git a/static/img/modules/mqtt/android_network.png b/static/img/modules/mqtt/android_network.png new file mode 100644 index 00000000..1f43c1cf Binary files /dev/null and b/static/img/modules/mqtt/android_network.png differ diff --git a/static/img/modules/mqtt/android_network_sm.png b/static/img/modules/mqtt/android_network_sm.png new file mode 100644 index 00000000..dbd1e8ae Binary files /dev/null and b/static/img/modules/mqtt/android_network_sm.png differ diff --git a/static/img/modules/mqtt/apple_channel.png b/static/img/modules/mqtt/apple_channel.png new file mode 100644 index 00000000..c1dc6296 Binary files /dev/null and b/static/img/modules/mqtt/apple_channel.png differ diff --git a/static/img/modules/mqtt/apple_channel_sm.png b/static/img/modules/mqtt/apple_channel_sm.png new file mode 100644 index 00000000..266f44e5 Binary files /dev/null and b/static/img/modules/mqtt/apple_channel_sm.png differ diff --git a/static/img/modules/mqtt/apple_mqtt_1.png b/static/img/modules/mqtt/apple_mqtt_1.png new file mode 100644 index 00000000..2bc3e29d Binary files /dev/null and b/static/img/modules/mqtt/apple_mqtt_1.png differ diff --git a/static/img/modules/mqtt/apple_mqtt_1_proxy.png b/static/img/modules/mqtt/apple_mqtt_1_proxy.png new file mode 100644 index 00000000..2daa7059 Binary files /dev/null and b/static/img/modules/mqtt/apple_mqtt_1_proxy.png differ diff --git a/static/img/modules/mqtt/apple_mqtt_1_proxy_sm.png b/static/img/modules/mqtt/apple_mqtt_1_proxy_sm.png new file mode 100644 index 00000000..2fb5d3d9 Binary files /dev/null and b/static/img/modules/mqtt/apple_mqtt_1_proxy_sm.png differ diff --git a/static/img/modules/mqtt/apple_mqtt_1_sm.png b/static/img/modules/mqtt/apple_mqtt_1_sm.png new file mode 100644 index 00000000..8440f2d4 Binary files /dev/null and b/static/img/modules/mqtt/apple_mqtt_1_sm.png differ diff --git a/static/img/modules/mqtt/apple_mqtt_2.png b/static/img/modules/mqtt/apple_mqtt_2.png new file mode 100644 index 00000000..b18eab29 Binary files /dev/null and b/static/img/modules/mqtt/apple_mqtt_2.png differ diff --git a/static/img/modules/mqtt/apple_mqtt_2_sm.png b/static/img/modules/mqtt/apple_mqtt_2_sm.png new file mode 100644 index 00000000..5232106e Binary files /dev/null and b/static/img/modules/mqtt/apple_mqtt_2_sm.png differ diff --git a/static/img/modules/mqtt/apple_network.png b/static/img/modules/mqtt/apple_network.png new file mode 100644 index 00000000..f04001f2 Binary files /dev/null and b/static/img/modules/mqtt/apple_network.png differ diff --git a/static/img/modules/mqtt/apple_network_sm.png b/static/img/modules/mqtt/apple_network_sm.png new file mode 100644 index 00000000..76fb42dd Binary files /dev/null and b/static/img/modules/mqtt/apple_network_sm.png differ diff --git a/static/img/modules/mqtt/web_channel.png b/static/img/modules/mqtt/web_channel.png new file mode 100644 index 00000000..8d59b324 Binary files /dev/null and b/static/img/modules/mqtt/web_channel.png differ diff --git a/static/img/modules/mqtt/web_channel_sm.png b/static/img/modules/mqtt/web_channel_sm.png new file mode 100644 index 00000000..e8c7b33a Binary files /dev/null and b/static/img/modules/mqtt/web_channel_sm.png differ diff --git a/static/img/modules/mqtt/web_mqtt.png b/static/img/modules/mqtt/web_mqtt.png new file mode 100644 index 00000000..21219f66 Binary files /dev/null and b/static/img/modules/mqtt/web_mqtt.png differ diff --git a/static/img/modules/mqtt/web_mqtt_proxy.png b/static/img/modules/mqtt/web_mqtt_proxy.png new file mode 100644 index 00000000..73d003cc Binary files /dev/null and b/static/img/modules/mqtt/web_mqtt_proxy.png differ diff --git a/static/img/modules/mqtt/web_mqtt_proxy_sm.png b/static/img/modules/mqtt/web_mqtt_proxy_sm.png new file mode 100644 index 00000000..8d103e54 Binary files /dev/null and b/static/img/modules/mqtt/web_mqtt_proxy_sm.png differ diff --git a/static/img/modules/mqtt/web_mqtt_sm.png b/static/img/modules/mqtt/web_mqtt_sm.png new file mode 100644 index 00000000..aee52cc7 Binary files /dev/null and b/static/img/modules/mqtt/web_mqtt_sm.png differ diff --git a/static/img/modules/mqtt/web_network.png b/static/img/modules/mqtt/web_network.png new file mode 100644 index 00000000..255e267e Binary files /dev/null and b/static/img/modules/mqtt/web_network.png differ diff --git a/static/img/modules/mqtt/web_network_sm.png b/static/img/modules/mqtt/web_network_sm.png new file mode 100644 index 00000000..ebba45f5 Binary files /dev/null and b/static/img/modules/mqtt/web_network_sm.png differ