From 635a185ce3c9aac812ad1f4ffc1bc78e27da2c48 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20G=C3=B6ttgens?= Date: Fri, 18 Mar 2022 13:53:08 +0100 Subject: [PATCH 1/3] include a notice about naming change in plugins to modules --- docs/_blocks/_plugin_module.mdx | 3 +++ docs/_blocks/_telemetry_caution.mdx | 3 +++ docs/settings/canned-message-module.md | 4 +++- docs/settings/environmental-measurment-module.md | 3 +++ docs/settings/external-notification-module.md | 3 +++ docs/settings/range-test-module.md | 2 ++ docs/settings/serial-module.md | 3 +++ docs/settings/store-and-forward-module.md | 3 +++ docs/software/modules/canned-message.md | 3 +++ docs/software/modules/external-notifications.md | 3 +++ docs/software/modules/range-test.md | 3 +++ docs/software/modules/serial.md | 3 +++ docs/software/modules/store-forward.md | 3 +++ docs/software/modules/telemetry.md | 3 +++ 14 files changed, 41 insertions(+), 1 deletion(-) create mode 100644 docs/_blocks/_plugin_module.mdx create mode 100644 docs/_blocks/_telemetry_caution.mdx diff --git a/docs/_blocks/_plugin_module.mdx b/docs/_blocks/_plugin_module.mdx new file mode 100644 index 00000000..5590ba93 --- /dev/null +++ b/docs/_blocks/_plugin_module.mdx @@ -0,0 +1,3 @@ +:::important +The name of ths option changed between Meshtastic 1.2 and 1.3. This documentaton already reflects the 1.3 syntax. Please substitute 'module' with 'plugin' to get the 1.2 compatible command name. +::: diff --git a/docs/_blocks/_telemetry_caution.mdx b/docs/_blocks/_telemetry_caution.mdx new file mode 100644 index 00000000..c271a3e5 --- /dev/null +++ b/docs/_blocks/_telemetry_caution.mdx @@ -0,0 +1,3 @@ +:::important +The name of ths option changed between Meshtastic 1.2 and 1.3. This documentaton already reflects the 1.3 syntax. Please substitute 'telemetry_module' with 'environmental_measurement_plugin' to get the 1.2 compatible command name. +::: diff --git a/docs/settings/canned-message-module.md b/docs/settings/canned-message-module.md index d81c1fc3..1fb3a764 100644 --- a/docs/settings/canned-message-module.md +++ b/docs/settings/canned-message-module.md @@ -3,14 +3,16 @@ 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'; :::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. ::: + + :::note diff --git a/docs/settings/environmental-measurment-module.md b/docs/settings/environmental-measurment-module.md index 0e70057a..af0f4be3 100644 --- a/docs/settings/environmental-measurment-module.md +++ b/docs/settings/environmental-measurment-module.md @@ -6,11 +6,14 @@ sidebar_label: Telemetry Module import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +import PluginModule from '@site/docs/_blocks/_telemetry_caution.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. ::: + + :::note diff --git a/docs/settings/external-notification-module.md b/docs/settings/external-notification-module.md index b41dafba..dc942298 100644 --- a/docs/settings/external-notification-module.md +++ b/docs/settings/external-notification-module.md @@ -6,10 +6,13 @@ sidebar_label: External Notification Module 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/range-test-module.md b/docs/settings/range-test-module.md index bacd1211..07ea1fd8 100644 --- a/docs/settings/range-test-module.md +++ b/docs/settings/range-test-module.md @@ -6,10 +6,12 @@ sidebar_label: Range Test Module import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +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 Once module settings are changed, a **reset** is required for them to take effect. diff --git a/docs/settings/serial-module.md b/docs/settings/serial-module.md index b929b56f..963b651a 100644 --- a/docs/settings/serial-module.md +++ b/docs/settings/serial-module.md @@ -6,11 +6,14 @@ sidebar_label: Serial Module 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. ::: + + :::note This module requires attaching a peripheral accessory to your device. It will not work without one. ::: diff --git a/docs/settings/store-and-forward-module.md b/docs/settings/store-and-forward-module.md index ccaefc80..e8ddc302 100644 --- a/docs/settings/store-and-forward-module.md +++ b/docs/settings/store-and-forward-module.md @@ -6,6 +6,7 @@ sidebar_label: Store and Forward import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +import PluginModule from '@site/docs/_blocks/_plugin_module.mdx'; :::info Currently only available for ESP32 based devices with external PSRAM. Requires the device to be set as a router. @@ -19,6 +20,8 @@ Currently only available for ESP32 based devices with external PSRAM. Requires t This is a work in progress and is partially available. Stability is not guaranteed. ::: + + The Store Forward Module is an implementation of a Store and Forward system to enable resilient messaging in the event that a client device is disconnected from the main network. Because of the increased network traffic for this overhead, it's not advised to use this if you are duty cycle limited for your airtime usage nor is it advised to use this for SF12 (Long Range / Slow). diff --git a/docs/software/modules/canned-message.md b/docs/software/modules/canned-message.md index 79c0484d..f3374472 100644 --- a/docs/software/modules/canned-message.md +++ b/docs/software/modules/canned-message.md @@ -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 @@ -96,6 +97,8 @@ The rotary encoder #1 will send input events under name "rotEnc1". ## Configuration of the module + + Following configuration can be set for the module. canned_message_module_enabled diff --git a/docs/software/modules/external-notifications.md b/docs/software/modules/external-notifications.md index 7220830d..bdaee4a1 100644 --- a/docs/software/modules/external-notifications.md +++ b/docs/software/modules/external-notifications.md @@ -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 @@ -10,6 +11,8 @@ The ExternalNotification Module will allow you to connect a speaker, LED or othe ## Configuration + + These are the settings that can be configured. ext_notification_module_enabled diff --git a/docs/software/modules/range-test.md b/docs/software/modules/range-test.md index d7dfec5a..57d93907 100644 --- a/docs/software/modules/range-test.md +++ b/docs/software/modules/range-test.md @@ -3,11 +3,14 @@ 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. ## Configuration + + These are the settings that can be configured. range_test_plugin_enabled diff --git a/docs/software/modules/serial.md b/docs/software/modules/serial.md index 2a96a961..7b853aad 100644 --- a/docs/software/modules/serial.md +++ b/docs/software/modules/serial.md @@ -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 @@ -10,6 +11,8 @@ This is a simple interface to send messages over the mesh network by sending str Default is to use RX GPIO 16 and TX GPIO 17. + + ## Basic Usage: 1. Enable the module by setting `serial_module_enabled` to `1`. diff --git a/docs/software/modules/store-forward.md b/docs/software/modules/store-forward.md index 52494309..c56dfe37 100644 --- a/docs/software/modules/store-forward.md +++ b/docs/software/modules/store-forward.md @@ -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 @@ -49,6 +50,8 @@ With an aftermarket coaxial antenna or moxon antenna, that will give you roughly ### Router setup + + - Configure your device as a [Meshtastic router](/docs/settings/router). - Configure the Store and Forward Module - Required configuration diff --git a/docs/software/modules/telemetry.md b/docs/software/modules/telemetry.md index b481a3f0..14804eb1 100644 --- a/docs/software/modules/telemetry.md +++ b/docs/software/modules/telemetry.md @@ -3,6 +3,9 @@ id: telemetry-module title: Telemetry sidebar_label: Telemetry --- +import PluginModule from '@site/docs/_blocks/_telemetry_caution.mdx'; + + ## About From cf8fa49b58f7c90be9314b5d5e33905c44d2949c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20G=C3=B6ttgens?= Date: Fri, 18 Mar 2022 13:56:19 +0100 Subject: [PATCH 2/3] revert #288 --- docs/software/modules/range-test.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/software/modules/range-test.md b/docs/software/modules/range-test.md index 57d93907..a0783edc 100644 --- a/docs/software/modules/range-test.md +++ b/docs/software/modules/range-test.md @@ -13,20 +13,20 @@ This module allows you to test the range of your Meshtastic nodes. It uses two n These are the settings that can be configured. - range_test_plugin_enabled + range_test_module_enabled Is the Module enabled? 0 = Disabled (Default) 1 = Enabled - range_test_plugin_save + range_test_module_save If enabled, we will save a log of all received messages to /static/rangetest.csv which you can access from the webserver. We will abort writing if there is less than 50k of space on the filesystem to prevent filling up the storage. 0 = Disabled (Default) 1 = Enabled - range_test_plugin_sender + range_test_module_sender Number of seconds to wait between sending packets. Using the long_slow channel configuration, it's best not to go more frequent than once every 60 seconds. You can be more agressive with faster settings. 0 is default which disables sending messages. :::note @@ -39,36 +39,36 @@ For basic usage, you will need two devices both with a GPS. A device with a pair The first thing to do is to turn on the module. The device will need to be restarted after applying the settings. With the module turned on, the other settings will be available: - range_test_plugin_enabled = 1 + range_test_module_enabled = 1 If you want to send a message every 60 seconds: - range_test_plugin_sender = 60 + range_test_module_sender = 60 To save a log of the messages: - range_test_plugin_save = 1 + range_test_module_save = 1 Recommended settings for a sender at different radio settings: - Long Slow ... range_test_plugin_sender = 60 - Long Alt ... range_test_plugin_sender = 30 - Medium ... range_test_plugin_sender = 15 - Short Fast ... range_test_plugin_sender = 15 + Long Slow ... range_test_module_sender = 60 + Long Alt ... range_test_module_sender = 30 + Medium ... range_test_module_sender = 15 + Short Fast ... range_test_module_sender = 15 ### Python API Examples Sender -`meshtastic --set range_test_plugin_enabled 1` +`meshtastic --set range_test_module_enabled 1` -`meshtastic --set range_test_plugin_sender 60` +`meshtastic --set range_test_module_sender 60` Receiver -`meshtastic --set range_test_plugin_enabled 1` +`meshtastic --set range_test_module_enabled 1` -`meshtastic --set range_test_plugin_save 1` +`meshtastic --set range_test_module_save 1` ### Other things to keep in mind From 351bcc9369d6a46fc5779e071a341121c7cb7d19 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Thomas=20G=C3=B6ttgens?= Date: Fri, 18 Mar 2022 14:53:31 +0100 Subject: [PATCH 3/3] change snippet to variable use --- docs/_blocks/_plugin_module.mdx | 2 +- docs/_blocks/_telemetry_caution.mdx | 3 --- docs/settings/canned-message-module.md | 2 +- docs/settings/environmental-measurment-module.md | 4 ++-- docs/settings/external-notification-module.md | 2 +- docs/settings/range-test-module.md | 2 +- docs/settings/serial-module.md | 2 +- docs/settings/store-and-forward-module.md | 2 +- docs/software/modules/canned-message.md | 2 +- docs/software/modules/external-notifications.md | 2 +- docs/software/modules/range-test.md | 2 +- docs/software/modules/serial.md | 2 +- docs/software/modules/store-forward.md | 2 +- docs/software/modules/telemetry.md | 4 ++-- 14 files changed, 15 insertions(+), 18 deletions(-) delete mode 100644 docs/_blocks/_telemetry_caution.mdx diff --git a/docs/_blocks/_plugin_module.mdx b/docs/_blocks/_plugin_module.mdx index 5590ba93..53f97b92 100644 --- a/docs/_blocks/_plugin_module.mdx +++ b/docs/_blocks/_plugin_module.mdx @@ -1,3 +1,3 @@ :::important -The name of ths option changed between Meshtastic 1.2 and 1.3. This documentaton already reflects the 1.3 syntax. Please substitute 'module' with 'plugin' to get the 1.2 compatible command name. +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}module' prefix with '{props.rename}plugin' to get the 1.2 compatible command name. ::: diff --git a/docs/_blocks/_telemetry_caution.mdx b/docs/_blocks/_telemetry_caution.mdx deleted file mode 100644 index c271a3e5..00000000 --- a/docs/_blocks/_telemetry_caution.mdx +++ /dev/null @@ -1,3 +0,0 @@ -:::important -The name of ths option changed between Meshtastic 1.2 and 1.3. This documentaton already reflects the 1.3 syntax. Please substitute 'telemetry_module' with 'environmental_measurement_plugin' to get the 1.2 compatible command name. -::: diff --git a/docs/settings/canned-message-module.md b/docs/settings/canned-message-module.md index 1fb3a764..181b079e 100644 --- a/docs/settings/canned-message-module.md +++ b/docs/settings/canned-message-module.md @@ -11,7 +11,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/environmental-measurment-module.md b/docs/settings/environmental-measurment-module.md index af0f4be3..e70447bc 100644 --- a/docs/settings/environmental-measurment-module.md +++ b/docs/settings/environmental-measurment-module.md @@ -6,13 +6,13 @@ sidebar_label: Telemetry Module import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; -import PluginModule from '@site/docs/_blocks/_telemetry_caution.mdx'; +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/external-notification-module.md b/docs/settings/external-notification-module.md index dc942298..ab1b4e29 100644 --- a/docs/settings/external-notification-module.md +++ b/docs/settings/external-notification-module.md @@ -12,7 +12,7 @@ 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/range-test-module.md b/docs/settings/range-test-module.md index 07ea1fd8..83a042b6 100644 --- a/docs/settings/range-test-module.md +++ b/docs/settings/range-test-module.md @@ -11,7 +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 Once module settings are changed, a **reset** is required for them to take effect. diff --git a/docs/settings/serial-module.md b/docs/settings/serial-module.md index 963b651a..16d48a18 100644 --- a/docs/settings/serial-module.md +++ b/docs/settings/serial-module.md @@ -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. ::: - + :::note This module requires attaching a peripheral accessory to your device. It will not work without one. diff --git a/docs/settings/store-and-forward-module.md b/docs/settings/store-and-forward-module.md index e8ddc302..04720667 100644 --- a/docs/settings/store-and-forward-module.md +++ b/docs/settings/store-and-forward-module.md @@ -20,7 +20,7 @@ Currently only available for ESP32 based devices with external PSRAM. Requires t This is a work in progress and is partially available. Stability is not guaranteed. ::: - + The Store Forward Module is an implementation of a Store and Forward system to enable resilient messaging in the event that a client device is disconnected from the main network. diff --git a/docs/software/modules/canned-message.md b/docs/software/modules/canned-message.md index f3374472..f20b83de 100644 --- a/docs/software/modules/canned-message.md +++ b/docs/software/modules/canned-message.md @@ -97,7 +97,7 @@ The rotary encoder #1 will send input events under name "rotEnc1". ## Configuration of the module - + Following configuration can be set for the module. diff --git a/docs/software/modules/external-notifications.md b/docs/software/modules/external-notifications.md index bdaee4a1..3f67c536 100644 --- a/docs/software/modules/external-notifications.md +++ b/docs/software/modules/external-notifications.md @@ -11,7 +11,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.md b/docs/software/modules/range-test.md index a0783edc..a69cb72d 100644 --- a/docs/software/modules/range-test.md +++ b/docs/software/modules/range-test.md @@ -9,7 +9,7 @@ This module allows you to test the range of your Meshtastic nodes. It uses two n ## Configuration - + These are the settings that can be configured. diff --git a/docs/software/modules/serial.md b/docs/software/modules/serial.md index 7b853aad..334d34d4 100644 --- a/docs/software/modules/serial.md +++ b/docs/software/modules/serial.md @@ -11,7 +11,7 @@ This is a simple interface to send messages over the mesh network by sending str Default is to use RX GPIO 16 and TX GPIO 17. - + ## Basic Usage: diff --git a/docs/software/modules/store-forward.md b/docs/software/modules/store-forward.md index c56dfe37..c812af3e 100644 --- a/docs/software/modules/store-forward.md +++ b/docs/software/modules/store-forward.md @@ -50,7 +50,7 @@ With an aftermarket coaxial antenna or moxon antenna, that will give you roughly ### Router setup - + - Configure your device as a [Meshtastic router](/docs/settings/router). - Configure the Store and Forward Module diff --git a/docs/software/modules/telemetry.md b/docs/software/modules/telemetry.md index 14804eb1..27e6ad73 100644 --- a/docs/software/modules/telemetry.md +++ b/docs/software/modules/telemetry.md @@ -3,9 +3,9 @@ id: telemetry-module title: Telemetry sidebar_label: Telemetry --- -import PluginModule from '@site/docs/_blocks/_telemetry_caution.mdx'; +import PluginModule from '@site/docs/_blocks/_plugin_module.mdx'; - + ## About