This section describes the Lua libraries, functions and constants that are provided by EdgeTX.

• Key Events

• Touch Events

• Flags and Patterns

• Colors

• Screen size

For detailed function explanation see Logiacal Switches functions in EdgeTX manual.

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

lcd.drawText Flags

lcd drawing functions flags on B&W LCD radios

lcd.drawLine function patterns

There are several option types that can be specified in the widget options table, which are exposed to the user via the Widget Settings menu.

Example

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.

• tapCount is zero for anything but EVT_TOUCH_TAP.

Clears the LCD screen optionaly filling it with selected color

Syntax

lcd.clear( [color] )

Parameters

Returns

none

Notes

This function works only in stand-alone and telemetry & widget scripts. See .

Available on

API status

Examples

Related topics

Displays prevoiusly loaded bitmap at (x,y) and optionally scales it.

Syntax

lcd.drawBitmap( bitmap, x, y [, scale] )

Parameters

Returns

none

Notes

Available on

API status

Examples

Related topics

Draw a solid rectangle from top left corner (x,y) of specified width and height

@status current Introduced in 2.0.0

Parameters

• x,y (positive numbers) top left corner position

• w (number) width in pixels

• h (number) height in pixels

• flags (unsigned number) drawing flags

Return value

none

Draw a combo box

@status current Introduced in 2.0.0

Parameters

• x,y (positive numbers) top left corner position

• w (number) width of combo box in pixels

• list (table) combo box elements, each element is a string

• idx (integer) index of entry to highlight

• flags (unsigned number) drawing flags, the flags can not be combined:

• BLINK combo box is expanded

• INVERS combo box collapsed, text inversed

• 0 or not present combo box collapsed, text normal

Return value

none

Notice

Only available on Taranis

• CHAR_RIGHT

• CHAR_LEFT

• CHAR_UP

• CHAR_DOWN

• CHAR_DELTA

• CHAR_STICK

• CHAR_POT

• CHAR_SLIDER

• CHAR_SWITCH

• CHAR_TRIM

• CHAR_INPUT

• CHAR_FUNCTION

• CHAR_CYC

• CHAR_TRAINER

• CHAR_CHANNEL

• CHAR_TELEMETRY

• CHAR_LUA

• FUNC_OVERRIDE_CHANNEL

• FUNC_TRAINER

• FUNC_INSTANT_TRIM

• FUNC_RESET

• FUNC_SET_TIMER

• FUNC_ADJUST_GVAR

• FUNC_VOLUME

• FUNC_SET_FAILSAFE

• FUNC_RANGECHECK

• FUNC_BIND

• FUNC_PLAY_SOUND

• FUNC_PLAY_TRACK

• FUNC_PLAY_VALUE

• FUNC_PLAY_SCRIPT

• FUNC_RESERVE5

• FUNC_BACKGND_MUSIC

• FUNC_BACKGND_MUSIC_PAUSE

• FUNC_VARIO

• FUNC_HAPTIC

• FUNC_LOGS

• FUNC_BACKLIGHT

• FUNC_SCREENSHOT

• FUNC_RACING_MODE

• FUNC_DISABLE_TOUCH

Draw a straight line on LCD

@status current Introduced in 2.0.0, flags introduced in 2.3.6

Parameters

• x1,y1 (positive numbers) starting coordinate

• x2,y2 (positive numbers) end coordinate

• pattern SOLID or DOTTED

• flags lcdflags

Return value

none

Notice

If the start or the end of the line is outside the LCD dimensions, then the whole line will not be drawn (starting from OpenTX 2.1.5)

Draw a rectangle from top left corner (x,y) of specified width and height

@status current Introduced in 2.0.0, changed in 2.2.0

Parameters

• x,y (positive numbers) top left corner position

• w (number) width in pixels

• h (number) height in pixels

• flags (unsigned number) drawing flags

• t (number) thickness in pixels, defaults to 1 (only on Horus)

Return value

none

Draw a bitmap at (x,y)

@status current Introduced in 2.0.0

Parameters

• x,y (positive numbers) starting coordinates

• name (string) full path to the bitmap on SD card (i.e. “/IMAGES/test.bmp”)

Return value

none

Notice

Maximum image size is [display width / 2] x [display height] pixels.

Draw a single pixel at (x,y) position

@status current Introduced in 2.0.0

Parameters

• x (positive number) x position

• y (positive number) y position

• flags (optional) lcdflags

