mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2025-01-29 14:51:50 -08:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

Merge pull request #256 from jfirwin/add-gpio-admonitions

Browse source 
Add gpio warnings/cautions to plugins utilizing gpio
This commit is contained in:
Foster Irwin 2022-02-23 08:37:15 -07:00 committed by GitHub
parent 0185fadb39 2ce15ecb1c
commit cd272de9c2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 55 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/settings/canned-message-plugin.md
View file

@ -6,6 +6,10 @@ sidebar_label: Canned Message Plugin
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
:::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.
:::
<!--- TODO add link to hardware setup to admonition--->
:::note
This plugin requires attaching a peripheral accessory to your device. It will not work without one. It also requires use of the [Rotary Encoder Plugin](rotary-encoder-plugin) to configure the input source.

8
docs/settings/environmental-measurment-plugin.md
View file

@ -6,6 +6,10 @@ sidebar_label: Environmental Measurement Plugin
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
:::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.
:::
<!--- TODO add link to hardware setup to admonition--->
:::note
This plugin requires attaching a peripheral accessory to your device. It will not work without one.
@ -265,6 +269,10 @@ The preferred setup is using I2C, so the `environmental_measurement_plugin_senso
Specify the preferred GPIO Pin for sensor readings. May not be needed if using I2C.
:::caution
To prevent damaging your device, double check your device's schematics before attaching to the GPIO pins and setting this value.
:::
#### Set plugin sensor pin
<Tabs
groupId="settings"

12
docs/settings/external-notification-plugin.md
View file

@ -6,6 +6,10 @@ sidebar_label: External Notification Plugin
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
:::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.
:::
<!--- TODO add link to hardware setup to admonition--->
:::note
This plugin requires attaching a peripheral accessory to your device. It will not work without one.
@ -34,6 +38,10 @@ Once plugin settings are changed, a **reset** is required for them to take effec
Specifies whether the external circuit is triggered when the device's GPIO is low or high.
:::caution
To prevent damaging your device, double check your device's schematics before attaching to the GPIO pins and setting this value.
:::
#### Specify High/Low GPIO triggers circuit
<Tabs
groupId="settings"
@ -218,6 +226,10 @@ Configuring this setting is not yet available for the selected platform. If this
Specifies the GPIO that your external circuit is attached to on the device.
:::caution
To prevent damaging your device, double check your device's schematics before attaching to the GPIO pins and setting this value.
:::
#### Specify GPIO for circuit to monitor
<Tabs
groupId="settings"

16
docs/settings/rotary-encoder-plugin.md
View file

@ -6,6 +6,10 @@ sidebar_label: Rotary Encoder
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
:::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.
:::
<!--- TODO add link to hardware setup to admonition--->
:::note
This plugin requires attaching a peripheral accessory to your device. It will not work without one.
@ -220,6 +224,10 @@ Configuring this setting is not yet available for the selected platform. If this
### rotary1_pin_a
GPIO pin for rotary encoder A port.
:::caution
To prevent damaging your device, double check your device's schematics before attaching to the GPIO pins and setting this value.
:::
#### Specify rotary1 pin a
<Tabs
groupId="settings"
@ -264,6 +272,10 @@ Configuring this setting is not yet available for the selected platform. If this
### rotary1_pin_b
GPIO pin for rotary encoder B port.
:::caution
To prevent damaging your device, double check your device's schematics before attaching to the GPIO pins and setting this value.
:::
#### Specify rotary1 pin b
<Tabs
groupId="settings"
@ -308,6 +320,10 @@ Configuring this setting is not yet available for the selected platform. If this
### rotary1_pin_press
GPIO pin for rotary encoder Press port.
:::caution
To prevent damaging your device, double check your device's schematics before attaching to the GPIO pins and setting this value.
:::
#### Specify rotary1 pin press
<Tabs
groupId="settings"

15
docs/settings/serial-plugin.md
View file

@ -6,6 +6,13 @@ sidebar_label: Serial Plugin
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
:::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 plugin requires attaching a peripheral accessory to your device. It will not work without one.
:::
## Overview
@ -165,6 +172,10 @@ Configuring this setting is not yet available for the selected platform. If this
Set the GPIO pin to the RXD pin you have set up.
:::caution
To prevent damaging your device, double check your device's schematics before attaching to the GPIO pins and setting this value.
:::
<Tabs
groupId="settings"
defaultValue="cli"
@ -255,6 +266,10 @@ Configuring this setting is not yet available for the selected platform. If this
Set the GPIO pin to the TXD pin you have set up.
:::caution
To prevent damaging your device, double check your device's schematics before attaching to the GPIO pins and setting this value.
:::
<Tabs
groupId="settings"
defaultValue="cli"