From 7198f70f8afcd74dfa6daa3e1c635d3030878474 Mon Sep 17 00:00:00 2001 From: Hays Chan <25737801+hayschan@users.noreply.github.com> Date: Mon, 9 Dec 2024 10:34:11 +0800 Subject: [PATCH] fix(docs): Correct rotary encoder event commands in Canned Message Module Documentation (#1618) * fix(docs): correct rotary encoder event commands in Canned Message Module Updated the example commands for configuring rotary encoder events in the Canned Message Module documentation. Replaced incorrect values `KEY_UP`, `KEY_DOWN`, and `KEY_SELECT` with the correct enum values `UP`, `DOWN`, and `SELECT`. Included an example error message to guide users in troubleshooting incorrect configurations. * correct other examples --------- Co-authored-by: rcarteraz --- docs/configuration/module/canned-message.mdx | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/configuration/module/canned-message.mdx b/docs/configuration/module/canned-message.mdx index 9f697b48..8987e0a2 100644 --- a/docs/configuration/module/canned-message.mdx +++ b/docs/configuration/module/canned-message.mdx @@ -192,17 +192,17 @@ 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 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 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 SELECT meshtastic --set canned_message.inputbroker_event_press "" ``` @@ -316,9 +316,9 @@ Replace each `GPIO` (x3) below with the GPIO numbers from your hardware setup. meshtastic --set canned_message.inputbroker_pin_a GPIO meshtastic --set canned_message.inputbroker_pin_b GPIO meshtastic --set canned_message.inputbroker_pin_press GPIO -meshtastic --set canned_message.inputbroker_event_cw KEY_UP -meshtastic --set canned_message.inputbroker_event_ccw KEY_DOWN -meshtastic --set canned_message.inputbroker_event_press KEY_SELECT +meshtastic --set canned_message.inputbroker_event_cw UP +meshtastic --set canned_message.inputbroker_event_ccw DOWN +meshtastic --set canned_message.inputbroker_event_press SELECT meshtastic --set canned_message.rotary1_enabled True ```