Return value

none

Notice

Taranis has an LCD display width of 212 pixels and height of 64 pixels. Position (0,0) is at top left. Y axis is negative, top line is 0, bottom line is 63. Drawing on an existing black pixel produces white pixel (TODO check this!)

Draw a simple gauge that is filled based upon fill value

@status current Introduced in 2.0.0, changed in 2.2.0

Parameters

• x,y (positive numbers) top left corner position

• w (number) width in pixels

• h (number) height in pixels

• fill (number) amount of fill to apply

• maxfill (number) total value of fill

• flags (unsigned number) drawing flags

Return value

none

Draw a text representation of switch at (x,y)

@status current Introduced in 2.0.0

Parameters

• x,y (positive numbers) starting coordinate

• switch (number) number of switch to display, negative number displays negated switch

• flags (unsigned number) drawing flags, only SMLSIZE, BLINK and INVERS.

Return value

none

Displays the name of the corresponding input as defined by the source at (x,y)

@status current Introduced in 2.0.0

Parameters

• x,y (positive numbers) starting coordinate

• source (number) source index

• flags (unsigned number) drawing flags

Return value

none

Display a value formatted as time at (x,y)

@status current Introduced in 2.0.0, SHADOWED introduced in 2.2.1

Parameters

• x,y (positive numbers) starting coordinate

• value (number) time in seconds

• flags (unsigned number) drawing flags:

• 0 or not specified normal representation (minutes and seconds)

• TIMEHOUR display hours

• other general LCD flag also apply

• SHADOWED Horus only, apply a shadow effect

Return value

none

Description

Lcd functions allow scripts to interact with the transmitter display. This access is limited to the 'run' functions of One-Time and Telemetry scripts. Widget scripts on the Horus (X10 and X12S) can make use of the lcd functions as well.

Notes:

The run function is periodically called when the screen is visible. In OpenTX 2.0 each invocation starts with a blank screen (unless lcd.lock() is used). Under OpenTX 2.1 screen state is always persisted across calls to the run function. Many scripts originally written for OpenTX 2.0 require a call to lcd.clear() at the beginning of their run function in order to display properly under 2.1 and 2.2.

Many of the lcd functions accept parameters named flags and patterns. The names and their meanings are described below.

Flags Constants

Patterns Constants

Screen Constants

Screen Information

Draw an arc

@status current Introduced in 2.4.0

Parameters

• x,y (positive numbers) coordinates of the center

• r1,r2 (positive numbers) radii of the inside and outside of the annulus

• start,end (positive numbers) start and end of the annulus

• flags (optional) please see and constants

Return value

none

Draw a text beginning at (x,y)

@status current Introduced in 2.0.0, SHADOWED introduced in 2.2.1

Parameters

• x,y (positive numbers) starting coordinate

• text (string) text to display

• flags (unsigned number) drawing flags. All values can be combined together using the + character. ie BLINK + DBLSIZE. See the for available characters in each font set.

• 0 or not specified normal font

• XXLSIZE jumbo sized font

• DBLSIZE double size font

• MIDSIZE mid sized font

• SMLSIZE small font

• INVERS inverted display

• BLINK blinking text

• SHADOWED Horus only, apply a shadow effect

Return value

none

Display a number at (x,y)

@status current Introduced in 2.0.0, SHADOWED introduced in 2.2.1

Parameters

• x,y (positive numbers) starting coordinate

• value (number) value to display

• flags (unsigned number) drawing :

  • 0 or not specified display with no decimal (like abs())

  • PREC1 display with one decimal place (number 386 is displayed as 38.6)

  • PREC2 display with tow decimal places (number 386 is displayed as 3.86)

  • other general LCD also apply\

Return value

none

Draw a filled circle at (x, y) of specified radius

@status current Introduced in 2.4.0

Parameters

• x,y (positive numbers) center position

• r (number) radius in pixels

• flags (optional) please see flags and color constants

Return value

none

Draw a circle at (x, y) of specified radius

@status current Introduced in 2.4.0

Parameters

• x,y (positive numbers) center position

• r (number) radius in pixels

• flags (optional) please see flags and color constants

Return value

none

Draw a pie slice

@status current Introduced in 2.4.0

Parameters

• x,y (positive numbers) coordinates of the center

• r (positive number) radius

• start,end (positive numbers) start and end of the pie slice

• flags (optional) please see flags and color constants

Return value

none

