Merge pull request #289 from caveman99/master

include a notice about naming change in plugins to modules (1.3 vs. 1.2)

docs/_blocks/_plugin_module.mdx

@@ -0,0 +1,3 @@
+:::important
+<span>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.</span>
+:::

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.
 :::
 
+<PluginModule name="canned_message_" rename="canned_message_" />
+
 <!--- TODO add link to hardware setup to admonition--->
 
 :::note

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/_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.
 :::
 
+<PluginModule name="telemetry_" rename="environmental_measurment_"/>
+
 <!--- TODO add link to hardware setup to admonition--->
 
 :::note

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.
 :::
+<PluginModule name="ext_notification_" rename="ext_notification_" />
 
 <!--- TODO add link to hardware setup to admonition--->
 

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.
+<PluginModule name="range_test_" rename="range_test_" />
 
 :::tip
 Once module settings are changed, a **reset** is required for them to take effect.

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.
 :::
 
+<PluginModule name="serial_" rename="serial_" />
+
 :::note
 This module requires attaching a peripheral accessory to your device. It will not work without one.
 :::

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.
 :::
 
+<PluginModule name="store_forward_" rename="store_forward_" />
+
 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).

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
 
+<PluginModule name="canned_message_" rename="canned_message_" />
+
 Following configuration can be set for the module.
 
     canned_message_module_enabled

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
 
+<PluginModule name="ext_notification_" rename="ext_notification_"/>
+
 These are the settings that can be configured.
 
     ext_notification_module_enabled

docs/software/modules/range-test.md

@@ -3,27 +3,30 @@ 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
 
+<PluginModule name="range_test_" rename="range_test_" />
+
 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
@@ -36,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
 

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.
 
+<PluginModule name="serial_" rename="serial_" />
+
 ## Basic Usage:
 
 1. Enable the module by setting `serial_module_enabled` to `1`.

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
 
+<PluginModule name="store_forward_" rename="store_forward_" />
+
 - Configure your device as a [Meshtastic router](/docs/settings/router).
 - Configure the Store and Forward Module
   - Required configuration

docs/software/modules/telemetry.md

@@ -3,6 +3,9 @@ id: telemetry-module
 title: Telemetry
 sidebar_label: Telemetry
 ---
+import PluginModule from '@site/docs/_blocks/_plugin_module.mdx';
+
+<PluginModule name="telemetry_" rename="environmental_measurment_"/>
 
 ## About