From 49a4fd876cfc6084a3ef249202fdcc9af6cb6578 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Fri, 1 Apr 2022 14:00:48 -0600 Subject: [PATCH 1/9] LoRa questions --- docs/faq/mesh.mdx | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/faq/mesh.mdx b/docs/faq/mesh.mdx index 055b4b10..2d3a4565 100644 --- a/docs/faq/mesh.mdx +++ b/docs/faq/mesh.mdx @@ -5,3 +5,11 @@ sidebar_label: Mesh --- ## Overview + +### Does Meshtastic use LoRaWAN? + +Meshtastic uses LoRa peer to peer (p2p), which allows much more flexibility in how LoRa is utilized. Our messaging and position updates are far too "random" compared to LoRaWAN requirements. + +### Will Meshtastic work with (insert LoRa service) + +Meshtastic uses LoRa peer to peer (p2p), which has allowed us to customize how we use the protocol. Likely it will not work with the service you have in mind, but it may be possible to build a bridge between services using MQTT. That will require further development outside the scope of this project to implement. From c7f16036e2c23975bd29099050eb4dd695c38fd9 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Fri, 1 Apr 2022 14:06:46 -0600 Subject: [PATCH 2/9] wifi questions --- docs/faq/wifi.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/faq/wifi.mdx b/docs/faq/wifi.mdx index a22221eb..b9601b50 100644 --- a/docs/faq/wifi.mdx +++ b/docs/faq/wifi.mdx @@ -13,3 +13,7 @@ sidebar_label: WiFi ### When I turn on WiFi, Bluetooth turns off. Why is this? Currently WiFi and Bluetooth can not be enabled at the same time. + +### Why does my device lose connection to WiFi? + +It could be a couple of things. First, check that the node connects to WiFi on battery power. There are sometimes issues if your power supply is not compatible. Another possibility is [misconfigured DTIM](https://homenetworkadmin.com/what-is-dtim/) on the WiFi network. From fb26b16dc076207820ff92e51485f01802b60e61 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Fri, 1 Apr 2022 14:28:14 -0600 Subject: [PATCH 3/9] capitalize header --- docs/developers/overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developers/overview.mdx b/docs/developers/overview.mdx index a998f7c9..4bf495ec 100644 --- a/docs/developers/overview.mdx +++ b/docs/developers/overview.mdx @@ -29,7 +29,7 @@ Most communication and interactions happen with protocol buffers. The [Meshtasti The [Meshtastic-device](https://github.com/meshtastic/Meshtastic-device) is where all of the firmware development happens. This is where the code for the ESP32 and nRF52 based devices is developed. It is mainly C and C++ code.Think Arduino. It is where the first level of hardware interaction begins and ends. -## modules +## Modules [Modules](/docs/software/modules) are also implemented mainly in the Meshtastic-device repo above. Typically, you would add functionality in the protobufs repo and the device repo to implement module functionality. You probably also want to have some client/device use/interact with the module and that is where the Device support comes into play. From ebe869a65265e450243f38f3e15da3f4d65f8f1b Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Fri, 1 Apr 2022 14:45:11 -0600 Subject: [PATCH 4/9] ios bluetooth --- docs/faq/client-ios.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/faq/client-ios.mdx b/docs/faq/client-ios.mdx index f922484c..63078b9e 100644 --- a/docs/faq/client-ios.mdx +++ b/docs/faq/client-ios.mdx @@ -13,3 +13,7 @@ The now-in-beta iOS app requires iOS v15. ### How do I get the Meshtastic iOS App? See [iOS App](/docs/software/apple/ios-development) + +### After updating firmware, my node is not connecting via Bluetooth. What should I do? + +Try forgetting the Bluetooth connection from the iOS System Settings. Re-pair and try again. From d13e6af984b16abd1a0892e7291bd14058099aff Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Fri, 1 Apr 2022 14:46:52 -0600 Subject: [PATCH 5/9] triangulation --- docs/faq/mesh.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/faq/mesh.mdx b/docs/faq/mesh.mdx index 2d3a4565..5a0765ac 100644 --- a/docs/faq/mesh.mdx +++ b/docs/faq/mesh.mdx @@ -13,3 +13,7 @@ Meshtastic uses LoRa peer to peer (p2p), which allows much more flexibility in h ### Will Meshtastic work with (insert LoRa service) Meshtastic uses LoRa peer to peer (p2p), which has allowed us to customize how we use the protocol. Likely it will not work with the service you have in mind, but it may be possible to build a bridge between services using MQTT. That will require further development outside the scope of this project to implement. + +### Can I locate a device via triangulation? + +There is a [community project](https://github.com/a-f-G-U-C/Meshtastic-ZPS) that has worked out how to accomplish this. From 9fc926eea09b37f010be9b2b3b6e62b70646cf61 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Fri, 1 Apr 2022 14:51:39 -0600 Subject: [PATCH 6/9] meshtastic rak starter kit mac address --- docs/faq/device.mdx | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/faq/device.mdx b/docs/faq/device.mdx index 331d6279..67540bb9 100644 --- a/docs/faq/device.mdx +++ b/docs/faq/device.mdx @@ -38,3 +38,7 @@ Push the left PWR button for about 1 second. - Android instructions see: [Android Usage](/docs/software/android/android-usage#configuration-options) - Python CLI instructions see: [Python Usage](/docs/software/python/python-cli#changing-device-settings) + +### Why does only one RAK Meshtastic Starter kit show up in my node list? + +There was a bug where Meshtastic Starter kits were sent out with the same MAC address. With a single MAC address the devices all report as being the same device. Without the battery connected, flash the starter kit device(s) to 1.2.59 and then do a factory reset, disconnect and reconnect the board and run `meshtastic --info`. From 4d5b75ea01e71d97ff804dd4d0b76e72af646e70 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Fri, 1 Apr 2022 15:05:52 -0600 Subject: [PATCH 7/9] add device specific faqs --- docs/faq/device-tbeam.mdx | 15 +++++++++++++++ docs/faq/device-wisblock.mdx | 11 +++++++++++ sidebars.js | 8 +++++++- 3 files changed, 33 insertions(+), 1 deletion(-) create mode 100644 docs/faq/device-tbeam.mdx create mode 100644 docs/faq/device-wisblock.mdx diff --git a/docs/faq/device-tbeam.mdx b/docs/faq/device-tbeam.mdx new file mode 100644 index 00000000..446e2ad8 --- /dev/null +++ b/docs/faq/device-tbeam.mdx @@ -0,0 +1,15 @@ +--- +id: device +title: FAQs - Device +sidebar_label: Device +--- + +## Overview + +### How do I turn off an ESP32 t-beam based device? + +Hold down the left PWR button for about 10 seconds and the display should turn off. + +### How do I turn on an ESP32 t-beam based device? + +Push the left PWR button for about 1 second. diff --git a/docs/faq/device-wisblock.mdx b/docs/faq/device-wisblock.mdx new file mode 100644 index 00000000..41b9e328 --- /dev/null +++ b/docs/faq/device-wisblock.mdx @@ -0,0 +1,11 @@ +--- +id: device-wisblock +title: FAQs - WisBlock Device +sidebar_label: RAK WisBlock Devices +--- + +## Overview + +### Why does only one RAK Meshtastic Starter kit show up in my node list? + +There was a bug where Meshtastic Starter kits were sent out with the same MAC address. With a single MAC address the devices all report as being the same device. Without the battery connected, flash the starter kit device(s) to 1.2.59 and then do a factory reset, disconnect and reconnect the board and run `meshtastic --info`. diff --git a/sidebars.js b/sidebars.js index b305bc4b..92f17a19 100644 --- a/sidebars.js +++ b/sidebars.js @@ -27,7 +27,13 @@ module.exports = { "faq/client-web", ], }, - "faq/device", + { + Devices: [ + "faq/device", + "faq/device-tbeam", + "faq/device-wisblock", + ] + }, { "Flashing Firmware": ["faq/m-flasher"], }, From 55adb12d6d14972b35248b6d46854d09404ed847 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Fri, 1 Apr 2022 15:07:46 -0600 Subject: [PATCH 8/9] pnpm format ran --- docs/_blocks/_plugin_module.mdx | 11 +++- docs/hardware/gpsmodule.md | 61 +++++++++---------- docs/hardware/supported/rak4631.mdx | 28 +++++++-- docs/settings/canned-message-module.mdx | 4 +- .../settings/external-notification-module.mdx | 2 +- docs/settings/input-broker-module.mdx | 2 +- docs/settings/range-test-module.mdx | 1 + docs/settings/telemetry-module.mdx | 51 ++++++++++------ docs/software/modules/canned-message.mdx | 1 + .../modules/external-notifications.mdx | 3 +- docs/software/modules/range-test.mdx | 1 + docs/software/modules/serial.mdx | 1 + docs/software/modules/store-forward.mdx | 1 + docs/software/modules/telemetry.mdx | 3 +- docs/software/other/mqtt.mdx | 30 ++++----- 15 files changed, 120 insertions(+), 80 deletions(-) diff --git a/docs/_blocks/_plugin_module.mdx b/docs/_blocks/_plugin_module.mdx index 3a704be7..7d751ee9 100644 --- a/docs/_blocks/_plugin_module.mdx +++ b/docs/_blocks/_plugin_module.mdx @@ -1,3 +1,8 @@ -:::important -The name of ths option changed between Meshtastic 1.2 and 1.3. This documentaton already reflects the 1.3 syntax. Please substitute '{props.name}' prefix with '{props.rename}' to get the 1.2 compatible command name. -::: +:::important + + + The name of ths option changed between Meshtastic 1.2 and 1.3. This + documentaton already reflects the 1.3 syntax. Please substitute '{props.name}' + prefix with '{props.rename}' to get the 1.2 compatible command name. + +::: diff --git a/docs/hardware/gpsmodule.md b/docs/hardware/gpsmodule.md index 779eab45..96e3a462 100644 --- a/docs/hardware/gpsmodule.md +++ b/docs/hardware/gpsmodule.md @@ -11,6 +11,7 @@ GPIO access is fundamentally dangerous because invalid options can physically da External GPS modules can be installed to extend the capabilities of simple boards. ## GY-GPS6MV2 GPS module + - Based on the ublox/u-blox NEO-6M module - Input: 3 to 5V - Interface: RS232 TTL @@ -19,17 +20,16 @@ External GPS modules can be installed to extend the capabilities of simple board [GY-GPS6MV2](/img/hardware/gy-gps6mv2.jpg) - ### LILYGO TTGO Lora32 v2.1-1.6 - Wiring instructions: | GPS Module Pin | TTGO Lora32 v2.1-1.6 Pin | -| :-----: | :---------------: | -| VCC | 3.3V | -| RX | IO13 | -| TX | IO15 | -| GND | GND | +| :------------: | :----------------------: | +| VCC | 3.3V | +| RX | IO13 | +| TX | IO15 | +| GND | GND | - Once the module is connected, it should be detected automatically by the firmware. @@ -38,11 +38,11 @@ External GPS modules can be installed to extend the capabilities of simple board - Wiring instructions: | GPS Module Pin | TTGO Lora32 v2.0 Pin | -| :-----: | :---------------: | -| VCC | 3.3V | -| RX | 13 | -| TX | 36 | -| GND | GND | +| :------------: | :------------------: | +| VCC | 3.3V | +| RX | 13 | +| TX | 36 | +| GND | GND | - Once the module is connected, it should be detected automatically by the firmware. @@ -50,12 +50,12 @@ External GPS modules can be installed to extend the capabilities of simple board - Wiring instructions: -| GPS Module Pin | TTGO Lora32 v1.3 Pin| -| :-----: | :---------------: | -| VCC | 3.3V | -| RX | 13 | -| TX | 36 | -| GND | GND | +| GPS Module Pin | TTGO Lora32 v1.3 Pin | +| :------------: | :------------------: | +| VCC | 3.3V | +| RX | 13 | +| TX | 36 | +| GND | GND | - Once the module is connected, it should be detected automatically by the firmware. @@ -63,12 +63,12 @@ External GPS modules can be installed to extend the capabilities of simple board - Wiring instructions: -| GPS Module Pin | TTGO Lora32 v1.0 Pin| -| :-----: | :---------------: | -| VCC | 3.3V | -| RX | 37 | -| TX | 36 | -| GND | GND | +| GPS Module Pin | TTGO Lora32 v1.0 Pin | +| :------------: | :------------------: | +| VCC | 3.3V | +| RX | 37 | +| TX | 36 | +| GND | GND | - Once the module is connected, it should be detected automatically by the firmware. @@ -76,14 +76,11 @@ External GPS modules can be installed to extend the capabilities of simple board - Wiring instructions: -| GPS Module Pin | Heltec Lora32 Pin| -| :-----: | :---------------: | -| VCC | 3.3V | -| RX | 37 | -| TX | 36 | -| GND | GND | +| GPS Module Pin | Heltec Lora32 Pin | +| :------------: | :---------------: | +| VCC | 3.3V | +| RX | 37 | +| TX | 36 | +| GND | GND | - Once the module is connected, it should be detected automatically by the firmware. - - - diff --git a/docs/hardware/supported/rak4631.mdx b/docs/hardware/supported/rak4631.mdx index 4ac90867..5c8db8af 100644 --- a/docs/hardware/supported/rak4631.mdx +++ b/docs/hardware/supported/rak4631.mdx @@ -39,16 +39,36 @@ There is currently no pin required to pair RAK devices via BLE. - Optional screen - Firmware for 5005 base board: [`firmware-rak4631_5005-1.x.x.uf2`](/downloads) -RAK4631 5005 + + RAK4631 5005 - Firmware for 19003 base board: [`firmware-rak4631_19003-1.x.x.uf2`](/downloads) -RAK4631 19003 + + RAK4631 19003 - Firmware for 5005 with RAK14000 epaper: [`firmware-rak4631_19003-epaper-1.3.x.uf2`](/downloads) -RAK4631 5005 14000 + + RAK4631 5005 14000 - Firmware for 5005 with 11200: [`firmware-11200-1.3.x.bin`](/downloads) -RAK4631 5005 11200 + + RAK4631 5005 11200 - [Installation instructions](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK4631/Quickstart/#rak4631-lora-mesh-via-meshtastic) - Don't forget to [update the bootloader](https://docs.rakwireless.com/Product-Categories/WisBlock/RAK4631/Quickstart/#updating-the-bootloader) first! This can be done easily with [Meshtastic-flasher](https://github.com/meshtastic/Meshtastic-gui-installer) diff --git a/docs/settings/canned-message-module.mdx b/docs/settings/canned-message-module.mdx index 30e59354..ff4116ef 100644 --- a/docs/settings/canned-message-module.mdx +++ b/docs/settings/canned-message-module.mdx @@ -3,6 +3,7 @@ id: canned-message-module title: Canned Message Module sidebar_label: Canned Message Module --- + import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import PluginModule from '@site/docs/_blocks/_plugin_module.mdx'; @@ -35,7 +36,7 @@ Once module settings are changed, a **reset** is required for them to take effec | canned_message_module_enabled | `true`, `false` | `false` | | canned_message_module_messages | `string` | `""` | | canned_message_module_send_bell | `true`, `false` | `false` | -| (Messages)* | `string` | `""` | +| (Messages)\* | `string` | `""` | - Messages can be set with a dedicated option: @@ -170,7 +171,6 @@ values={[ ]}> - ```shell title="Enable Bell Character" meshtastic --set canned_message_module_send_bell true ``` diff --git a/docs/settings/external-notification-module.mdx b/docs/settings/external-notification-module.mdx index 43ba5e12..22dabb4b 100644 --- a/docs/settings/external-notification-module.mdx +++ b/docs/settings/external-notification-module.mdx @@ -8,10 +8,10 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import PluginModule from '@site/docs/_blocks/_plugin_module.mdx'; - :::warning GPIO access is fundamentally dangerous because invalid options can physically damage or destroy your hardware. Ensure that you fully understand the schematic for your particular device before trying this as we do not offer a warranty. Use at your own risk. ::: + diff --git a/docs/settings/input-broker-module.mdx b/docs/settings/input-broker-module.mdx index 5ee02c88..65632fe1 100644 --- a/docs/settings/input-broker-module.mdx +++ b/docs/settings/input-broker-module.mdx @@ -12,7 +12,7 @@ import PluginModule from '@site/docs/_blocks/_plugin_module.mdx'; GPIO access is fundamentally dangerous because invalid options can physically damage or destroy your hardware. Ensure that you fully understand the schematic for your particular device before trying this as we do not offer a warranty. Use at your own risk. ::: - + diff --git a/docs/settings/range-test-module.mdx b/docs/settings/range-test-module.mdx index afa5640d..953291ba 100644 --- a/docs/settings/range-test-module.mdx +++ b/docs/settings/range-test-module.mdx @@ -11,6 +11,7 @@ import PluginModule from '@site/docs/_blocks/_plugin_module.mdx'; ## Overview This module allows you to test the range of your Meshtastic nodes. It requires at least two nodes, a sender and a receiver. The receiving node then saves the messages along with the GPS coordinates at which they were received into a .csv file. This .csv file can then be integrated into [Google Earth](https://earth.google.com), [Google Maps - My Maps](https://mymaps.google.com), or any other program capable of processing .csv files. This can enable you to visualize your mesh. + :::tip diff --git a/docs/settings/telemetry-module.mdx b/docs/settings/telemetry-module.mdx index b7ff6bd2..a50abcae 100644 --- a/docs/settings/telemetry-module.mdx +++ b/docs/settings/telemetry-module.mdx @@ -12,7 +12,10 @@ import PluginModule from '@site/docs/_blocks/_plugin_module.mdx'; GPIO access is fundamentally dangerous because invalid options can physically damage or destroy your hardware. Ensure that you fully understand the schematic for your particular device before trying this as we do not offer a warranty. Use at your own risk. ::: - + @@ -30,8 +33,8 @@ Once module settings are changed, a **reset** is required for them to take effec ## Settings -| Setting | Acceptable Values | Default | -| :-----------------------------------------: | :-----------------: | :-----: | +| Setting | Acceptable Values | Default | +| :-----------------------------------------------------: | :-----------------: | :-----: | | telemetry_module_device_update_interval | `integer` (seconds) | `0` | | telemetry_module_environment_display_fahrenheit | `true`, `false` | `false` | | telemetry_module_environment_measurement_enabled | `true`, `false` | `false` | @@ -60,6 +63,7 @@ values={[ ```shell title="Set module update interval to default" meshtastic --set telemetry_module_device_update_interval 0 ``` + ```shell title="Set module update interval to 120 seconds" meshtastic --set telemetry_module_device_update_interval 120 ``` @@ -88,7 +92,6 @@ Configuring this setting is not yet available for the selected platform. If this - ### telemetry_module_environment_display_fahrenheit The sensor is always read in Celsius, but the user can opt to view the temperature display in Fahrenheit using this setting. @@ -107,16 +110,17 @@ values={[ <<<<<<< HEAD:docs/settings/environmental-measurment-module.mdx + ```shell title="Display Farenheit" meshtastic --set telemetry_module_display_farenheit true ``` -```shell title="Display Celsius" +````shell title="Display Celsius" meshtastic --set telemetry_module_display_farenheit false ======= ```shell title="Display Farenheit" meshtastic --set telemetry_module_environment_display_fahrenheit true -``` +```` ```shell title="Display Celsius" meshtastic --set telemetry_module_environment_display_fahrenheit false @@ -165,16 +169,17 @@ values={[ <<<<<<< HEAD:docs/settings/environmental-measurment-module.mdx + ```shell title="Enable Module" meshtastic --set telemetry_module_measurement_enabled true ``` -```shell title="Disable Module" +````shell title="Disable Module" meshtastic --set telemetry_module_measurement_enabled false ======= ```shell title="Enable Module" meshtastic --set telemetry_module_environment_measurement_enabled true -``` +```` ```shell title="Disable Module" meshtastic --set telemetry_module_environment_measurement_enabled false @@ -223,13 +228,14 @@ values={[ <<<<<<< HEAD:docs/settings/environmental-measurment-module.mdx -```shell title="Configure telemetry_module_read_error_count_threshold to 3 tries" + +````shell title="Configure telemetry_module_read_error_count_threshold to 3 tries" meshtastic --set telemetry_module_read_error_count_threshold 3 ======= ```shell title="Configure telemetry_module_environment_read_error_count_threshold to 3 tries" meshtastic --set telemetry_module_environment_read_error_count_threshold 3 >>>>>>> master:docs/settings/telemetry-module.md -``` +```` @@ -273,13 +279,14 @@ values={[ <<<<<<< HEAD:docs/settings/environmental-measurment-module.mdx -```shell title="Configure telemetry_module_recovery_interval to 120 seconds" + +````shell title="Configure telemetry_module_recovery_interval to 120 seconds" meshtastic --set telemetry_module_recovery_interval 120 ======= ```shell title="Configure telemetry_module_environment_recovery_interval to 120 seconds" meshtastic --set telemetry_module_environment_recovery_interval 120 >>>>>>> master:docs/settings/telemetry-module.md -``` +```` @@ -323,16 +330,17 @@ values={[ <<<<<<< HEAD:docs/settings/environmental-measurment-module.mdx + ```shell title="Enable on device screen" meshtastic --set telemetry_module_screen_enabled true ``` -```shell title="Disable on device screen" +````shell title="Disable on device screen" meshtastic --set telemetry_module_screen_enabled false ======= ```shell title="Enable on device screen" meshtastic --set telemetry_module_environment_screen_enabled true -``` +```` ```shell title="Disable on device screen" meshtastic --set telemetry_module_environment_screen_enabled false @@ -389,13 +397,14 @@ values={[ <<<<<<< HEAD:docs/settings/environmental-measurment-module.mdx -```shell title="Set module sensor pin" + +````shell title="Set module sensor pin" meshtastic --set telemetry_module_sensor_pin PINNUMBER ======= ```shell title="Set module sensor pin" meshtastic --set telemetry_module_environment_sensor_pin PINNUMBER >>>>>>> master:docs/settings/telemetry-module.md -``` +```` @@ -462,16 +471,17 @@ The CLI is able to take the `value` or the `name` of the sensor from the table a ::: <<<<<<< HEAD:docs/settings/environmental-measurment-module.mdx + ```shell title="Set sensor type to DS18B20" meshtastic --set telemetry_module_sensor_type 1 ``` -```shell title="Set sensor type to DS18B20" +````shell title="Set sensor type to DS18B20" meshtastic --set telemetry_module_sensor_type DS18B20 ======= ```shell title="Set sensor type to DS18B20" meshtastic --set telemetry_module_environment_sensor_type 2 -``` +```` ```shell title="Set sensor type to DS18B20" meshtastic --set telemetry_module_environment_sensor_type DS18B20 @@ -516,13 +526,14 @@ values={[ <<<<<<< HEAD:docs/settings/environmental-measurment-module.mdx -```shell title="Set module update interval to 15 seconds" + +````shell title="Set module update interval to 15 seconds" meshtastic --set telemetry_module_update_interval 15 ======= ```shell title="Set module update interval to 120 seconds" meshtastic --set telemetry_module_environment_update_interval 120 >>>>>>> master:docs/settings/telemetry-module.md -``` +```` diff --git a/docs/software/modules/canned-message.mdx b/docs/software/modules/canned-message.mdx index 607ffb2c..7a42b018 100644 --- a/docs/software/modules/canned-message.mdx +++ b/docs/software/modules/canned-message.mdx @@ -3,6 +3,7 @@ id: canned-message-module title: Canned messages sidebar_label: Canned messages --- + import PluginModule from '@site/docs/_blocks/_plugin_module.mdx'; ## About diff --git a/docs/software/modules/external-notifications.mdx b/docs/software/modules/external-notifications.mdx index 3f67c536..e033c74a 100644 --- a/docs/software/modules/external-notifications.mdx +++ b/docs/software/modules/external-notifications.mdx @@ -3,6 +3,7 @@ id: ext-notif-module title: External notifications sidebar_label: External notifications --- + import PluginModule from '@site/docs/_blocks/_plugin_module.mdx'; ## About @@ -11,7 +12,7 @@ The ExternalNotification Module will allow you to connect a speaker, LED or othe ## Configuration - + These are the settings that can be configured. diff --git a/docs/software/modules/range-test.mdx b/docs/software/modules/range-test.mdx index a69cb72d..4db25102 100644 --- a/docs/software/modules/range-test.mdx +++ b/docs/software/modules/range-test.mdx @@ -3,6 +3,7 @@ id: range-test-module title: Range Test Module sidebar_label: Range Test --- + import PluginModule from '@site/docs/_blocks/_plugin_module.mdx'; This module allows you to test the range of your Meshtastic nodes. It uses two nodes, one to send a message every minute, and another to receive the messages. The receiving node then saves the messages along with the GPS coordinates at which they were received into a .csv file. This .csv file can then be integrated into, for example, Google Earth, allowing you to see where you have coverage. diff --git a/docs/software/modules/serial.mdx b/docs/software/modules/serial.mdx index 334d34d4..261177fc 100644 --- a/docs/software/modules/serial.mdx +++ b/docs/software/modules/serial.mdx @@ -3,6 +3,7 @@ id: serial-module title: Serial communication module sidebar_label: Serial communication --- + import PluginModule from '@site/docs/_blocks/_plugin_module.mdx'; ## About diff --git a/docs/software/modules/store-forward.mdx b/docs/software/modules/store-forward.mdx index f1f0dd9e..a55a27d4 100644 --- a/docs/software/modules/store-forward.mdx +++ b/docs/software/modules/store-forward.mdx @@ -3,6 +3,7 @@ id: store-forward-module title: Store and Forward Module sidebar_label: Store and Forward --- + import PluginModule from '@site/docs/_blocks/_plugin_module.mdx'; ## About diff --git a/docs/software/modules/telemetry.mdx b/docs/software/modules/telemetry.mdx index 7757cb34..15fa6b2e 100644 --- a/docs/software/modules/telemetry.mdx +++ b/docs/software/modules/telemetry.mdx @@ -3,9 +3,10 @@ id: telemetry-module title: Telemetry sidebar_label: Telemetry --- + import PluginModule from '@site/docs/_blocks/_plugin_module.mdx'; - + ## About diff --git a/docs/software/other/mqtt.mdx b/docs/software/other/mqtt.mdx index 5102523d..c28e6429 100644 --- a/docs/software/other/mqtt.mdx +++ b/docs/software/other/mqtt.mdx @@ -36,24 +36,25 @@ The payload is a raw protobuf. Looking at the MQTT traffic with a program like ` ShortFast !937bed1c ``` -Packets from the following [port numbers](docs/developers/firmware/portnum) are serialized to JSON and then forwarded to the `msh/1/json/CHANNELID/DEVICEID` topic: `TEXT_MESSAGE_APP`, `ENVIRONMENTAL_MEASUREMENT_APP`, `NODEINFO_APP` and `POSITION_APP`. +Packets from the following [port numbers](docs/developers/firmware/portnum) are serialized to JSON and then forwarded to the `msh/1/json/CHANNELID/DEVICEID` topic: `TEXT_MESSAGE_APP`, `ENVIRONMENTAL_MEASUREMENT_APP`, `NODEINFO_APP` and `POSITION_APP`. An example of a received `NODEINFO_APP` message: + ```json { - "id":452664778, - "channel":0, - "from":2130636288, - "payload":{ - "hardware":10, - "id":"!7efeee00", - "longname":"base0", - "shortname":"BA0" - }, - "sender":"!7efeee00", - "timestamp":1646832724, - "to":-1, - "type":"nodeinfo" + "id": 452664778, + "channel": 0, + "from": 2130636288, + "payload": { + "hardware": 10, + "id": "!7efeee00", + "longname": "base0", + "shortname": "BA0" + }, + "sender": "!7efeee00", + "timestamp": 1646832724, + "to": -1, + "type": "nodeinfo" } ``` @@ -73,7 +74,6 @@ If the message received contains valid JSON in the payload, the JSON is deserial `sender` and `payload` fields are required for a valid envelope. If a valid MQTT message is found, the message is sent over the radio as a message of type `TEXT_MESSAGE_APP` with the serialized `payload` value in the message payload. - ### Basic Configuration Check out [MQTT Settings](/docs/settings/mqtt) for full information. For quick start instructions, read on. From db117bf10731a2fe5f8bed318ed3abcf4ccf80d7 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Fri, 1 Apr 2022 15:08:50 -0600 Subject: [PATCH 9/9] fixed id and sidebar --- docs/faq/device-tbeam.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/faq/device-tbeam.mdx b/docs/faq/device-tbeam.mdx index 446e2ad8..e22d0067 100644 --- a/docs/faq/device-tbeam.mdx +++ b/docs/faq/device-tbeam.mdx @@ -1,7 +1,7 @@ --- -id: device -title: FAQs - Device -sidebar_label: Device +id: device-tbeam +title: FAQs - T-Beam Device +sidebar_label: T-Beam Device --- ## Overview