Constants¶
Global constants available to every Ethos Lua script. Use them by name, e.g. lcd.font(FONT_L) or system.getSource({category=CATEGORY_TELEMETRY_SENSOR, ...}).
Fonts¶
Used with lcd.font().
| Constant | Meaning |
|---|---|
FONT_M |
M Font |
FONT_M_BOLD |
M BOLD Font |
FONT_M_ITALIC |
M ITALIC Font |
FONT_XS |
XS Font |
FONT_XXS |
XXS Font |
FONT_XS_BOLD |
XS BOLD Font (not available on X18 and Horus) |
FONT_L_BOLD |
L BOLD Font (not available on X18 and Horus) |
FONT_S_BOLD |
S BOLD Font (not available on X18 and Horus) |
FONT_S |
S Font |
FONT_L |
L Font |
FONT_XL |
XL Font |
FONT_XXL |
XXL Font |
Theme colors¶
Used with lcd.themeColor() and lcd.color() so scripts follow the user's theme.
| Constant | Meaning |
|---|---|
THEME_DEFAULT_COLOR |
THEME_DEFAULT_COLOR (deprecated) |
THEME_DEFAULT_BGCOLOR |
THEME_DEFAULT_BGCOLOR (deprecated) |
THEME_FOCUS_BGCOLOR |
THEME_FOCUS_BGCOLOR (deprecated) |
THEME_FOCUS_COLOR |
THEME_FOCUS_COLOR (deprecated) |
THEME_PRIMARY_COLOR |
THEME_PRIMARY_COLOR |
THEME_PRIMARY_BGCOLOR |
THEME_PRIMARY_BGCOLOR |
THEME_SECONDARY_COLOR |
THEME_SECONDARY_COLOR |
THEME_SECONDARY_BGCOLOR |
THEME_SECONDARY_BGCOLOR |
THEME_HIGHLIGHT_COLOR |
THEME_HIGHLIGHT_COLOR |
THEME_HIGHLIGHT_CONTRASTING_COLOR |
THEME_HIGHLIGHT_CONTRASTING_COLOR |
THEME_DISABLE_COLOR |
THEME_DISABLE_COLOR |
THEME_ERROR_COLOR |
THEME_ERROR_COLOR |
THEME_WARNING_COLOR |
THEME_WARNING_COLOR |
THEME_ACTIVE_COLOR |
THEME_ACTIVE_COLOR |
THEME_INACTIVE_COLOR |
THEME_INACTIVE_COLOR |
THEME_BUTTON_BORDER_ACTIVE_COLOR |
THEME_BUTTON_BORDER_ACTIVE_COLOR |
THEME_BUTTON_BORDER_COLOR |
THEME_BUTTON_BORDER_COLOR |
THEME_SAFE_COLOR |
THEME_SAFE_COLOR |
THEME_SAFE_CONTRASTING_COLOR |
THEME_SAFE_CONTRASTING_COLOR |
THEME_PAGE_BGCOLOR |
THEME_PAGE_BGCOLOR |
Colors¶
Fixed colors. Prefer lcd.RGB() or theme colors.
| Constant | Meaning |
|---|---|
COLOR_BLACK |
BLACK |
COLOR_WHITE |
WHITE |
COLOR_RED |
RED |
COLOR_GREEN |
GREEN |
COLOR_BLUE |
BLUE |
COLOR_CYAN |
CYAN |
COLOR_MAGENTA |
MAGENTA |
COLOR_YELLOW |
YELLOW |
COLOR_ORANGE |
ORANGE |
Source categories¶
Used with system.getSource({category=...}) and Source:category().
| Constant | Meaning |
|---|---|
CATEGORY_NONE |
None |
CATEGORY_ALWAYS_ON |
Always ON |
CATEGORY_ANALOG |
Analogs Category, see System / Hardware screen for details |
CATEGORY_SWITCH |
Switches Category, see System / Hardware screen for details |
CATEGORY_SWITCH_POSITION |
Switches Positions Category |
CATEGORY_FUNCTION_SWITCH |
Function Switches Category |
CATEGORY_LOGIC_SWITCH |
Logic Switches Category, see Model / Logic Switches screen for details |
CATEGORY_TRIM |
Trims Category, see Model / Trims screen for details |
CATEGORY_TRIM_POSITION |
Trims Positions Category |
CATEGORY_CHANNEL |
Channels Category, see Model / Outputs screen for details |
CATEGORY_GYRO |
Gyro Category |
CATEGORY_GYRO_SWITCH |
Gyro Switches Category |
CATEGORY_TRAINER |
Trainer Channels Category, see Model / Trainer screen for details |
CATEGORY_FLIGHT |
Flight Values Category |
CATEGORY_FLIGHT_VALUE |
Flight Values Category (deprecated) |
CATEGORY_TIMER |
Timers Category, see Model / Timers screen for details |
CATEGORY_TELEMETRY_SENSOR |
Telemetry sensors Category, see Model / Telemetry screen for details |
CATEGORY_SYSTEM |
System Category |
CATEGORY_SYSTEM_EVENT |
System events Category |
CATEGORY_SPECIAL |
System special Category |
Source options¶
Used with system.getSource({options=...}) and Source:value({options=...}).
| Constant | Meaning |
|---|---|
OPTION_SENSOR_MIN |
Sensor Minimum Value |
OPTION_SENSOR_MAX |
Sensor Maximum Value |
OPTION_LATITUDE |
GPS Latitude |
OPTION_LONGITUDE |
GPS Longitude |
OPTION_CELL_LOWEST |
FLVSS Lowest Cell |
OPTION_CELL_HIGHEST |
FLVSS Highest Cell |
OPTION_CELLS_COUNT |
FLVSS Cells Count |
OPTION_CELL_COUNT |
FLVSS Cells Count (deprecated) |
OPTION_CHANNEL_OUTPUT |
Channel output (instead of Mixer output) |
OPTION_CHANNEL_PWM |
Channel PWM value |
System events¶
Members of CATEGORY_SYSTEM_EVENT.
| Constant | Meaning |
|---|---|
SYSTEM_EVENT_THROTTLE_HOLD |
System event Throttle Hold |
SYSTEM_EVENT_THROTTLE_CUT |
System event Throttle Cut |
SYSTEM_EVENT_THROTTLE_ACTIVE |
System event Throttle Active |
SYSTEM_EVENT_THROTTLE_DEAD_BAND |
System event Throttle stick inside dead band |
SYSTEM_EVENT_TELEMETRY_ACTIVE |
System event Telemetry Active |
SYSTEM_EVENT_RSSI_LOW |
System event RSSI Low |
SYSTEM_EVENT_TRAINER_ACTIVE |
System event Trainer Active |
SYSTEM_EVENT_FLIGHT_RESET |
System event Flight Reset |
SYSTEM_EVENT_TRIP_RESET |
System event Trip Reset (= Flight Reset) |
System sources¶
Members of CATEGORY_SYSTEM.
| Constant | Meaning |
|---|---|
SYSTEM_MAIN_VOLTAGE |
Radio Main Voltage |
SYSTEM_RTC_VOLTAGE |
Radio RTC Voltage |
SYSTEM_INTERNAL_CLOCK |
Radio System Date & Time |
SYSTEM_RAM_AVAILABLE |
Radio RAM available |
SYSTEM_RUNTIME |
Radio Runtime |
Pen styles¶
Used with lcd.pen().
| Constant | Meaning |
|---|---|
PEN_SOLID |
SOLID Pen |
PEN_DOTTED |
DOTTED Pen |
PEN_DASHED |
DASHED Pen |
Text alignment¶
Flags for lcd.drawText() / lcd.drawNumber().
| Constant | Meaning |
|---|---|
TEXT_RIGHT |
RIGHT Text alignment |
TEXT_LEFT |
LEFT Text alignment |
TEXT_CENTERED |
CENTERED Text alignment |
Curve types¶
Used with model.createCurve() / Curve.
| Constant | Meaning |
|---|---|
CURVE_TYPE_EXPO |
Exponent curve |
CURVE_TYPE_FUNCTION |
Function curve |
CURVE_TYPE_CUSTOM |
Custom curve |
Logic switch functions¶
Used with LogicSwitch:function().
| Constant | Meaning |
|---|---|
LOGIC_SWITCH_FUNCTION_AROUND |
Logic switch function A ~ X |
LOGIC_SWITCH_FUNCTION_EQ |
Logic switch function A = X |
LOGIC_SWITCH_FUNCTION_GT |
Logic switch function A > X |
LOGIC_SWITCH_FUNCTION_LT |
Logic switch function A < X |
LOGIC_SWITCH_FUNCTION_ABS_GT |
Logic switch function |A| > X |
LOGIC_SWITCH_FUNCTION_ABS_LT |
Logic switch function |A| < X |
LOGIC_SWITCH_FUNCTION_DELTA_GT |
Logic switch function Δ > X |
LOGIC_SWITCH_FUNCTION_ABS_DELTA_GT |
Logic switch function |Δ| > X |
LOGIC_SWITCH_FUNCTION_RANGE |
Logic switch function Range |
LOGIC_SWITCH_FUNCTION_AND |
Logic switch function AND |
LOGIC_SWITCH_FUNCTION_OR |
Logic switch function OR |
LOGIC_SWITCH_FUNCTION_XOR |
Logic switch function XOR |
LOGIC_SWITCH_FUNCTION_TIMER |
Logic switch function Timer |
LOGIC_SWITCH_FUNCTION_STICKY |
Logic switch function Sticky |
LOGIC_SWITCH_FUNCTION_EDGE |
Logic switch function Edge |
Events¶
Event categories passed to event(widget, category, value, x, y) handlers.
| Constant | Meaning |
|---|---|
EVT_KEY |
Key Event Category |
EVT_TOUCH |
Key Touch Event Category |
EVT_SHUTDOWN |
Shutdown Event Category |
EVT_CLOSE |
Close Event Category |
EVT_OPEN |
Open Event Category |
EVT_SENSOR_DISCOVER |
Sensor Discover Event Category |
Units¶
Used with Source:unit() and lcd.drawNumber().
| Constant | Meaning |
|---|---|
UNIT_NONE |
no unit |
UNIT_MILLIVOLT |
mV |
UNIT_VOLT |
V |
UNIT_MILLIAMPERE |
mA |
UNIT_AMPERE |
A |
UNIT_MILLIAMPERE_HOUR |
mAh |
UNIT_AMPERE_HOUR |
Ah |
UNIT_MILLIWATT |
mW |
UNIT_WATT |
W |
UNIT_CENTIMETER |
cm |
UNIT_METER |
m |
UNIT_KILOMETER |
km |
UNIT_MILE |
mi |
UNIT_NAUTICAL_MILE |
NM |
UNIT_FOOT |
ft |
UNIT_CENTIMETER_PER_SECOND |
cm/s |
UNIT_METER_PER_SECOND |
m/s |
UNIT_METER_PER_MINUTE |
m/min |
UNIT_FOOT_PER_SECOND |
ft/s |
UNIT_FOOT_PER_MINUTE |
ft/min |
UNIT_KILOMETER_PER_HOUR |
km/h |
UNIT_MILE_PER_HOUR |
m/h |
UNIT_KNOT |
knots |
UNIT_CELSIUS |
°C |
UNIT_FAHRENHEIT |
°F |
UNIT_PERCENT |
% |
UNIT_MICROSECOND |
us |
UNIT_MILLISECOND |
ms |
UNIT_SECOND |
s |
UNIT_MINUTE |
min |
UNIT_HOUR |
h |
UNIT_DB |
dB |
UNIT_DBM |
dBm |
UNIT_HERTZ |
Hz |
UNIT_MEGAHERTZ |
MHz |
UNIT_G |
g |
UNIT_DEGREE |
° |
UNIT_RADIAN |
rad |
UNIT_MILLILITER |
ml |
UNIT_MILLILITER_PER_MINUTE |
ml/min |
UNIT_MILLILITER_PER_PULSE |
ml/pulse |
UNIT_RPM |
r/min |
UNIT_DEGREE_PER_SECOND |
°/s |
UNIT_MILLIGRAM |
mg |
UNIT_GRAM |
g |
UNIT_KILOGRAM |
kg |
UNIT_TON |
t |
UNIT_KILOTON |
kt |
UNIT_PA |
Pa |
UNIT_KPA |
kPa |
UNIT_MPA |
MPa |
UNIT_BAR |
bar |
UNIT_PSI |
psi |
Sensor types¶
Used with model.createSensor().
| Constant | Meaning |
|---|---|
SENSOR_TYPE_DIY |
DIY Sensor |
SENSOR_TYPE_SPORT |
S.Port Sensor |
SENSOR_TYPE_CRSF |
CRSF Sensor |
Other¶
| Constant | Meaning |
|---|---|
FLIGHT_CURRENT_MODE |
Current Flight Mode |
COUNTDOWN_VALUE |
Countdown value |
COUNTDOWN_BEEP |
Countdown beeps |
PLAY_FILE |
Play file |
PLAY_VALUE |
Play value |
X_POSITIVE |
Function curve: x > 0 |
X_NEGATIVE |
Function curve: x < 0 |
X_ABS |
Function curve: |x| |
FUNC_POSITIVE |
Function curve: f > 0 |
FUNC_NEGATIVE |
Function curve: f < 0 |
FUNC_ABS |
Function curve: |f| |
UNDEFINED_VALUE |
Used in sport.getSensor() filters |
Legacy / deprecated¶
Kept for older scripts. Prefer the COLOR_*, PEN_* and TEXT_* forms.
| Constant | Meaning |
|---|---|
BLACK |
BLACK (deprecated) |
WHITE |
WHITE (deprecated) |
RED |
RED (deprecated) |
GREEN |
GREEN (deprecated) |
BLUE |
BLUE (deprecated) |
YELLOW |
YELLOW (deprecated) |
ORANGE |
ORANGE (deprecated) |
CURRENT_FLIGHT_MODE |
Current Flight Mode (deprecated) |
MAIN_VOLTAGE |
Radio Main Voltage (deprecated) |
RTC_VOLTAGE |
Radio RTC Voltage (deprecated) |
INTERNAL_CLOCK |
Radio System Date & Time (deprecated) |
THROTTLE_HOLD |
System event Throttle Hold (deprecated) |
THROTTLE_CUT |
System event Throttle Cut (deprecated) |
THROTTLE_ACTIVE |
System event Throttle Active (deprecated) |
TELEMETRY_ACTIVE |
System event Telemetry Active (deprecated) |
RSSI_LOW |
System event RSSI Low (deprecated) |
TRAINER_ACTIVE |
System event Trainer Active (deprecated) |
SOLID |
SOLID Pen (deprecated) |
DOTTED |
DOTTED Pen (deprecated) |
RIGHT |
RIGHT Text alignment (deprecated) |
LEFT |
LEFT Text alignment (deprecated) |
CENTERED |
CENTERED Text alignment (deprecated) |