Skip to main content

External Notification Plugin Settings

danger

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

SettingAcceptable ValuesDefault
ext_notification_plugin_activetrue, falsefalse
ext_notification_plugin_alert_belltrue, falsefalse
ext_notification_plugin_alert_messagetrue, falsefalse
ext_notification_plugin_enabledtrue, falsefalse
ext_notification_plugin_outputinteger0
ext_notification_plugin_output_msinteger (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

GPIO active high
meshtastic --set ext_notification_plugin_active true
GPIO active low (default)
meshtastic --set ext_notification_plugin_active false

ext_notification_plugin_alert_bell

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

Enable/Disable alert on incoming bell

Enable alert on incoming bell
meshtastic --set ext_notification_plugin_alert_bell true
Disable alert on incoming bell
meshtastic --set ext_notification_plugin_alert_bell false

ext_notification_plugin_alert_message

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

Enable/Disable Alert on incoming message

Enable alert on incoming message
meshtastic --set ext_notification_plugin_alert_message true
Disable alert on incoming message
meshtastic --set ext_notification_plugin_alert_message false

ext_notification_plugin_enabled

Enables the plugin.

Enable/Disable the plugin

Enable / Disable Plugin
meshtastic --set ext_notification_plugin_enabled true
meshtastic --set ext_notification_plugin_enabled false

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

note

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

Specify GPIO that circuit is connected to
meshtastic --set ext_notification_plugin_output GPIO

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

Set to default (1000ms)
meshtastic --set ext_notification_plugin_output_ms 0
Set to other value
meshtastic --set ext_notification_plugin_output_ms 1500