7.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. It also requires use of the Rotary Encoder Plugin to configure the input source. :::
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.
:::tip 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
Prerequisites
- Attach a compatible peripheral device. Take note of the GPIO numbers you use, as they will be used in the following step.
- Once attached, configure peripheral device with Rotary Encoder Plugin Settings.
:::note
Replace each GPIO (x3) below with the GPIO numbers from hardware setup.
meshtastic --set rotary1_pin_a GPIO
meshtastic --set rotary1_pin_b GPIO
meshtastic --set rotary1_pin_press GPIO
meshtastic --set rotary1_event_cw KEY_UP
meshtastic --set rotary1_event_ccw KEY_DOWN
meshtastic --set rotary1_event_press KEY_SELECT
meshtastic --set rotary1_enabled True
::: That's it! With a functioning and enabled rotary encoder, you're ready to begin configuring the Canned Message Plugin.
Examples
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 canned_message_plugin_enabled true
meshtastic --set canned_message_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. :::
Set canned messages
<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>
meshtastic --set canned_message_plugin_messages "I'm fine|I'm out|I'm back|Need helping hand|Help me with saw|I need an alpinist|I need ambulance|Keep Calm|On my way|I will be late|I'm already waiting|We have company|Beer is cold|Roger"
:::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. :::
Enable/Disable bell character
<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>
meshtastic --set canned_message_plugin_send_bell true
meshtastic --set canned_message_plugin_send_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. :::
Set input source
<Tabs groupId="settings" defaultValue="cli" values={[ {label: 'CLI', value: 'cli'}, {label: 'Android', value: 'android'}, {label: 'iOS', value: 'iOS'}, {label: 'Web', value: 'web'}, ]}>
meshtastic --set canned_message_plugin_allow_input_source "_any"
meshtastic --set canned_message_plugin_allow_input_source "rotEnc1"
:::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. :::