Draw a rectangle in perspective

@status current Introduced in 2.4.0

Parameters

• pitch,roll (positive numbers) pitch and roll to define the orientation of the rectangle

• xmin,xmax,ymin,ymax (positive numbers) the limits of the rectangle

• flags (optional) please see flags and color constants

Return value

none

Draw a line only inside a rectangle

@status current Introduced in 2.4.0

Parameters

• x1,y1,x2,y1 (positive numbers) coordinates of the start and end of the unclipped line

• xmin,xmax,ymin,ymax (positive numbers) the limits of the rectangle inside which the line is drawn

• pattern (FORCE, ERASE, DOTTED) please see Lcd functions overview

• flags (optional) please see flags and color constants

Return value

none

Draw a title bar

@status current Introduced in 2.0.0

Parameters

• title (string) text for the title

• page (number) page number

• pages (number) total number of pages. Only used as indicator on the right side of title bar. (i.e. idx=2, cnt=5, display 2/5)

Return value

none

Notice

Only available on Taranis

Draw a triangle

@status current Introduced in 2.4.0

Parameters

• x1,y1,x2,y2,x3,y3 (positive numbers) coordinates of the three vertices

• flags (optional) please see flags and color constants

Return value

none

Returns the leftmost x position from previous drawtext or drawNumber output

@status current Introduced in 2.2.0

Parameters

none

Return value

• number (integer) x position

Notice

Only available on Taranis

Returns the rightmost x position from previous output

@status current Introduced in 2.0.0

Parameters

none

Return value

• number (integer) x position

Notice

Only available on Taranis

For added clarity, it is recommended to use lcd.getLastRightPos()

Draw a filled triangle

@status current Introduced in 2.4.0

Parameters

• x1,y1,x2,y2,x3,y3 (positive numbers) coordinates of the three vertices

• flags (optional) please see flags and color constants

Return value

none

Exit full screen widget mode.

@status current Introduced in 2.5.0

Notice

Only available on radios with color display

Invert a rectangle zone from top left corner (x,y) of specified width and height

@status current Introduced in 2.8.0

Parameters

• x,y (positive numbers) top left corner position

• w (number) width in pixels

• h (number) height in pixels

• flags (optional) please see Lcd functions overview

Return value

none

Returns the rightest x position from previous drawtext or drawNumber output

@status current Introduced in 2.2.0

Parameters

none

Return value

• number (integer) x position

Notice

Only available on Taranis

This is strictly equivalent to former lcd.getLastPos()

Refresh the LCD screen

@status current Introduced in 2.2.0

Parameters

none

Return value

none

Notice

This function only works in stand-alone and telemetry scripts.

Get the color for specific area : see lcd.setColor for area list

@status current Introduced in 2.3.11

Parameters

none

Return value

none

Notice

Only available on Colorlcd radios

Draw an arc

@status current Introduced in 2.4.0

Parameters

• x,y (positive numbers) coordinates of the center

• r (positive number) radius

• start,end (positive numbers) start and end of the arc

• flags (optional) please see and constants

Return value

none

Draw text inside rectangle (x,y,w,h) with line breaks

Parameters

• x,y (positive numbers) starting coordinate

• w,h (positive numbers) width and height of bounding rectangle

• text (string) text to display

• flags (optional) please see for drawing flags and colors, and for available characters in each font set. RIGHT, CENTER and VCENTER are not implemented.

Return value

• x,y (integers) point where text drawing ended

Notes

Available on

API status

Examples

Set a color for specific area

@status current Introduced in 2.2.0

Parameters

• area (unsigned number) specific screen area in the list bellow

• CUSTOM_COLOR

• DEFAULT_COLOR

• DEFAULT_BGCOLOR

• FOCUS_COLOR

• FOCUS_BGCOLOR

• LINE_COLOR

• CHECKBOX_COLOR

• MENU_BGCOLOR

• MENU_COLOR

• MENU_TITLE_DISABLE_COLOR

• HEADER_COLOR

• ALARM_COLOR

• HIGHLIGHT_COLOR

• TEXT_DISABLE_COLOR

• HEADER_COLOR

• DISABLE_COLOR

• CURVE_CURSOR_COLOR

• TITLE_BGCOLOR

• TRIM_BGCOLOR

• TRIM_SHADOW_COLOR

• MAINVIEW_PANES_COLOR

• MAINVIEW_GRAPHICS_COLOR

• MENU_BGCOLOR

