meshtastic/docs/settings/moduleconfig/canned-message.mdx

---
id: canned-message
title: Canned Message Module Configuration
sidebar_label: Canned Message
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

The Canned Message Module 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.

The canned message module config options are: Enabled, Save, and Sender.  Range Test Module config uses an admin message sending a `ConfigModule.CannedMessage` protobuf.

## Canned Message Module Config Values

### Enabled

Enables the canned message module.

### Send Bell

Sends a bell character with each message.

The [External Notification Module](external-notification) can be set up to beep when a new message arrives.
This module can also be configured to beep only when message contains the bell character. 

### Messages

The list of pre-set messages, up to 200 bytes.

### Input Source

Input event sources accepted by the canned message module.

|   Value      |                            Description                                  |
| :----------: | :---------------------------------------------------------------------: |
|  `_any`      |    Default. Allows any peripheral input device connected to the device.                                                                                  |
| `rotEnc1`    | Basic Rotary Encoder |
| `upDownEnc1` | Up Down Encoder  |
| `cardkb`     | M5 Stack CardKB (Discontinued) |
| `faceskb`    | M5 Stack Faces KB |

### Rotary Encoder Enabled

Enable the default rotary encoder.

### Up Down Encoder Enabled

Enable the up / down encoder.

### Input Broker Pin A

GPIO Pin Value (1-39) For encoder port A

### Input Broker Pin B

GPIO Pin Value (1-39) For encoder port B

### Input Broker Pin Press

GPIO Pin Value (1-39) For encoder Press port

### Input Broker Event CW

Generate input event on CW of this kind.

### Input Broker Event CCW

Generate input event on CCW of this kind.

### Input Broker Event Press

Generate input event on Press of this kind.

## Canned Message Module Config Client Availability

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

:::info
Canned Message module config is not available for Android.
:::

</TabItem>
<TabItem value="apple">

:::info
All canned message module config options are available on iOS, iPadOS and macOS at Settings > Modules > Canned Messages.
:::

</TabItem>
<TabItem value="cli">

:::info
All canned message module config options are available in the python CLI. 
:::

Example commands are below:

|                 Setting                  | Acceptable Values | Default       |
| :--------------------------------------: | :---------------: | :-----------: |
|      canned_message.enabled              |  `true`, `false`  |     `false`   |
|     canned_message.send_bell             |  `true`, `false`  |     `false`   |
| canned_message.allow_input_source        | `rotEnc1`, `_any`, `upDownEnc1`, `cardkb`, `faceskb`  | `_any`  |
|        canned_message.messages           |     `string`      |      `""`     |
|               (Messages)\*               |     `string`      |      `""`     |
|  canned_message.inputbroker_event_cw     | `InputEventChar`  | (not defined) |
|  canned_message.inputbroker_event_ccw    | `InputEventChar`  | (not defined) |
| canned_message.inputbroker_event_press   | `InputEventChar`  | (not defined) |
|    canned_message.inputbroker_pin_a      |     `integer`     | (not defined) |
|    canned_message.inputbroker_pin_b      |     `integer`     | (not defined) |
|  canned_message.inputbroker_pin_press    |     `integer`     | (not defined) |

```shell title="Enable/Disable the Canned Message Module"
meshtastic --set canned_message.enabled true
meshtastic --set canned_message.enabled false
```

```shell title="Enable/Disable send bell character"
meshtastic --set canned_message.send_bell true
meshtastic --set canned_message.send_bell false
```

```shell title="Set Messages"
meshtastic --set-canned-message "I need an alpinist!|Call Me|Roger Roger|Keep Calm|On my way|"
```

```shell title="Set Input Source"
meshtastic --set canned_message.allow_input_source "_any"
meshtastic --set canned_message.allow_input_source "rotEnc1"
```

```shell title="Enable/Disable rotary1"
meshtastic --set 
```

```shell title="Set/Unset Encoder Pin A"
meshtastic --set canned_message.inputbroker_pin_a 17
meshtastic --set canned_message.inputbroker_pin_a 0
```

```shell title="Set/Unset Encoder Pin B"
meshtastic --set canned_message.inputbroker_pin_b 39
meshtastic --set canned_message.inputbroker_pin_b 0
```

```shell title="Set/Unset Encoder Pin Press"
meshtastic --set canned_message.inputbroker_pin_press 21
meshtastic --set canned_message.inputbroker_pin_press 0
```

```shell title="Set/Unset Input Broker CW Event"
meshtastic --set canned_message.inputbroker_event_cw KEY_UP
meshtastic --set canned_message.inputbroker_event_cw ""
```

```shell title="Set/Unset Input Broker CCW Event"
meshtastic --set canned_message.inputbroker_event_ccw KEY_DOWN
meshtastic --set canned_message.inputbroker_event_ccw ""
```

```shell title="Set/Unset Input Broker Press Event"
meshtastic --set canned_message.inputbroker_event_press KEY_SELECT
meshtastic --set canned_message.inputbroker_event_press ""
```
</TabItem>
<TabItem value="flasher">

