From d814d80f51ffc08b26fab941a097ef9fcb32a86b Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Fri, 7 Jul 2023 22:02:56 -0700 Subject: [PATCH 1/9] proto-what? --- docs/configuration/module-config/mqtt.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/module-config/mqtt.mdx b/docs/configuration/module-config/mqtt.mdx index f56e89f2..e01bc5e6 100644 --- a/docs/configuration/module-config/mqtt.mdx +++ b/docs/configuration/module-config/mqtt.mdx @@ -8,7 +8,7 @@ sidebar_label: MQTT import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -If your device is connected to Internet via wifi or ethernet, you can enable it to forward packets along to an MQTT server. This allows users on the local mesh to communicate with users on the internet. One or more channels must be enabled as uplink and/or downlink for protobufs to be transmitted from and/or to the mesh (See [channels](/docs/settings/config/channels#downlink-enabled)). Without these settings the node will still connect to MQTT server and send status messages. +If your device is connected to Internet via wifi or ethernet, you can enable it to forward packets along to an MQTT server. This allows users on the local mesh to communicate with users on the internet. One or more channels must also be enabled as uplink and/or downlink for packets to be transmitted from and/or to your mesh (See [channels](/docs/settings/config/channels#downlink-enabled)). Without these settings enabled, the node will still connect to the MQTT server but only send status messages. The MQTT module config options are: Enabled, Server Address, Username, Password, Encryption Enabled and JSON Enabled. MQTT Module config uses an admin message sending a `ConfigModule.MQTT` protobuf. From 0b451297180f5926e01c78d3996f2b0dd4590d63 Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Fri, 7 Jul 2023 22:19:08 -0700 Subject: [PATCH 2/9] add tls and root --- docs/configuration/module-config/mqtt.mdx | 28 +++++++++++++++-------- 1 file changed, 19 insertions(+), 9 deletions(-) diff --git a/docs/configuration/module-config/mqtt.mdx b/docs/configuration/module-config/mqtt.mdx index e01bc5e6..ed9bfbb5 100644 --- a/docs/configuration/module-config/mqtt.mdx +++ b/docs/configuration/module-config/mqtt.mdx @@ -10,7 +10,7 @@ import TabItem from "@theme/TabItem"; If your device is connected to Internet via wifi or ethernet, you can enable it to forward packets along to an MQTT server. This allows users on the local mesh to communicate with users on the internet. One or more channels must also be enabled as uplink and/or downlink for packets to be transmitted from and/or to your mesh (See [channels](/docs/settings/config/channels#downlink-enabled)). Without these settings enabled, the node will still connect to the MQTT server but only send status messages. -The MQTT module config options are: Enabled, Server Address, Username, Password, Encryption Enabled and JSON Enabled. MQTT Module config uses an admin message sending a `ConfigModule.MQTT` protobuf. +The MQTT module config options are: Enabled, Server Address, Username, Password, Encryption Enabled, JSON Enabled, TLS Enabled, and Root Topic. MQTT Module config uses an admin message sending a `ConfigModule.MQTT` protobuf. ## Settings @@ -40,6 +40,14 @@ Whether to send encrypted or decrypted packets to MQTT. This parameter is only h Enable the sending / consumption of JSON packets on MQTT. These packets are not encrypted, but offer an easy way to integrate with systems that can read JSON. +### TLS Enabled + +If true, we attempt to establish a secure connection using TLS + +### Root Topic + +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. Default is "msh". + ## MQTT Module Config Client Availability Date: Fri, 7 Jul 2023 22:29:05 -0700 Subject: [PATCH 3/9] typos, tweaks, add Apple availability --- docs/configuration/module-config/mqtt.mdx | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/configuration/module-config/mqtt.mdx b/docs/configuration/module-config/mqtt.mdx index ed9bfbb5..56b62a91 100644 --- a/docs/configuration/module-config/mqtt.mdx +++ b/docs/configuration/module-config/mqtt.mdx @@ -22,7 +22,7 @@ Enables the MQTT module. ### Server Address -The server to use for MQTT. If not set, the default server public will be used. +The server to use for MQTT. If not set, the default public server will be used. ### Username @@ -30,11 +30,11 @@ MQTT Server username to use (most useful for a custom MQTT server). If using a c ### Password -MQTT password to use (most useful for a custom MQTT server). If using a custom server, this will be honored even if empty. If using the default server, this will only be honored if set, otherwise the device will use the default password +MQTT password to use (most useful for a custom MQTT server). If using a custom server, this will be honored even if empty. If using the default server, this will only be honored if set, otherwise the device will use the default password. ### Encryption Enabled -Whether to send encrypted or decrypted packets to MQTT. This parameter is only honored if you also set server (the default official mqtt.meshtastic.org server can handle encrypted packets) Decrypted packets may be useful for external systems that want to consume meshtastic packets. +Whether to send encrypted or unencrypted packets to MQTT. This parameter is only honored if you also set server (the default official mqtt.meshtastic.org server can handle encrypted packets). Unencrypted packets may be useful for external systems that want to consume meshtastic packets. ### JSON Enabled @@ -42,7 +42,7 @@ Enable the sending / consumption of JSON packets on MQTT. These packets are not ### TLS Enabled -If true, we attempt to establish a secure connection using TLS +If true, we attempt to establish a secure connection using TLS. ### Root Topic @@ -74,7 +74,9 @@ MQTT Config options are available for Android. :::info -MQTT module config is not available for Apple. + +MQTT Config options are available on iOS, iPadOS and macOS at Settings > Modules > MQTT. + ::: From 4f201df2f503e1ed95b60c31ab3da32fadb81cdd Mon Sep 17 00:00:00 2001 From: pdxlocations Date: Fri, 7 Jul 2023 22:31:26 -0700 Subject: [PATCH 4/9] remove default root topic --- docs/configuration/module-config/mqtt.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/configuration/module-config/mqtt.mdx b/docs/configuration/module-config/mqtt.mdx index 56b62a91..b4f70b72 100644 --- a/docs/configuration/module-config/mqtt.mdx +++ b/docs/configuration/module-config/mqtt.mdx @@ -46,7 +46,7 @@ If true, we attempt to establish a secure connection using TLS. ### Root Topic -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. Default is "msh". +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 @@ -97,7 +97,7 @@ All MQTT module config options are available in the python CLI. Example commands | mqtt.encryption_enabled | `true`, `false` | `false` | | mqtt.json_enabled | `true`, `false` | `false` | | mqtt.tls_enabled | `true`, `false` | `false` | -| mqtt.root | `string` | `msh` | +| mqtt.root | `string` | | :::tip From 8a16e6e37275c67995e59b2f3c5274648079493d Mon Sep 17 00:00:00 2001 From: Mark Trevor Birss Date: Sat, 8 Jul 2023 18:24:49 +0200 Subject: [PATCH 5/9] Update trademark-grants.mdx --- docs/legal/trademark-grants.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/legal/trademark-grants.mdx b/docs/legal/trademark-grants.mdx index f69bdfc5..e583d106 100644 --- a/docs/legal/trademark-grants.mdx +++ b/docs/legal/trademark-grants.mdx @@ -16,3 +16,5 @@ sidebar_label: Trademark Grants - Details: K9 Rocket Technologies is an open technology development company selling and implementing Meshtastic-powered devices. The devices and their respective promotional content carry the "Powered by Meshtastic", "Meshtastic", & "M" logos. The use of the Meshtastic Logo and Trademarks does not imply K9 Rocket Technologies is sponsored or endorsed by Meshtastic. K9 Rocket Technologies also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason - Grant: Ben Lipsey - Details: Ben Lipsey is a Meshtastic Contributor and Promotional Materials Distributor. Promotional materials carry the "Meshtastic" and "M" logos. Materials also carry the Meshtastic.org URL. The use of the Meshtastic Logo and Trademarks does not imply Ben Lipsey is sponsored or endorsed by Meshtastic. Ben Lipsey also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. +- Grant: Mark Birss + - Details: Mark Birss is a Meshtastic contributor/developer of DIY devices that carry the "Meshtastic" , Meshtastic.org URL and "M" logos. The use of the Meshtastic Logo and Trademarks does not imply Mark Birss is sponsored or endorsed by Meshtastic. Mark Birss also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. From a393296e2d73ae4aac0beabdb60a5e23bda85e91 Mon Sep 17 00:00:00 2001 From: Garth Vander Houwen Date: Sun, 9 Jul 2023 16:44:03 -0700 Subject: [PATCH 6/9] Update trademark-grants.mdx Add grant section for 3DSafe on Etsy --- docs/legal/trademark-grants.mdx | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/legal/trademark-grants.mdx b/docs/legal/trademark-grants.mdx index e583d106..1fefc64b 100644 --- a/docs/legal/trademark-grants.mdx +++ b/docs/legal/trademark-grants.mdx @@ -18,3 +18,6 @@ sidebar_label: Trademark Grants - Details: Ben Lipsey is a Meshtastic Contributor and Promotional Materials Distributor. Promotional materials carry the "Meshtastic" and "M" logos. Materials also carry the Meshtastic.org URL. The use of the Meshtastic Logo and Trademarks does not imply Ben Lipsey is sponsored or endorsed by Meshtastic. Ben Lipsey also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. - Grant: Mark Birss - Details: Mark Birss is a Meshtastic contributor/developer of DIY devices that carry the "Meshtastic" , Meshtastic.org URL and "M" logos. The use of the Meshtastic Logo and Trademarks does not imply Mark Birss is sponsored or endorsed by Meshtastic. Mark Birss also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. +www.etsy.com/shop/3Dsafe +- Grant [Paul Carney](https://www.etsy.com/shop/3Dsafe) + -Details: Paul primarily designs enclosures and assembles complete Meshtastic Radios for sale using modules from TTGO, Heltec and RAK. He runs an online shop for Meshtastic powered devices which carry the "Meshtastic" and M logos. The use of the Meshtastic Logo and Trademarks does not imply Paul is sponsored or endorsed by Meshtastic. Paul also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. From a99632556d0a57e1fac055c1d24958a7757c6f34 Mon Sep 17 00:00:00 2001 From: Garth Vander Houwen Date: Sun, 9 Jul 2023 16:55:56 -0700 Subject: [PATCH 7/9] Update trademark-grants.mdx --- docs/legal/trademark-grants.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/legal/trademark-grants.mdx b/docs/legal/trademark-grants.mdx index 1fefc64b..4affc825 100644 --- a/docs/legal/trademark-grants.mdx +++ b/docs/legal/trademark-grants.mdx @@ -20,4 +20,4 @@ sidebar_label: Trademark Grants - Details: Mark Birss is a Meshtastic contributor/developer of DIY devices that carry the "Meshtastic" , Meshtastic.org URL and "M" logos. The use of the Meshtastic Logo and Trademarks does not imply Mark Birss is sponsored or endorsed by Meshtastic. Mark Birss also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. www.etsy.com/shop/3Dsafe - Grant [Paul Carney](https://www.etsy.com/shop/3Dsafe) - -Details: Paul primarily designs enclosures and assembles complete Meshtastic Radios for sale using modules from TTGO, Heltec and RAK. He runs an online shop for Meshtastic powered devices which carry the "Meshtastic" and M logos. The use of the Meshtastic Logo and Trademarks does not imply Paul is sponsored or endorsed by Meshtastic. Paul also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. + - Details: Paul primarily designs enclosures and assembles complete Meshtastic Radios for sale using modules from TTGO, Heltec and RAK. He runs an online shop for Meshtastic powered devices which carry the "Meshtastic" and M logos. The use of the Meshtastic Logo and Trademarks does not imply Paul is sponsored or endorsed by Meshtastic. Paul also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. From a990e0d7cc6f4b1e1c0a1b09230203a2402cc0ec Mon Sep 17 00:00:00 2001 From: Garth Vander Houwen Date: Sun, 9 Jul 2023 16:58:19 -0700 Subject: [PATCH 8/9] Update trademark-grants.mdx Sorry seem to have completely forgotten how to update the docs properly --- docs/legal/trademark-grants.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/legal/trademark-grants.mdx b/docs/legal/trademark-grants.mdx index 4affc825..56ca20ab 100644 --- a/docs/legal/trademark-grants.mdx +++ b/docs/legal/trademark-grants.mdx @@ -18,6 +18,5 @@ sidebar_label: Trademark Grants - Details: Ben Lipsey is a Meshtastic Contributor and Promotional Materials Distributor. Promotional materials carry the "Meshtastic" and "M" logos. Materials also carry the Meshtastic.org URL. The use of the Meshtastic Logo and Trademarks does not imply Ben Lipsey is sponsored or endorsed by Meshtastic. Ben Lipsey also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. - Grant: Mark Birss - Details: Mark Birss is a Meshtastic contributor/developer of DIY devices that carry the "Meshtastic" , Meshtastic.org URL and "M" logos. The use of the Meshtastic Logo and Trademarks does not imply Mark Birss is sponsored or endorsed by Meshtastic. Mark Birss also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. -www.etsy.com/shop/3Dsafe - Grant [Paul Carney](https://www.etsy.com/shop/3Dsafe) - Details: Paul primarily designs enclosures and assembles complete Meshtastic Radios for sale using modules from TTGO, Heltec and RAK. He runs an online shop for Meshtastic powered devices which carry the "Meshtastic" and M logos. The use of the Meshtastic Logo and Trademarks does not imply Paul is sponsored or endorsed by Meshtastic. Paul also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. From 2d3ea729e100208d66684d87f73d2e402037f04d Mon Sep 17 00:00:00 2001 From: Garth Vander Houwen Date: Sun, 9 Jul 2023 19:34:49 -0700 Subject: [PATCH 9/9] Update trademark-grants.mdx --- docs/legal/trademark-grants.mdx | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/legal/trademark-grants.mdx b/docs/legal/trademark-grants.mdx index 56ca20ab..15d9014b 100644 --- a/docs/legal/trademark-grants.mdx +++ b/docs/legal/trademark-grants.mdx @@ -20,3 +20,5 @@ sidebar_label: Trademark Grants - Details: Mark Birss is a Meshtastic contributor/developer of DIY devices that carry the "Meshtastic" , Meshtastic.org URL and "M" logos. The use of the Meshtastic Logo and Trademarks does not imply Mark Birss is sponsored or endorsed by Meshtastic. Mark Birss also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. - Grant [Paul Carney](https://www.etsy.com/shop/3Dsafe) - Details: Paul primarily designs enclosures and assembles complete Meshtastic Radios for sale using modules from TTGO, Heltec and RAK. He runs an online shop for Meshtastic powered devices which carry the "Meshtastic" and M logos. The use of the Meshtastic Logo and Trademarks does not imply Paul is sponsored or endorsed by Meshtastic. Paul also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason. +- Grant: [Keith Monaghan](http://voltaicenclosures.com/) + - Details: Keith is a contributer of computer aided design (CAD)/3D designs primarily for device enclosures and accessories, and runs an online shop for Meshtastic powered devices which carry the "Meshtastic" and "M" logos. The use of the Meshtastic Logo and Trademarks does not imply Keith is sponsored or endorsed by Meshtastic. Keith also agrees to maintain compliance with the Meshtastic Legal requirements. This grant is revokable at any time for any reason.