change snippet to variable use

This commit is contained in:
Thomas Göttgens 2022-03-18 14:53:31 +01:00
parent cf8fa49b58
commit 351bcc9369
14 changed files with 15 additions and 18 deletions

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

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

View file

@ -97,7 +97,7 @@ The rotary encoder #1 will send input events under name "rotEnc1".
## Configuration of the module
<PluginModule />
<PluginModule name="canned_message_" rename="canned_message_" />
Following configuration can be set for the module.

View file

@ -11,7 +11,7 @@ The ExternalNotification Module will allow you to connect a speaker, LED or othe
## Configuration
<PluginModule />
<PluginModule name="ext_notification_" rename="ext_notification_"/>
These are the settings that can be configured.

View file

@ -9,7 +9,7 @@ This module allows you to test the range of your Meshtastic nodes. It uses two n
## Configuration
<PluginModule />
<PluginModule name="range_test_" rename="range_test_" />
These are the settings that can be configured.

View file

@ -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.
<PluginModule />
<PluginModule name="serial_" rename="serial_" />
## Basic Usage:

View file

@ -50,7 +50,7 @@ With an aftermarket coaxial antenna or moxon antenna, that will give you roughly
### Router setup
<PluginModule />
<PluginModule name="store_forward_" rename="store_forward_" />
- Configure your device as a [Meshtastic router](/docs/settings/router).
- Configure the Store and Forward Module

View file

@ -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';
<PluginModule />
<PluginModule name="telemetry_" rename="environmental_measurment_"/>
## About