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

id	title	sidebar_label
external-notification-plugin	External Notification Plugin Settings	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. :::

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.

:::tip Once plugin settings are changed, a reset is required for them to take effect. :::

Settings

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
ext_notification_plugin_enabled	true, false	false
ext_notification_plugin_output	integer	0
ext_notification_plugin_output_ms	integer (milliseconds)	0

ext_notification_plugin_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

<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>

meshtastic --set ext_notification_plugin_active true

meshtastic --set ext_notification_plugin_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_plugin_alert_bell

Specifies if an alert should be sent when receiving an incoming bell.

Enable/Disable alert on incoming bell

<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>

meshtastic --set ext_notification_plugin_alert_bell true

meshtastic --set ext_notification_plugin_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_plugin_alert_message

Specifies if an alert should be sent when receiving an incoming message.

Enable/Disable Alert on incoming message

<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>

meshtastic --set ext_notification_plugin_alert_message true

meshtastic --set ext_notification_plugin_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_plugin_enabled

Enables the plugin.

Enable/Disable the plugin

<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>

meshtastic --set ext_notification_plugin_enabled true

meshtastic --set ext_notification_plugin_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_plugin_output

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. :::

Specify GPIO for circuit to monitor

<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>

:::note Replace GPIO in the below command with the GPIO number your circuit is attached to. :::

meshtastic --set ext_notification_plugin_output GPIO

:::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_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)

Specify how many milliseconds to trigger circuit

<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>

meshtastic --set ext_notification_plugin_output_ms 0

meshtastic --set ext_notification_plugin_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. :::

:::info Configuring this setting is not yet available for the selected platform. If this is incorrect please update the documentation for this page. :::