• HEADER_ICON_BGCOLOR

• HEADER_CURRENT_BGCOLOR

• MAINVIEW_PANES_COLOR

• MAINVIEW_GRAPHICS_COLOR

• OVERLAY_COLOR

• BARGRAPH1_COLOR

• BARGRAPH2_COLOR

• BARGRAPH_BGCOLOR

• CUSTOM_COLOR

• color (number) color in 5/6/5 rgb format. The following prefined colors are available

• WHITE

• GREY

• LIGHTGREY

• DARKGREY

• BLACK

• YELLOW

• BLUE

• RED

• DARKRED

Return value

none

Notice

Only available on Colorlcd radios

Reset the backlight timeout

@status current Introduced in 2.3.6

Parameters

none

Return value

none

Raises a pop-up on screen that asks for confirmation

@status current Introduced in 2.2.0, changed from (title, event) to (title, message, event) in 2.3.8

Parameters

• title (string) title to display

• message (string) text to display

• event (number) the event variable that is passed in from the Run function (key pressed)

Return value

• "CANCEL" user pushed EXIT key

Notice

Use only from stand-alone and telemetry scripts.

Displays a bitmap pattern at (x,y)

@status current Introduced in 2.8.0

Parameters

• bitmap (pointer) point to a bitmap previously opened with Bitmap.open()

• x,y (positive numbers) starting coordinates

• flags (optional) please see Lcd functions overview

Return value

none

Notice

Only available on Horus

Returns gray value which can be used in LCD functions

@status current Introduced in 2.0.13

Parameters

none

Return value

• (number) a value that represents amount of greyness (from 0 to 15)

Notice

Only available on Taranis

Raises a pop-up on screen that allows uses input

@status current Introduced in 2.0.0

Parameters

• title (string) text to display

• event (number) the event variable that is passed in from the Run function (key pressed)

• input (number) value that can be adjusted by the +/­- keys

• min (number) min value that input can reach (by pressing the -­ key)

• max (number) max value that input can reach

Return value

• number result of the input adjustment

• "OK" user pushed ENT key

• "CANCEL" user pushed EXIT key

Notice

Use only from stand-alone and telemetry scripts.

Displays a bitmap pattern pie at (x,y)

@status current Introduced in 2.8.0

Parameters

• bitmap (pointer) point to a bitmap previously opened with Bitmap.open()

• x,y (positive numbers) starting coordinates

• startAngle Start angle

• endAngle End angle

• flags (optional) please see Lcd functions overview

Return value

none

Notice

Only available on Horus

Raises a pop-up on screen that shows a warning

@status current Introduced in 2.2.0

Parameters

• title (string) text to display

• event (number) the event variable that is passed in from the Run function (key pressed)

Return value

• "CANCEL" user pushed EXIT key

Notice

Use only from stand-alone and telemetry scripts.

API Status

Change log

One-Time script

When run this produces the page shown below.

The user can exit the script by tapping the 'CLOSE' button or tapping the 'EdgeTX' button in the top-left corner. In both cases a popup dialog will be shown - if the user selects 'Yes' the script will close.

Widget script

LVGL version of the 'Counter' script.

Syntax

lvgl.align([parent], {settings})

parent:align({settings})

Parameters

See the API page for parameter description and common settings.

Choice specific settings:

Notes

The popup menu is closed when the user selects an item, and the 'set' function is called.

If the user taps outside the menu or the RTN key is pressed, the popup menu is closed and the 'set' function is not called.

API Status

Change log

Returns colorFlag in RGB565 format that can be used with lcd draw functions.

Syntax

lcd.RGB( r, g, b | rgb )

Parameters

or

Returns

• color_flag. See Drawing Flags

Notes

Available on

• B&W LCD radios

• Grayscale LCD radios

• Color LCD radios

API status

Examples

-- RGB numeric parameters
local darkred = lcd.RGB(20,0,0)  -- create color_flag for color
lcd.drawText(0,0,"Very dark red text", darkred)

-- RGB hex parameter
local mygrey = lcd.RGB(0xAEAEAE)  -- create color_flag for color
lcd.drawText(0,20,"My grey color", mygrey)

Related topics

• Drawing flag

• Color constants

LVGL objects are created and manipulated using the 'lvgl' functions.

Most of these functions follow the syntax below. A few function have only the optional 'parent' parameter.

lvgl.function([parent], {settings})

