mudhorn/meshtastic
1
0
Fork 0
mirror of https://github.com/meshtastic/meshtastic.git synced 2024-12-25 05:34:11 -08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

fix(docs): Correct rotary encoder event commands in Canned Message Module Documentation (#1618)

Browse source 
* 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 <robert.l.carter2@gmail.com>
This commit is contained in:
Hays Chan 2024-12-09 10:34:11 +08:00 committed by GitHub
parent fcfcef1d54
commit 7198f70f8a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/configuration/module/canned-message.mdx
View file

@ -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
```