Description

Lcd functions allow scripts to interact with the transmitter display. This access is limited to the run function of One-Time and Telemetry scripts, and the refresh function of Widget scripts on radios with color display.

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.

For Widget scripts, lcd.clear() is not needed, as each invocation starts with a blank screen showing the theme background. But it can be used to overwrite the theme background with another color by calling lcd.clear(color).

Please see above for a description of the constants for flags and patterns, colors, and screen size that can be used with lcd drawing functions.

Returns a drawing flag with RGB color code

@status current Introduced in 2.2.0

Parameters

• r (integer) a number between 0 and 255 that expresses te amount of red in the color

• g (integer) a number between 0 and 255 that expresses te amount of green in the color

• b (integer) a number between 0 and 255 that expresses te amount of blue in the color

Return value

• flag with RGB565 color

Notice

Only available on radios with color display

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 flags and color constants

Return value

none

Displays a bitmap at (x,y)

@status current Introduced in 2.2.0

Parameters

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

• x,y (positive numbers) starting coordinates

• scale (positive numbers) scale in %, 50 divides size by two, 100 is unchanged, 200 doubles size. Omitting scale draws image in 1:1 scale and is faster than specifying 100 for scale.

Return value

none

Notice

Only available on Horus

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

Display a telemetry value at (x,y)

@status current Introduced in 2.0.6, changed in 2.1.0 (only telemetry sources are valid)

Parameters

• x,y (positive numbers) starting coordinate

• source can be a source identifier (number) or a source name (string). See getValue()

• 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 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 (optional) please see flags and color constants

• opacity (number) opacity defaults to 0 (only on Horus)

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

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 (optional) please see flags and color constants

Return value

none

Clear the LCD screen

@status current Introduced in 2.0.0, color parameter introduced in 2.2.0 RC12

Parameters

• color (optional, only on color screens)

Return value

none

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 (optional) please see and constants

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

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) please see flags and color constants

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 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 (optional) please see flags and color constants

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

• opacity (number) opacity defaults to 0 (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 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 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 (optional) please see constants, only SMLSIZE, BLINK and INVERS.

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 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 (optional) please see flags and color constants for drawing flags and colors, and Appendix for available characters in each font set.

• inversColor (optional with the INVERS flag) overrides the inverse text color for INVERS

Return value

none

Get the color value from flags

@status current Introduced in 2.3.11

Parameters

• flags (flags) please see flags and color constants

Return value

• color (flag) only the RGB565 color value of the input

Notice

Only available on radios with color display

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

Reset the backlight timeout

@status current Introduced in 2.3.6

Parameters

none

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

Display a number at (x,y)

@status current Introduced in 2.0.0

Parameters

• x,y (positive numbers) starting coordinate

• value (number) value to display

• flags (optional) please see flags and color constants

• inversColor (optional with INVERS flag) overrides the inverse text color for INVERS

Return value

none

Refresh the LCD screen

From 2.4.0 on color LCDs, this is done automatically when the screen needs to be refreshed (on events and depending on refresh period).

@status current Only used on non-color LCDs.

Parameters

none

Return value

none

Change an indexed color (theme colors and CUSTOM_COLOR).

@status current Introduced in 2.2.0

Notice

• Changing theme colors affects not only other Lua widgets, but the entire radio interface.

• Only available on radios with color display

Parameters

• colorIndex (flags) must be an indexed color, please see color constants.

• color (flags) please see color constants.

Return value

none

Notice

Only available on radios with color display

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 flags and color constants

Return value

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

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

@status current Introduced in 2.0.0

Parameters

• x,y (positive numbers) starting coordinate

• value (number) time in seconds

• flags (optional) please see flags and color constants

• inversColor (optional with INVERS flag) overrides the inverse text color for INVERS

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

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