meshtastic/docs/software/settings/external-notification-plugin.md
2022-01-02 23:53:45 -07:00

73 lines
1.4 KiB
Markdown

---
id: external-notification-plugin
title: External Notification Plugin Settings
sidebar_label: External Notification Plugin
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
## Overview
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.
## Settings
| 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` |
| ext_notification_plugin_output_ms | `integer` | `0` |
### ext_notification_plugin_enabled
Enables the plugin.
### ext_notification_plugin_active
<!--- TODO --->
### ext_notification_plugin_alert_bell
<!--- TODO --->
### ext_notification_plugin_alert_message
<!--- TODO --->
### ext_notification_plugin_output
<!--- TODO --->
### ext_notification_plugin_output_ms
<!--- TODO --->
## Details
<!--- TODO --->
## Examples
<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>