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

314 lines
8.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';
2022-01-28 14:53:32 -08:00
<!--- 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.
:::
## 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_active | `true`, `false` | `false` |
| ext_notification_plugin_alert_bell | `true`, `false` | `false` |
| ext_notification_plugin_alert_message | `true`, `false` | `false` |
2022-02-02 09:58:56 -08:00
| ext_notification_plugin_enabled | `true`, `false` | `false` |
2021-05-03 13:12:29 -07:00
| 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
2022-02-02 11:46:12 -08:00
### ext_notification_plugin_active
2021-05-03 13:12:29 -07:00
2022-02-02 11:46:12 -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
2022-02-02 11:46:12 -08:00
#### Specify High/Low GPIO triggers circuit
2021-05-05 09:18:44 -07:00
<Tabs
groupId="settings"
defaultValue="cli"
values={[
{label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'},
2022-01-28 14:54:03 -08:00
{label: 'iOS', value: 'iOS'},
{label: 'Web', value: 'web'},
2021-05-05 09:18:44 -07:00
]}>
<TabItem value="cli">
2022-02-02 11:46:12 -08:00
```bash title="GPIO active high"
meshtastic --set ext_notification_plugin_active true
2022-01-28 14:54:03 -08:00
```
2022-02-02 11:46:12 -08:00
```bash title="GPIO active low (default)"
meshtastic --set ext_notification_plugin_active false
2022-01-28 14:54:03 -08:00
```
</TabItem>
<TabItem value="android">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="iOS">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="web">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
</Tabs>
2022-02-02 11:46:12 -08:00
### ext_notification_plugin_alert_bell
2022-02-02 11:46:12 -08:00
Specifies if an alert should be sent when receiving an incoming bell.
2022-02-02 11:46:12 -08:00
#### Enable/Disable alert on incoming bell
2022-01-28 14:54:03 -08:00
<Tabs
groupId="settings"
defaultValue="cli"
values={[
{label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'},
{label: 'iOS', value: 'iOS'},
{label: 'Web', value: 'web'},
]}>
<TabItem value="cli">
2022-02-02 11:46:12 -08:00
```bash title="Enable alert on incoming bell"
meshtastic --set ext_notification_plugin_alert_bell true
```
2022-02-02 11:46:12 -08:00
```bash title="Disable alert on incoming bell"
meshtastic --set ext_notification_plugin_alert_bell false
2022-01-28 14:54:03 -08:00
```
</TabItem>
<TabItem value="android">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="iOS">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="web">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
</Tabs>
2022-02-02 11:46:12 -08:00
### ext_notification_plugin_alert_message
2022-01-28 14:54:03 -08:00
2022-02-02 11:46:12 -08:00
Specifies if an alert should be sent when receiving an incoming message.
2022-02-02 11:46:12 -08:00
#### Enable/Disable Alert on incoming message
2022-01-28 14:54:03 -08:00
<Tabs
groupId="settings"
defaultValue="cli"
values={[
{label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'},
{label: 'iOS', value: 'iOS'},
{label: 'Web', value: 'web'},
]}>
<TabItem value="cli">
2022-02-02 11:46:12 -08:00
```bash title="Enable alert on incoming message"
meshtastic --set ext_notification_plugin_alert_message true
2022-01-28 14:54:03 -08:00
```
2022-02-02 11:46:12 -08:00
```bash title="Disable alert on incoming message"
meshtastic --set ext_notification_plugin_alert_message false
2022-01-28 14:54:03 -08:00
```
</TabItem>
<TabItem value="android">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="iOS">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="web">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
</Tabs>
2022-02-02 11:46:12 -08:00
### ext_notification_plugin_enabled
2022-02-02 11:46:12 -08:00
Enables the plugin.
2021-05-05 09:18:44 -07:00
2022-02-02 11:46:12 -08:00
#### Enable/Disable the plugin
2022-01-28 14:54:03 -08:00
<Tabs
groupId="settings"
defaultValue="cli"
values={[
{label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'},
{label: 'iOS', value: 'iOS'},
{label: 'Web', value: 'web'},
]}>
<TabItem value="cli">
2022-02-02 11:46:12 -08:00
```bash title="Enable Plugin"
meshtastic --set ext_notification_plugin_enabled true
2022-01-28 14:54:03 -08:00
```
2022-02-02 11:46:12 -08:00
```bash title="Disable Plugin"
meshtastic --set ext_notification_plugin_enabled false
2022-01-28 14:54:03 -08:00
```
</TabItem>
<TabItem value="android">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="iOS">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="web">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
</Tabs>
### ext_notification_plugin_output
Specifies the GPIO that your external circuit is attached to on the device.
#### Specify GPIO for circuit to monitor
2022-01-28 14:54:03 -08:00
<Tabs
groupId="settings"
defaultValue="cli"
values={[
{label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'},
{label: 'iOS', value: 'iOS'},
{label: 'Web', value: 'web'},
]}>
<TabItem value="cli">
:::note
Replace `GPIO` in the below command with the GPIO number your circuit is attached to.
:::
```bash title="Specify GPIO that circuit is connected to"
meshtastic --set ext_notification_plugin_output GPIO
2022-01-28 14:54:03 -08:00
```
2021-05-05 09:18:44 -07:00
</TabItem>
<TabItem value="android">
2022-01-28 14:54:03 -08:00
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="iOS">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="web">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
</Tabs>
### ext_notification_plugin_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`)
2022-01-28 14:54:03 -08:00
#### Specify how many milliseconds to trigger circuit
2022-01-28 14:54:03 -08:00
<Tabs
groupId="settings"
defaultValue="cli"
values={[
{label: 'CLI', value: 'cli'},
{label: 'Android', value: 'android'},
{label: 'iOS', value: 'iOS'},
{label: 'Web', value: 'web'},
]}>
<TabItem value="cli">
```bash title="Set to default (1000ms)"
meshtastic --set ext_notification_plugin_output_ms 0
2022-01-28 14:54:03 -08:00
```
```bash title="Set to other value"
meshtastic --set ext_notification_plugin_output_ms 1500
2022-01-28 14:54:03 -08:00
```
</TabItem>
<TabItem value="android">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="iOS">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
</TabItem>
<TabItem value="web">
:::info
Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page.
:::
2021-05-05 09:18:44 -07:00
</TabItem>
</Tabs>
## Details
<!--- TODO --->