Verifying button press events

[stronnag]

LUA Button Event Tester for EdgeTX

Introduction

As a number of users appear to have some difficulty with getting button presses recognised e.g. for the INAV Lua Telemetry Script to invoke the Configuration Menu on some budget (i.e. cheap, not enough well defined hardware button) radios, the atteched script may help.

Usage

The attached script (events.lua) should be installed in the radio (or Companion) (sdcard) SCRIPTS directory. Note that due to Github rules, the scrip is compressed with gzip (events.lua.gz). It is necessary to unzip it e.g. gunzip events.lua.gz.

Companion

When run from Companion, the results may be examined in the "Debug Viewer"; it is recommended to enable a debug filter of /EVENT.

On the radio

When run from the radio, the results will be written to the VCP port in LUA mode:

• In the System Menu, Hardware, set the VCP port to LUA
• Set the System VCP connect action to Ask
• On plugging the USB cable, select VCP mode.
• On a host computer, you can visualise the output in a serial program; the example below uses mwptools cliterm application. Other options are (Linux) picocom or minicom. Other OS can use their preferred tool.
• Set the serial terminal for 115200 baud and CRLF (carriage return, line feed, \r\n) line terminator.

Running events.lua

• From the system menu, navigate to the file system tab
• Select the SCRIPTS directory
• Log press, select events.lua (or events.luac)
• From the menu, select Execute

Now you can press the hardware buttons and the result will be reported either in the debug console (Companion), or in the serial terminal (from the radio).

• The script will exit on LONG press of the RTN / EXIT key (a short press is reported)
• The button presses are reported as:
  • **EVENT** Event_Numeric_Id Key_Mnemonic
  • or for events not known to Lua
  • **EVENT** Event_Numeric_Id Unrecognised

Example Session

In the example serial session below, the button keys from a RadioMaster Boxer are shown, this also reports roller events. If the radio does not have a roller, EVT_VIRTUAL_DEC / EVT_VIRTUAL_INC may also be reported.

Comments on the actual button pressed have been added, preceded by a hash sign #.

$ cliterm -n -b 115200 /dev/ttyACM0
2023-07-26T16:24:55+0100 Registered serial device: /dev/ttyACM0 [0483:5740], Vendor: OpenTX, Model: Radiomaster_Boxer_Serial_Port, Serial: 00000000001B, Driver: cdc_acm
open /dev/ttyACM0
**EVENT** 34 Virtual Prev PAGE               # The Page Back button
**EVENT** 99 Unrecognised
**EVENT** 35 Virtual Next PAGE               # The Page Forward button
**EVENT** 4100 rotary encoder rotated right  # Rotate roller
**EVENT** 97 Unrecognised
**EVENT** 33 ENT key release
**EVENT** 97 Unrecognised
**EVENT** 129 ENT key long press             # Roller long press
**EVENT** 65 Unrecognised
**EVENT** 65 Unrecognised
**EVENT** 33 ENT key release                 # Roller long press released
**EVENT** 4100 rotary encoder rotated right  # Rotate roller
**EVENT** 101 Unrecognised
**EVENT** 133 Virtual MENU LONG              # MDL key, long press
**EVENT** 69 Unrecognised
**EVENT** 37 Virtual MENU                    # MDL key, short press
**EVENT** 101 Unrecognised
**EVENT** 37 Virtual MENU                    # MDL key, short press
**EVENT** 36 Unrecognised
**EVENT** 96 Unrecognised
**EVENT** 32 EXIT key release                # RTN / EXIT key, release after short press
**EVENT** 96 Unrecognised
**EVENT** 128 Unrecognised
                                             # RTN / EXIT key, long press, exits script

If your radio cannot provide either "Roller long press" or "Virtual MENU LONG", it is unlikely that you will be able to access the configuration menu in the INAV Lua Telemetry script. You might ask the firmware developer or vendor for assistance.

events.lua.gz