Most of the functions return an LVGL object that can be used to update the UI or in other API calls.

API functions can also be called using Lua OO syntax.

For example the following two lines are equivalent.

lvgl.show(parent)
parent:show()

There are a number of settings that are common to all of the LVGL functions that take a 'settings' table parameter.

The functions associated with settings are called periodically by the firmware. Where a setting is defined using a function, the UI will automatically update whenever the function returns a different value.

A note on object width and height

Although width and height, and the size function, can be defined for all objects they may not be used in some cases. For example when creating a circle or arc object the radius property should be used instead.

Syntax

lvgl.choice([parent], {settings})

parent:choice({settings})

Parameters

See the API page for parameter description and common settings.

Choice specific settings:

Return values

LVGL object

Notes

The popup menu is closed when the user selects an item, and the 'set' function is called.

If the user taps outside the menu or the RTN key is pressed, the popup menu is closed and the 'set' function is not called.

API Status

Change log

Get the width and height of a text string drawn with flags

@status current Introduced in 2.5.0

Parameters

• text (string)

• flags (optional) please see and constants

Return value

• w,h (integers) width and height of the text

Syntax

lvgl.circle([parent], {settings})

parent:circle({settings})

Parameters

See the API page for parameter description and common settings.

Note: 'w', 'h' and 'size' should not be used with lvgl.circle. Use 'radius' instead.

Circle specific settings:

Return values

LVGL object

API Status

Change log

EdgeTX widgets and One-Time scipts can make use of LVGL controls and objects to create the script user interface. In addition to providing much better performance, this gives Lua scripts the same styles applied to firmware LVGL pages and controls.

The LVGL API can be used to add varios objects such as labels, rectangles, circles, buttons, toggle switches, sliders and more. Objects can be grouped, e.g. a rectangle can contain child labels or any other object. Objects can be moved, resized and updated as needed.

Many object properties can be set dynamically through functions in the Lua script - whenever the function returns a new value the objects property is automaticall changed. This removes the need for manually re-drawing the user interface.

Limitations:

• Direct drawing via the 'lcd' API is not available for scripts using LVGL to create the UI.

Activating the LVGL API

A script that wants to use LVGL to create the UI must return 'useLvgl = true' in the table returned by the script:

Once activated a new 'lvgl' object will be available to use in the script. This is the primary interface to the LVGL API.

Scripts should check that 'lvgl' is not nil before use. If the 'lvgl' object is nil it is most likely the script is running on an earlier version of EdgeTX (prior to 2.11), or you forgot to set 'useLvgl = true'. Scripts should either display an error or fall back to using the lcd API in LVGL is not available.

Usage patterns

One-Time scripts

One-Time scripts have only two functions. Prior to the LVGL API, the 'init' function would be used to set up the initial state for the script and the 'run' function would re-draw the UI whenever called as well as process key and touch events.

With the LVGL API, the 'init' function should still set up the initial state for the script; but should also create the UI from LVGL objects. The 'run' function may handle key and touch events; but in most cases the LVGL objects themselves will do the heavy lifting. When set up correctly the LVGL UI will be automatically updated as the local state is changed, and the script will be automatically updated as the user interacts with the LVGL objects.

Widget scripts

Widget scripts using LVGL should create their UI in the 'update' function using the widget size to determine what elements to create and how to lay them out.

The 'background' and 'run' functions should just update essential state changes that are not being managed directly by the LVGL objects.

Syntax

lvgl.dialog({settings})

Parameters

The lvgl.confirm function uses only the settings shown below. The common settings shown on the API page are not used.

API Status

Change log

Syntax

lvgl.box([parent], {settings})

parent:box({settings})

Parameters

See the API page for parameter description and common settings.

Box specific settings:

Return values

LVGL object

API Status

Return values

LVGL object

Change log

Syntax

lvgl.build([parent], {{settings}})

parent:build({{settings}})

Parameters

See the API page for parameter description and common settings.

Build specific settings:

Return values

Table of named LVGL objects.

Notes

The 'settings' parameter to lvgl.build should be a table of tables. Each inner table creates a separate LVGL object based on the 'type' value.

For example the code below creates two object, a label and a rectangle.

lvgl.build({
    {type="label", x=0, y=0, text="Some text", color=BLACK},
    {type="rectangle", x=0, y=20, w=100, h=100, color=BLACK}
})

Objects can be nested by using the 'children' setting, this should be another table of tables just like the build settings.