2.1 KiB
| id | title | sidebar_label |
|---|---|---|
| canned-message-plugin | Canned Message Plugin | Canned Message Plugin |
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';
:::note This plugin requires attaching a peripheral accessory to your device. It will not work without one. :::
Overview
The CannedMessage Plugin will allow you to send messages to the mesh network from the device without using the phone app. You can predefine text messages to choose from.
Please also follow settings of the Rotary Encoder Plugin to configure input source!
:::note Once plugin settings are changed, a reset is required for them to take effect. :::
Settings
| Setting | Acceptable Values | Default |
|---|---|---|
| canned_message_plugin_enabled | true, false |
false |
| canned_message_plugin_allow_input_source | rotEnc1, _any |
_any |
| canned_message_plugin_messages | string |
"" |
| canned_message_plugin_send_bell | true, false |
false |
canned_message_plugin_enabled
Enables the plugin.
canned_message_plugin_allow_input_source
Input event source accepted by the canned message plugin.
| Value | Description |
|---|---|
_any |
Default. Allows any peripheral input device connected to the device. |
rotEnc1 |
Hardcoded value naming the input device that this plugin listens to. This could allow multiple input devices to be named with future software development. At present, this doesn't do anything differently than the default setting. |
canned_message_plugin_messages
Predefined messages for CannedMessagePlugin separated by | characters.
You can define up to 50 messages with a total length 1024 bytes.
canned_message_plugin_send_bell
CannedMessagePlugin also sends a bell character with the messages. The External Notification Plugin can benefit from this feature as it utilizes the bell character.
Details
See "Software / Plugins / Canned messages" for details!
Examples
See "Software / Plugins / Canned messages" for examples!