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

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

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

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

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!)

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

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

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

Syntax

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

Parameters

Returns

none

Notes

Available on

• B&W LCD radios

• Grayscale LCD radios

• Color LCD radios

API status

Examples

-- drawing bitmap stored on sd card root folder with original size
local myLogo = Bitmap.open("/logo.png")
lcd.drawBitmap(myLogo,10,10)

-- drawing bitmap stored on sd card root folder doubling its size
local myLogo = Bitmap.open("/logo.png")
lcd.drawBitmap(myLogo,10,10,200)

Related topics

• Drawing flag

• Color constants

• Bitmap.open

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 script types.

Available on

• B&W LCD radios

• Grayscale LCD radios

• Color LCD radios

API status

Examples

-- clearing lcd with system default color
lcd.clear()

-- clearing lcd screen to dark red
local darkred = lcd.RGB(20,0,0)  -- create color_flag for color
lcd.clear(darkred)

Related topics

• Drawing flag

• Color constants

Draws channel value defined in source variable at (x,y)

Syntax

lcd.drawChannel(x, y, source [, flags])

Parameters

Returns

none

Notes

Available on

• B&W LCD radios

• Grayscale LCD radios

• Color LCD radios

API status

Examples

-- example

-- example

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

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

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

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

Exit full screen widget mode.

@status current Introduced in 2.5.0

Notice

Only available on radios with color display

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()

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

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

Reset the backlight timeout

@status current Introduced in 2.3.6

Parameters

none

Return value

none

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

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

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.

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.

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.

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

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

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.

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

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.