include a notice about naming change in plugins to modules

This commit is contained in:
Thomas Göttgens 2022-03-18 13:53:08 +01:00
parent a7d0fc6233
commit 635a185ce3
14 changed files with 41 additions and 1 deletions

View file

@ -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.
:::

View file

@ -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.
:::

View file

@ -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 />
<!--- TODO add link to hardware setup to admonition--->
:::note

View file

@ -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.
:::
<PluginModule />
<!--- TODO add link to hardware setup to admonition--->
:::note

View file

@ -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 />
<!--- TODO add link to hardware setup to admonition--->

View file

@ -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 />
:::tip
Once module settings are changed, a **reset** is required for them to take effect.

View file

@ -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 />
:::note
This module requires attaching a peripheral accessory to your device. It will not work without one.
:::

View file

@ -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 />
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).

View file

@ -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 />
Following configuration can be set for the module.
canned_message_module_enabled

View file

@ -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 />
These are the settings that can be configured.
ext_notification_module_enabled

View file

@ -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
<PluginModule />
These are the settings that can be configured.
range_test_plugin_enabled

View file

@ -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 />
## Basic Usage:
1. Enable the module by setting `serial_module_enabled` to `1`.

View file

@ -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 />
- Configure your device as a [Meshtastic router](/docs/settings/router).
- Configure the Store and Forward Module
- Required configuration

View file

@ -3,6 +3,9 @@ id: telemetry-module
title: Telemetry
sidebar_label: Telemetry
---
import PluginModule from '@site/docs/_blocks/_telemetry_caution.mdx';
<PluginModule />
## About