Flags

Patterns

• Key Events

• Touch Events

• Flags and Patterns

• Colors

• Screen size

There are two types of color constants: one that is an index into a table holding a palette of theme colors, and one that is just a color.

Indexed colors

These are the theme colors plus CUSTOM_COLOR, and they can be changed with the function lcd.setColor(color_index, color). Please note: if an indexed color is changed, then it changes everywhere that it is used. For the theme colors, this is not only in other widgets, but everywhere throughout the radio's user interface!

• COLOR_THEME_PRIMARY1

• COLOR_THEME_PRIMARY2

• COLOR_THEME_PRIMARY3

• COLOR_THEME_SECONDARY1

• COLOR_THEME_SECONDARY2

• COLOR_THEME_SECONDARY3

• COLOR_THEME_FOCUS

• COLOR_THEME_EDIT

• COLOR_THEME_ACTIVE

• COLOR_THEME_WARNING

• COLOR_THEME_DISABLED

• CUSTOM_COLOR

Literal colors

These color constants cannot be changed:

• BLACK

• WHITE

• LIGHTWHITE

• YELLOW

• BLUE

• DARKBLUE

• GREY

• DARKGREY

• LIGHTGREY

• RED

• DARKRED

• GREEN

• DARKGREEN

• LIGHTBROWN

• DARKBROWN

• BRIGHTGREEN

• ORANGE

Deprecated color constants

These should no longer be used, but they are included for backwards compatibility. The old OpenTX API had a large number of indexed theme colors, and these have been mapped to the new theme colors as follows:

• ALARM_COLOR -> COLOR_THEME_WARNING

• BARGRAPH_BGCOLOR -> COLOR_THEME_SECONDARY3

• BARGRAPH1_COLOR -> COLOR_THEME_SECONDARY1

• BARGRAPH2_COLOR -> COLOR_THEME_SECONDARY2

• CURVE_AXIS_COLOR -> COLOR_THEME_SECONDARY2

• CURVE_COLOR -> COLOR_THEME_SECONDARY1

• CURVE_CURSOR_COLOR -> COLOR_THEME_WARNING

• HEADER_BGCOLOR -> COLOR_THEME_FOCUS

• HEADER_COLOR -> COLOR_THEME_SECONDARY1

• HEADER_CURRENT_BGCOLOR -> COLOR_THEME_FOCUS

• HEADER_ICON_BGCOLOR -> COLOR_THEME_SECONDARY1

• LINE_COLOR -> COLOR_THEME_PRIMARY3

• MAINVIEW_GRAPHICS_COLOR -> COLOR_THEME_SECONDARY1

• MAINVIEW_PANES_COLOR -> COLOR_THEME_PRIMARY2

• MENU_TITLE_BGCOLOR -> COLOR_THEME_SECONDARY1

• MENU_TITLE_COLOR -> COLOR_THEME_PRIMARY2

• MENU_TITLE_DISABLE_COLOR -> COLOR_THEME_PRIMARY3

• OVERLAY_COLOR -> COLOR_THEME_PRIMARY1

• SCROLLBOX_COLOR -> COLOR_THEME_SECONDARY3

• TEXT_BGCOLOR -> COLOR_THEME_SECONDARY3

• TEXT_COLOR -> COLOR_THEME_SECONDARY1

• TEXT_DISABLE_COLOR -> COLOR_THEME_DISABLED

• TEXT_INVERTED_BGCOLOR -> COLOR_THEME_FOCUS

• TEXT_INVERTED_COLOR -> COLOR_THEME_PRIMARY2

• TITLE_BGCOLOR -> COLOR_THEME_SECONDARY1

• TRIM_BGCOLOR -> COLOR_THEME_FOCUS

• TRIM_SHADOW_COLOR -> COLOR_THEME_PRIMARY1

• WARNING_COLOR -> COLOR_THEME_WARNING

The following touch events are passed in the event argument to the widget script refresh function (when in full screen mode), just like the key events. The following touch events are provided:

In addition to the above touch events a touchState table is passed to refresh with the following addional data fields:

Notes:

• touchState is nil if event is not a touch event. This can be used to test if we have a touch event or a key event.

  • Since Lua evaluates a nil value to false and everything else to true:

  • if touchState then we have a touch event.

• x, y are present for all touch events.

• startX, startY, slideX, slideY are only present with EVT_TOUCH_SLIDE.

• swipeUp / swipeDown / swipeLeft / swipeRight may be present only withEVT_TOUCH_SLIDE.

The key event mechanism

Each time a key is pressed, held and released a number of events get generated. Here is a typical flow:

• when a key is pressed a FIRST event is generated

• if the key continues to be pressed, then after a while a LONG event is generated

• if the key continues to be pressed, then a REPEAT events are being generated

• when the key is released a BREAK event is generated

Couple of examples:

• a short press on key would generate: FIRST, BREAK

• a longer pres on key would generate: FIRST, LONG, BREAK

• even longer press: FIRST, LONG, REPEAT,REPEAT, ..., BREAK

This normal key event sequence can be altered with the function. Any time this function is called (after the FIRST event) all further key events for this key will be suppressed until the next key press of this key. Examples:

• kill immediately after the key press would generate: FIRST

• kill after the long key press would generate: FIRST, LONG

Constants

The event parameter in the and scripts run function actually carries two pieces of information:

• key number

• type of event

The two fields are combined into one single number. Some of these combinations are defined as constants and are available to Lua scripts:

Radios with rotary encoder (X7 and Horus) have also:

Virtual events

Given the large number of radios supported by OpenTX, and the large difference in keys available on those, a set of VIRTUAL KEYS has been defined and are mapped to best fit available hardware