From 513b5f3e3fa483bfb64e7c583ec0f109ebb8655a Mon Sep 17 00:00:00 2001 From: Garth Vander Houwen Date: Wed, 29 Jun 2022 12:08:30 -0700 Subject: [PATCH] More module docs cleanup --- docs/settings/moduleconfig/canned-message.mdx | 4 +- .../moduleconfig/external-notification.mdx | 357 ++++-------------- docs/settings/moduleconfig/range-test.mdx | 2 +- docs/settings/moduleconfig/serial.mdx | 4 +- 4 files changed, 83 insertions(+), 284 deletions(-) diff --git a/docs/settings/moduleconfig/canned-message.mdx b/docs/settings/moduleconfig/canned-message.mdx index 2b7bc4b0..527fef5f 100644 --- a/docs/settings/moduleconfig/canned-message.mdx +++ b/docs/settings/moduleconfig/canned-message.mdx @@ -37,7 +37,9 @@ Once module settings are changed, a **reset** is required for them to take effec `--set-canned-message ""` -### canned_message_module_allow_input_source +### Enabled + +### Allow Input Source Input event source accepted by the canned message module. diff --git a/docs/settings/moduleconfig/external-notification.mdx b/docs/settings/moduleconfig/external-notification.mdx index a147cf1f..576166b1 100644 --- a/docs/settings/moduleconfig/external-notification.mdx +++ b/docs/settings/moduleconfig/external-notification.mdx @@ -9,329 +9,126 @@ 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 module requires attaching a peripheral accessory to your device. It will not work without one. ::: -## Overview +The External Notification Module will allow you to connect a buzzer, speaker, LED, or other device to notify you when a message has been received from the mesh network. -The External Notification Module will allow you to connect a speaker, LED, or other device to notify you when a message has been received from the mesh network. -:::tip -Once module settings are changed, a **reset** is required for them to take effect. -::: -## Settings + ## External Notification Module Config Values -| Setting | Acceptable Values | Default | -| :-----------------------------------: | :----------------------: | :-----: | -| ext_notification_module_active | `true`, `false` | `false` | -| ext_notification_module_alert_bell | `true`, `false` | `false` | -| ext_notification_module_alert_message | `true`, `false` | `false` | -| ext_notification_module_enabled | `true`, `false` | `false` | -| ext_notification_module_output | `integer` | `0` | -| ext_notification_module_output_ms | `integer` (milliseconds) | `0` | +### Enabled -### ext_notification_module_active +Enables the external notification module. + +### Alert when receiving a bell + +Specifies if an alert should be triggered when receiving an incoming bell. + +### Alert when receiving a message + +Specifies if an alert should be triggered when receiving an incoming message. + +### Active 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 - - - - -```shell title="GPIO active high" -meshtastic --set ext_notification_module_active true -``` - -```shell title="GPIO active low (default)" -meshtastic --set ext_notification_module_active false -``` - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -### ext_notification_module_alert_bell - -Specifies if an alert should be sent when receiving an incoming bell. - -#### Enable/Disable alert on incoming bell - - - - -```shell title="Enable alert on incoming bell" -meshtastic --set ext_notification_module_alert_bell true -``` - -```shell title="Disable alert on incoming bell" -meshtastic --set ext_notification_module_alert_bell false -``` - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -### ext_notification_module_alert_message - -Specifies if an alert should be sent when receiving an incoming message. - -#### Enable/Disable Alert on incoming message - - - - -```shell title="Enable alert on incoming message" -meshtastic --set ext_notification_module_alert_message true -``` - -```shell title="Disable alert on incoming message" -meshtastic --set ext_notification_module_alert_message false -``` - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -### ext_notification_module_enabled - -Enables the module. - -#### Enable/Disable the module - - - - -```shell title="Enable Module" -meshtastic --set ext_notification_module_enabled true -``` - -```shell title="Disable Module" -meshtastic --set ext_notification_module_enabled false -``` - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -### ext_notification_module_output +### GPIO to monitor 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. -::: +### How long monitored GPIO is triggered -#### Specify GPIO for circuit to monitor +Specifies how long in milliseconds you would like your external circuit to be triggered. + +Default of 0 is 1000ms + +## External Notification Module Config Client Availability - + -:::note -Replace `GPIO` in the below command with the GPIO number your circuit is attached to. +:::info +External notification module config is not available for Android. ::: -```shell title="Specify GPIO that circuit is connected to" -meshtastic --set ext_notification_module_output GPIO + + + +:::info +All external notification module config options are available on iOS, iPadOS and macOS at Settings > Modules > External Notification. +::: + + + + +All external noftification module config options are available in the python CLI. Example commands are below: + +| Setting | Acceptable Values | Default | +| :-----------------------------------: | :----------------------: | :-----: | +| ext_notification_module_enabled | `true`, `false` | `false` | +| ext_notification_module_active | `true`, `false` | `false` | +| ext_notification_module_alert_bell | `true`, `false` | `false` | +| ext_notification_module_alert_message | `true`, `false` | `false` | +| ext_notification_module_output | `integer` | `0` | +| ext_notification_module_output_ms | `integer` (milliseconds) | `0` | + +```shell title="Enable/Disable External Notification Module" +meshtastic --set ext_notification_module_enabled true +meshtastic --set ext_notification_module_enabled false ``` - - +```shell title="Enable/Disable alert on incoming bell" +meshtastic --set ext_notification_module_alert_bell true +meshtastic --set ext_notification_module_alert_bell false +``` -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: +```shell title="Set GPIO active high / low (defalut of false is low)" +meshtastic --set ext_notification_module_active false +meshtastic --set ext_notification_module_active true +``` - - +```shell title="Enable/Disable alert on incoming message" +meshtastic --set ext_notification_module_alert_message true +meshtastic --set ext_notification_module_alert_message false +``` -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: +```shell title="Set GPIO to monitor to 21" +meshtastic --set ext_notification_module_output 21 +``` - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -### ext_notification_module_output_ms - -Specifies how long in milliseconds you would like your external circuit triggered. Default is `1000`. (Because of the way that defaults are handled in the protobufs `0` is interpreted as `1000`) - -#### Specify how many milliseconds to trigger circuit - - - - -```shell title="Set to default (1000ms)" +```shell title="Set monitored GPIO output duration (default of 0 is 1000ms)" meshtastic --set ext_notification_module_output_ms 0 -``` - -```shell title="Set to other value" meshtastic --set ext_notification_module_output_ms 1500 ``` - - - + + :::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. -::: - - - - -:::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +External Notification module config is not available in the Flasher. ::: :::info -Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. +External Notification module config is not available for the Web UI. ::: - + + +:::tip +Once module settings are changed, a **reset** is required for them to take effect. +::: \ No newline at end of file diff --git a/docs/settings/moduleconfig/range-test.mdx b/docs/settings/moduleconfig/range-test.mdx index ca5935ac..847539c1 100644 --- a/docs/settings/moduleconfig/range-test.mdx +++ b/docs/settings/moduleconfig/range-test.mdx @@ -50,7 +50,7 @@ Range Test features are available for Android. :::info -Range test module config is not yet available on Apple OS's. +All range test module config options are available on iOS, iPadOS and macOS at Settings > Modules > Range Test. ::: diff --git a/docs/settings/moduleconfig/serial.mdx b/docs/settings/moduleconfig/serial.mdx index 691f24e3..3fcf550c 100644 --- a/docs/settings/moduleconfig/serial.mdx +++ b/docs/settings/moduleconfig/serial.mdx @@ -63,7 +63,7 @@ defaultValue="flasher" values={[ {label: 'Android', value: 'android'}, {label: 'Apple', value: 'apple'}, -{label: 'Command Line', value: 'cli'}, +{label: 'CLI', value: 'cli'}, {label: 'Flasher', value: 'flasher'}, {label: 'Web', value: 'web'}, ]}> @@ -77,7 +77,7 @@ Serial module config is not available for Android. :::info -Serial module config is not yet available on Apple OS's. +All serial module config options are available on iOS, iPadOS and macOS at Settings > Modules > Serial. :::