:::info
No canned message test module config options are available in the Flasher.
:::

  </TabItem>
  <TabItem value="web">

:::info
All canned message module config options are available in the Web UI.
:::
    
  </TabItem>
</Tabs>

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

This module requires attaching a peripheral accessory to your device. It will not work without one.
:::

## Hardware

To navigate through messages and select one, you will require some hardware attached to your device. Currently, the module is tested with a generic rotary encoder, but this is not a limitation further input methods can be added in the future.

### Rotary encoder

Meshtastic supports hardwired rotary encoders as input devices. (Technically the Canned Message Module is independent of rotary encoders. It is described here, because no other module utilizes rotary encoders just yet.)

You will need a generic rotary encoder. The types listed below has five legs where two is dedicated to a "press" action, but any other types will likely do the job. You can also use a three-legged version, where the "press" action should be wired from an independent switch.

<!--- TODO move links to hardware section --->

- [Amazon link](https://www.amazon.com/Rotary-Encoder-Washers-Digital-Potentiometer/dp/B07Y619CZR/ref=sr_1_21?keywords=rotary+encoder&qid=1642317807&sprefix=rotary+enco%2Caps%2C186&sr=8-21)
- [Amazon.DE link](https://www.amazon.de/-/en/sourcing-Degree-Rotary-Encoder-Digital/dp/B07RLZPX5K/ref=sr_1_12?keywords=rotary+encoder&qid=1642320025&sprefix=rotary%2Caps%2C105&sr=8-12)
- [Aliexpress link1](https://www.aliexpress.com/item/32992227812.html?spm=a2g0o.productlist.0.0.1afe21a50SLvi2&algo_pvid=a19c4182-08aa-406d-bfdf-132582ef5ebb&algo_exp_id=a19c4182-08aa-406d-bfdf-132582ef5ebb-23&pdp_ext_f=%7B%22sku_id%22%3A%2266940265509%22%7D&pdp_pi=-1%3B1.66%3B-1%3B-1%40salePrice%3BUSD%3Bsearch-mainSearch)
- [Aliexpress link2](https://www.aliexpress.com/item/32946444853.html?spm=a2g0o.productlist.0.0.1afe21a50SLvi2&algo_pvid=a19c4182-08aa-406d-bfdf-132582ef5ebb&aem_p4p_detail=2022011523263276283624312400022072680&algo_exp_id=a19c4182-08aa-406d-bfdf-132582ef5ebb-6&pdp_ext_f=%7B%22sku_id%22%3A%2266223434642%22%7D&pdp_pi=-1%3B1.91%3B-1%3B-1%40salePrice%3BUSD%3Bsearch-mainSearch)
- [Aliexpress link3](https://www.aliexpress.com/item/10000056483250.html?spm=a2g0o.productlist.0.0.1afe21a50SLvi2&algo_pvid=a19c4182-08aa-406d-bfdf-132582ef5ebb&algo_exp_id=a19c4182-08aa-406d-bfdf-132582ef5ebb-9&pdp_ext_f=%7B%22sku_id%22%3A%2220000000116682147%22%7D&pdp_pi=-1%3B2.51%3B-1%3B-1%40salePrice%3BUSD%3Bsearch-mainSearch)

Connect your rotary encoder as follows. The rotary encoder has two rows of legs. One of the rows contains two legs, the other contains three legs. Bottom side view:

```
  B o --- o PRESS
GND o | |
  A o --- o GND
```

The two legs is to sense the press action (or push). Connect one of the two to GROUND and the other to a GPIO pin. (No matter which one goes where.) Let's call this connected ports 'PRESS'.

The three legs is to sense the rotation action. Connect the middle leg to GROUND and the ones on the side to GPIO pins. Let's call these ports 'A' and 'B', according to the scheme below.

```
A   --||
GND --||]========
B   --||
```

Recommended GPIO pins for connecting a rotary encoder.

- TTGO LoRa V1:
  - A - GPIO-22
  - B - GPIO-23
  - PRESS - GPIO-21

There is a reference case 3D-design utilizing the rotary encoder for TTGO LoRa V1:
[Case for TTGO-ESP32-LORA-OLED-v1.0 with rotary encoder](https://www.thingiverse.com/thing:5178495)


## Examples

- Attach a compatible peripheral device. Take note of the GPIO numbers you use, as they will be used in the following step.

:::note
Replace each `GPIO` (x3) below with the GPIO numbers from your hardware setup.
:::

```shell title="Canned Message Module - Required Rotary Encoder Module Settings"
meshtastic --set canned_message.rotary1_pin_a GPIO
meshtastic --set canned_message.rotary1_pin_b GPIO
meshtastic --set canned_message.rotary1_pin_press GPIO
meshtastic --set canned_message.rotary1_event_cw KEY_UP
meshtastic --set canned_message.rotary1_event_ccw KEY_DOWN
meshtastic --set canned_message.rotary1_event_press KEY_SELECT
meshtastic --set canned_message.rotary1_enabled True
```


That's it! With a functioning and enabled rotary encoder, you're ready to begin configuring the Canned Message Module.