From 02d7d3bc26bf3f37f6e8433aa82080c31084a79c Mon Sep 17 00:00:00 2001 From: Garth Vander Houwen Date: Sun, 30 Oct 2022 18:36:04 -0700 Subject: [PATCH] Mqtt cleanup --- docs/software/device/Index.mdx | 2 +- .../{other/mqtt.mdx => mqtt/index.mdx} | 16 ++-- docs/software/other/1.3-enthusiast.mdx | 84 ------------------- docs/software/web/index.mdx | 1 - 4 files changed, 11 insertions(+), 92 deletions(-) rename docs/software/{other/mqtt.mdx => mqtt/index.mdx} (89%) delete mode 100644 docs/software/other/1.3-enthusiast.mdx diff --git a/docs/software/device/Index.mdx b/docs/software/device/Index.mdx index 6fb58720..90b277ec 100644 --- a/docs/software/device/Index.mdx +++ b/docs/software/device/Index.mdx @@ -2,7 +2,7 @@ id: device-firmware title: Device firmware sidebar_label: Device firmware -sidebar_position: 5 +sidebar_position: 3 --- The device firmware runs on the nodes to build the mesh for communication. Each different make and model of device requires a different build of the Meshtastic firmware in order to run properly. Thankfully, due to the design of Meshtastic, it is possible to port the firmware to new devices as they become available. The firmware currently runs on a range of ESP32 based devices, but there is also increasing support for the nRF52 microprocessor with some more recent devices coming to market. diff --git a/docs/software/other/mqtt.mdx b/docs/software/mqtt/index.mdx similarity index 89% rename from docs/software/other/mqtt.mdx rename to docs/software/mqtt/index.mdx index c2b88eb3..4f240b4d 100644 --- a/docs/software/other/mqtt.mdx +++ b/docs/software/mqtt/index.mdx @@ -2,16 +2,20 @@ id: mqtt title: MQTT sidebar_label: MQTT +sidebar_position: 4 --- -Meshtastic devices with wifi hardware (ESP32) are able to connect to an MQTT broker to uplink and downlink mesh packets. This is useful for a number of purposes: +## Bridging Networks over TCP -- Connecting your mesh to the official Meshtastic MQTT broker. This makes your devices appear on the world map, and provides a limited copy of your mesh traffic, translated into JSON. -- Using a custom MQTT broker to bridge several mesh networks together, via the internet (or just a local IP network) -- Using a custom MQTT broker and a translator program to decode the raw protobuf packets and translate them into a plain text form for use in other systems. eg plotting temperature readings in Grafana, or device positions in Traccar. -- Using or emitting packets directly in/from smart home control software such as Home Assistant or other consumers that can work with JSON messages. +Connecting your mesh to the official Meshtastic MQTT broker. This makes your devices appear on the world map, and provides a limited copy of your mesh traffic, translated into JSON. -When MQTT enabled, the Meshtastic device simply uplinks and/or downlinks every raw protobuf packet that it sees to the MQTT broker. In addition, some packet types are serialized or deserialized from/to JSON messages for easier use in consumers. All packets are sent to the broker, whether they originate from another device on the mesh, or the gateway node itself. +Using a custom MQTT broker to bridge several mesh networks together, via the internet (or just a local IP network) + +## Software Integrations + +Using or emitting packets directly in/from smart home control software such as Home Assistant or other consumers that can work with JSON messages. + +When MQTT is enabled, the Meshtastic device simply uplinks and/or downlinks every raw protobuf packet that it sees to the MQTT broker. In addition, some packet types are serialized or deserialized from/to JSON messages for easier use in consumers. All packets are sent to the broker, whether they originate from another device on the mesh, or the gateway node itself. Packets may be encrypted. If you use the default meshtastic MQTT server, packets are always encrypted. If you use a custom MQTT broker (ie set `mqtt_server`), the `mqtt_encryption_enabled` setting applies, which by default is false. diff --git a/docs/software/other/1.3-enthusiast.mdx b/docs/software/other/1.3-enthusiast.mdx deleted file mode 100644 index 96ae669c..00000000 --- a/docs/software/other/1.3-enthusiast.mdx +++ /dev/null @@ -1,84 +0,0 @@ ---- -id: 1.3-enthusiast -title: 1.3 Enthusiast -sidebar_label: 1.3 Enthusiast ---- - -Meshtastic 1.3 has not been released as a beta. - -This page will function as a cheat-sheet to keep our notes on how to work with Meshtastic 1.3. - -## Known Limitations - -* Meshtastic 1.3 will not work with older versions of Meshtastic. All clients and device nodes on your Meshtastic Network will need to run 1.3. -* OTA updates don't work. We don't have an ETA of when this will be implemented. To update device firmware, you will need to use a cable. - -## Meshtastic 1.3 - Device - -There are often breaking changes in the firmware right now so please test the latest version. -The latest firmware can be found here: - -https://github.com/meshtastic/Meshtastic-device/releases - -Where to file bugs: - -https://github.com/meshtastic/Meshtastic-device/issues - -## Meshtastic 1.3 - Python - -Most CLI commands are now working, documentation has been updated but the --help has not - -https://meshtastic.org/docs/settings/config/ - -Where to file bugs: - -https://github.com/meshtastic/Meshtastic-python/issues - -## Meshtastic 1.3 - Android - -F-Droid: https://mesh.tastic.app/fdroid/repo -or join the Play Store testing program: https://play.google.com/apps/testing/com.geeksville.mesh - -Android App 1.3 apk available here - -https://github.com/meshtastic/Meshtastic-Android/releases - -Where to file bugs: - -https://github.com/meshtastic/Meshtastic-Android/issues - -## Meshtastic 1.3 - MacOS - -The Meshtastic MacOS build is available in TestFlight. - -https://testflight.apple.com/join/c8nNl8q1 - -Where to file bugs: - -TestFlight - -## Meshtastic 1.3 - iOS - -https://testflight.apple.com/join/c8nNl8q1 - -Where to file bugs: - -TestFlight - -## Meshtastic 1.3 - Web - -Hosted version available at client.meshtastic.org, we are still working to get the new webui running locally on the device firmware. - -You can connect your device to WiFI using the apple apps or the python CLI - -Where to file bugs: - -https://github.com/meshtastic/meshtastic-web/issues - -## Meshtastic 1.3 - Flasher - -Currently flashing and setting region are available - -https://github.com/meshtastic/Meshtastic-gui-installer/issues - -Have fun! \ No newline at end of file diff --git a/docs/software/web/index.mdx b/docs/software/web/index.mdx index be7f6f0b..7b09575f 100644 --- a/docs/software/web/index.mdx +++ b/docs/software/web/index.mdx @@ -2,7 +2,6 @@ id: web-app-software title: Web interface overview sidebar_label: Web Interface -sidebar_position: 3 ---