From 55adb12d6d14972b35248b6d46854d09404ed847 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Fri, 1 Apr 2022 15:07:46 -0600 Subject: [PATCH] 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.