Canned/Quick Messages (WIP).

[gjelsoe]

Canned/Quick Messages for MeshCore

Working Canned/Quick message module for MeshCore - try it here:
https://github.com/gjelsoe/MeshCore/tree/Bandit_canned_message

Special Characters Support:
Add -D USE_CP437 to your build_flags for Scandinavian, German, French, Spanish, Currency and other symbols (Line 136-405 in DisplayDriver.h and make sure that your Display supports it)

---

Canned Messages Configuration

Messages are stored in /canned.txt on the device filesystem. You can edit this file via:

• CLI commands (recommended - see below)
• Direct file editing if you have filesystem access

File format: One message per line, maximum 20 messages, 40 characters each.

Example /canned.txt:

Help
On my way
Yes
No
Roger that
10-4
Location?
Call me
Busy
Available

First Boot: If no /canned.txt file exists, the screen will show a placeholder message prompting you to add messages via CLI commands.

---

CLI Commands

You can manage canned messages via the rescue CLI:

List all messages

canned list

Shows all currently loaded messages with their index numbers.

Add a new message

canned add Your message here

Adds a new message to the end of the list (max 40 characters). Quote marks are optional.

Delete a message

canned del 5

Deletes the message at index 5 (use canned list to see indices).

Reload from file

canned reload

Reloads messages from /canned.txt into the running UI (useful after manual file editing).

Example workflow:

canned list              # See current messages
canned add Emergency!    # Add new message (no quotes needed)
canned del 0             # Remove first message  
canned reload            # Reload into UI

Note: add and del commands automatically save changes to /canned.txt. Use reload to refresh the UI after manually editing the file.

---

Hardware Setup

Add to your platformio.ini for your device. Choose ONE input method:

Option 1: Rotary Encoder

build_flags = 
  -D USE_ENCODER
  -D PIN_ENCODER_CLK=40  ; CLK/A pin
  -D PIN_ENCODER_DT=41   ; DT/B pin
  -D PIN_ENCODER_SW=39   ; Button pin

Option 2: Analog Joystick

build_flags = 
  -D PIN_USER_JOYSTICK=39

(Radiomaster Bandit series only - enabled by default)

Option 3: Single Button

build_flags = 
  -D PIN_USER_BTN=0  ; Replace with your button pin

(Already defined for many devices)

---

Canned Messages Configuration

Add within the [] brackets of your device's companion tags in platformio.ini:

; Canned Messages rules:
; - Maximum 20 messages
; - Each message maximum 40 characters
build_flags = 
  -D USE_CANNED_MESSAGE

Example Configuration:

[env:Heltec_v3_companion_radio_ble]
build_flags = 
  ${env.build_flags}
  -D USE_ENCODER
  -D PIN_ENCODER_CLK=40
  -D PIN_ENCODER_DT=41
  -D PIN_ENCODER_SW=39
  -D USE_CANNED_MESSAGE

---

Controls

Rotary Encoder Controls

Navigation

• Rotate Clockwise - Next item (channel/message)
• Rotate Counter-Clockwise - Previous item (channel/message)
• Press Button - Select current item

Screen Flow

1. Channel Selection

• Rotate to browse channels
• "Back to Home" appears at end of list
• Press to select channel or go home

2. Message Selection

• Rotate to browse messages
• "Back to Channels" appears at end of list
• Press to select message or go back

3. Send Confirmation

• Rotate to toggle between "Send" and "Back"
• Currently selected option is highlighted
• Press to execute (send message or cancel)

---

Single Button Controls

Navigation

• Single Click - Next item
• Long Press (1.2s) - Select current item

Screen Flow

1. Channel Selection

• Click to cycle through channels + "Back to Home"
• Long press to select

2. Message Selection

• Click to cycle through messages + "Back to Channels"
• Long press to select

3. Send Confirmation

• Single Click - Cancel and go back
• Long Press - Send message

---

Joystick Controls

Navigation

• Up/Down - Previous/Next item
• Enter - Select current item
• Left - Go back

Screen Flow

1. Channel Selection

• Up/Down to browse channels
• Enter to select, Left to exit home

2. Message Selection

• Up/Down to browse messages
• Enter to select, Left to go back

3. Send Confirmation

• Up - Send message
• Down - Cancel
• Left - Go back

---

Troubleshooting

General Issues

Messages too long warning:

• Keep messages under 40 characters
• Messages over 40 chars are automatically skipped

Can't enter Canned Messages screen:

• Ensure USE_CANNED_MESSAGE is defined
• Check gotoCannedMessagesScreen() is called in UITask
• Verify button/encoder events are reaching UITask::loop()

---

Hardware Compatibility

Tested Boards:

• Heltec WiFi LoRa 32 V3 (ESP32-S3) (With single button and rotary encoder: Heltec_v3_companion_radio_ble_canned)
• Radiomaster 900 Bandit (with joystick)

Should work on:

• Most ESP32 variants (ESP32, ESP32-S2, ESP32-S3, ESP32-C3)
• nRF52 boards

---

Credits

Rotary encoder implementation inspired by:
https://www.hackster.io/Adrelien/how-to-setup-canned-pre-defined-messages-with-rotary-kno-df8139

Claude Code AI:
https://claude.ai/

[gjelsoe]

Updated Canned/Quick Messages to use CLI Rescue for managing the messages and they are stored on the device.
See the first post for info.