From 602572bba45c9d77e9ae9e5d16dce2cafbe91497 Mon Sep 17 00:00:00 2001 From: Foster Irwin Date: Wed, 23 Feb 2022 06:24:55 -0700 Subject: [PATCH] add warning admonition --- docs/settings/canned-message-plugin.md | 4 ++++ docs/settings/environmental-measurment-plugin.md | 4 ++++ docs/settings/external-notification-plugin.md | 4 ++++ docs/settings/rotary-encoder-plugin.md | 4 ++++ docs/settings/serial-plugin.md | 3 +++ 5 files changed, 19 insertions(+) diff --git a/docs/settings/canned-message-plugin.md b/docs/settings/canned-message-plugin.md index 2a8a2513..5ab3e5b5 100644 --- a/docs/settings/canned-message-plugin.md +++ b/docs/settings/canned-message-plugin.md @@ -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. +::: + :::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. diff --git a/docs/settings/environmental-measurment-plugin.md b/docs/settings/environmental-measurment-plugin.md index 78d8b327..67a87843 100644 --- a/docs/settings/environmental-measurment-plugin.md +++ b/docs/settings/environmental-measurment-plugin.md @@ -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. +::: + :::note This plugin requires attaching a peripheral accessory to your device. It will not work without one. diff --git a/docs/settings/external-notification-plugin.md b/docs/settings/external-notification-plugin.md index 2cd69c45..4e348368 100644 --- a/docs/settings/external-notification-plugin.md +++ b/docs/settings/external-notification-plugin.md @@ -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. +::: + :::note This plugin requires attaching a peripheral accessory to your device. It will not work without one. diff --git a/docs/settings/rotary-encoder-plugin.md b/docs/settings/rotary-encoder-plugin.md index b663fe76..75ec04c4 100644 --- a/docs/settings/rotary-encoder-plugin.md +++ b/docs/settings/rotary-encoder-plugin.md @@ -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. +::: + :::note This plugin requires attaching a peripheral accessory to your device. It will not work without one. diff --git a/docs/settings/serial-plugin.md b/docs/settings/serial-plugin.md index a559023d..13cdaa57 100644 --- a/docs/settings/serial-plugin.md +++ b/docs/settings/serial-plugin.md @@ -6,6 +6,9 @@ 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. +::: ## Overview