meshtastic/docs/software/settings/external-notification-plugin.md

77 lines
2 KiB
Markdown
Raw Normal View History

---
id: external-notification-plugin
title: External Notification Plugin Settings
sidebar_label: External Notification Plugin
---
2021-05-05 09:18:44 -07:00
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
## Overview
2022-01-02 22:53:45 -08:00
The External Notification Plugin will allow you to connect a speaker, LED, or other device to notify you when a message has been received from the mesh network.
2022-01-28 10:11:19 -08:00
:::tip
2022-01-27 20:32:18 -08:00
Once plugin settings are changed, a **reset** is required for them to take effect.
:::
## Settings
2021-05-03 13:12:29 -07:00
| Setting | Acceptable Values | Default |
| :-----: | :---------------: | :-----: |
| ext_notification_plugin_enabled | `true`, `false` | `false` |
| ext_notification_plugin_active | `true`, `false` | `false` |
| ext_notification_plugin_alert_bell | `true`, `false` | `false` |
| ext_notification_plugin_alert_message | `true`, `false` | `false` |
| ext_notification_plugin_output | `integer` | `0` |
2022-01-27 20:32:18 -08:00
| ext_notification_plugin_output_ms | `integer` (milliseconds) | `0` |
2021-05-03 13:12:29 -07:00
### ext_notification_plugin_enabled
2022-01-02 22:53:45 -08:00
Enables the plugin.
2021-05-03 13:12:29 -07:00
### ext_notification_plugin_active
2022-01-27 20:32:18 -08:00
Specifies whether the external circuit is triggered when the device's GPIO is low or high.
2021-05-03 13:12:29 -07:00
### ext_notification_plugin_alert_bell
2022-01-27 20:32:18 -08:00
Specifies if an alert should be sent when receiving an incoming bell.
2021-05-03 13:12:29 -07:00
### ext_notification_plugin_alert_message
2022-01-27 20:32:18 -08:00
Specifies if an alert should be sent when receiving an incoming message.
2021-05-03 13:12:29 -07:00
### ext_notification_plugin_output
2022-01-28 14:25:48 -08:00
Specifies the GPIO that your external circuit is attached to on the device.
2021-05-03 13:12:29 -07:00
### ext_notification_plugin_output_ms
2022-01-27 20:32:18 -08:00
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`)
## Details
2021-05-03 15:25:24 -07:00
2021-05-04 08:41:36 -07:00
<!--- TODO --->
2021-05-05 09:18:44 -07:00
## Examples
2021-05-04 08:41:36 -07:00
2021-05-05 09:18:44 -07:00
<Tabs
groupId="settings"
defaultValue="cli"
values={[
{label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'},
]}>
<TabItem value="cli">
TODO
</TabItem>
<TabItem value="android">
TODO
</TabItem>
</Tabs>