mirror of
https://github.com/opentx/opentx.git
synced 2025-07-15 12:25:12 +03:00
Lua documentation update (ported from master 682fa5d)
This commit is contained in:
Damjan Adamic
parent
6f0de32ba8
commit
0db2013d24
2 changed files with 253 additions and 41 deletions
|
|
@ -74,11 +74,11 @@ struct LuaField {
|
|||
/*luadoc
|
||||
@function getVersion()
|
||||
|
||||
Returns OpenTX version
|
||||
Return OpenTX version
|
||||
|
||||
@retval string OpenTX version (ie "2.1.5")
|
||||
|
||||
@retval list (available since OpenTX 2.1.7) returns two values:
|
||||
@retval list (available since 2.1.7) returns two values:
|
||||
* `string` OpenTX version (ie "2.1.5")
|
||||
* `string` radio version: `taranisx9e`, `taranisplus` or `taranis`.
|
||||
If running in simulator the "-simu" is added
|
||||
|
|
@ -99,7 +99,7 @@ end
|
|||
|
||||
return { run=run }
|
||||
```
|
||||
Output of above script in simulator:
|
||||
Output of the above script in simulator:
|
||||
```
|
||||
version: 2.1.7
|
||||
radio: taranis-simu
|
||||
|
|
@ -116,7 +116,7 @@ static int luaGetVersion(lua_State *L)
|
|||
/*luadoc
|
||||
@function getTime()
|
||||
|
||||
Returns the time since the radio was started in multiple of 10ms
|
||||
Return the time since the radio was started in multiple of 10ms
|
||||
|
||||
@retval number Number of 10ms ticks since the radio was started Example:
|
||||
run time: 12.54 seconds, return value: 1254
|
||||
|
|
@ -144,15 +144,15 @@ static void luaPushDateTime(lua_State *L, uint32_t year, uint32_t mon, uint32_t
|
|||
/*luadoc
|
||||
@function getDateTime()
|
||||
|
||||
Returns current system date and time that is kept by the RTC unit
|
||||
Return current system date and time that is kept by the RTC unit
|
||||
|
||||
@retval table current date and time, table elements:
|
||||
* `year` year
|
||||
* `mon` month
|
||||
* `day` day of month
|
||||
* `hour` hours
|
||||
* `min` minutes
|
||||
* `sec` seconds
|
||||
* `year` (number) year
|
||||
* `mon` (number) month
|
||||
* `day` (number) day of month
|
||||
* `hour` (number) hours
|
||||
* `min` (number) minutes
|
||||
* `sec` (number) seconds
|
||||
*/
|
||||
static int luaGetDateTime(lua_State *L)
|
||||
{
|
||||
|
|
@ -323,7 +323,7 @@ bool luaFindFieldByName(const char * name, LuaField & field, unsigned int flags=
|
|||
/*luadoc
|
||||
@function getFieldInfo(name)
|
||||
|
||||
Returns detailed information about field (source)
|
||||
Return detailed information about field (source)
|
||||
|
||||
@param name (string) name of the field
|
||||
|
||||
|
|
@ -361,7 +361,7 @@ The list of valid sources is available:
|
|||
* for OpenTX 2.1.x at http://downloads-21.open-tx.org/firmware/lua_fields.txt
|
||||
|
||||
In OpenTX 2.1.x the telemetry sources no longer have a predefined name.
|
||||
To get a telemetry value simply use its sensor name. For example:
|
||||
To get a telemetry value simply use it's sensor name. For example:
|
||||
* Altitude sensor has a name "Alt"
|
||||
* to get the current altitude use the source "Alt"
|
||||
* to get the minimum altitude use the source "Alt-", to get the maximum use "Alt+"
|
||||
|
|
@ -374,18 +374,17 @@ or a name (string) of the source.
|
|||
* for all telemetry source when the telemetry stream is not received
|
||||
|
||||
@retval table GPS position is returned in a table:
|
||||
* `lat` latitude, positive is North (number)
|
||||
* `lon` longitude, positive is East (number)
|
||||
* `lat` (number) latitude, positive is North
|
||||
* `lon` (number) longitude, positive is East
|
||||
|
||||
@retval table GPS date/time is returned in a table, format is the same
|
||||
as is returned from getDateTime()
|
||||
@retval table GPS date/time, see getDateTime()
|
||||
|
||||
@retval table Cells are returned in a table
|
||||
(except where no cells were detected in which
|
||||
case the returned value is 0):
|
||||
* table has one item for each detected cell
|
||||
* each item name is the cell number (1 to number of cells)
|
||||
* each item value is the current cell voltage
|
||||
* table has one item for each detected cell:
|
||||
* key (number) cell number (1 to number of cells)
|
||||
* value (number) current cell voltage
|
||||
|
||||
@status current Introduced in 2.0.0, changed in 2.1.0
|
||||
|
||||
|
|
@ -413,11 +412,11 @@ static int luaGetValue(lua_State *L)
|
|||
/*luadoc
|
||||
@function playFile(name)
|
||||
|
||||
Plays a file from the SD card
|
||||
Play a file from the SD card
|
||||
|
||||
@param path (string) full path to wav file (i.e. “/SOUNDS/en/system/tada.wav”)
|
||||
Introduced in 2.1.0: If you use a relative path, the current language is appended
|
||||
to the path (example for English language: `/SOUNDS/en` is appended)
|
||||
to the path (example: for English language: `/SOUNDS/en` is appended)
|
||||
|
||||
@status current Introduced in 2.0.0, changed in 2.1.0
|
||||
*/
|
||||
|
|
@ -441,7 +440,7 @@ static int luaPlayFile(lua_State *L)
|
|||
/*luadoc
|
||||
@function playNumber(value, unit [, attributes])
|
||||
|
||||
Plays a numerical value (text to speech)
|
||||
Play a numerical value (text to speech)
|
||||
|
||||
@param value (number) number to play. Value is interpreted as integer.
|
||||
|
||||
|
|
@ -466,7 +465,7 @@ static int luaPlayNumber(lua_State *L)
|
|||
/*luadoc
|
||||
@function playDuration(duration [, hourFormat])
|
||||
|
||||
Plays a time value (text to speech)
|
||||
Play a time value (text to speech)
|
||||
|
||||
@param duration (number) number of seconds to play. Only integral part is used.
|
||||
|
||||
|
|
@ -487,7 +486,7 @@ static int luaPlayDuration(lua_State *L)
|
|||
/*luadoc
|
||||
@function playTone(frequency, duration, pause [, flags [, freqIncr]])
|
||||
|
||||
Plays a tone
|
||||
Play a tone
|
||||
|
||||
@param frequency (number) tone frequency in Hz
|
||||
|
||||
|
|
@ -519,16 +518,14 @@ static int luaPlayTone(lua_State *L)
|
|||
}
|
||||
|
||||
/*luadoc
|
||||
@function killEvents(eventMask)
|
||||
@function killEvents(key)
|
||||
|
||||
Cancels the key press propagation to the normal user interface algorithm.
|
||||
Stops key state machine.
|
||||
|
||||
@param eventMask (number) events to be suppressed
|
||||
@param key (number) key to be killed, can also include event type (only key part is used)
|
||||
|
||||
@status current Introduced in 2.0.0
|
||||
|
||||
@notice This function has currently no effect in OpenTX 2.1.x series
|
||||
|
||||
TODO table of events/masks
|
||||
*/
|
||||
static int luaKillEvents(lua_State *L)
|
||||
|
|
@ -541,7 +538,7 @@ static int luaKillEvents(lua_State *L)
|
|||
/*luadoc
|
||||
@function GREY()
|
||||
|
||||
Returns gray value which can be used in lcd functions
|
||||
Returns gray value which can be used in LCD functions
|
||||
|
||||
@retval (number) a value that represents amount of *greyness* (from 0 to 15)
|
||||
|
||||
|
|
@ -559,9 +556,9 @@ static int luaGrey(lua_State *L)
|
|||
Returns (some of) the general radio settings
|
||||
|
||||
@retval table with elements:
|
||||
* `battMin` radio battery range - minimum value
|
||||
* `battMax` radio battery range - maximum value
|
||||
* `imperial` set to a value different from 0 if the radio is set to the
|
||||
* `battMin` (number) radio battery range - minimum value
|
||||
* `battMax` (number) radio battery range - maximum value
|
||||
* `imperial` (number) set to a value different from 0 if the radio is set to the
|
||||
IMPERIAL units
|
||||
|
||||
@status current Introduced in 2.0.6, `imperial` added in TODO
|
||||
|
|
@ -580,7 +577,7 @@ static int luaGetGeneralSettings(lua_State *L)
|
|||
/*luadoc
|
||||
@function popupInput(title, event, input, min, max)
|
||||
|
||||
Raises a popup on screen that allows uses input
|
||||
Raises a pop-up on screen that allows uses input
|
||||
|
||||
@param title (string) text to display
|
||||
|
||||
|
|
|
|||
|
|
@ -42,7 +42,9 @@
|
|||
/*luadoc
|
||||
@function lcd.lock()
|
||||
|
||||
@notice This function has no effect in OpenTX 2.1
|
||||
@status depreciated since 2.1
|
||||
|
||||
@notice This function has no effect in OpenTX 2.1 and will be removed in 2.2
|
||||
*/
|
||||
static int luaLcdLock(lua_State *L)
|
||||
{
|
||||
|
|
@ -54,7 +56,9 @@ static int luaLcdLock(lua_State *L)
|
|||
/*luadoc
|
||||
@function lcd.clear()
|
||||
|
||||
Erases all contents of LCD.
|
||||
Clears the LCD screen
|
||||
|
||||
@status current Introduced in 2.0.0
|
||||
|
||||
@notice This function only works in stand-alone and telemetry scripts.
|
||||
*/
|
||||
|
|
@ -67,13 +71,17 @@ static int luaLcdClear(lua_State *L)
|
|||
/*luadoc
|
||||
@function lcd.drawPoint(x, y)
|
||||
|
||||
Draws a single pixel on LCD
|
||||
Draws a single pixel at (x,y) position
|
||||
|
||||
@param x (positive number) x position, starts from 0 in top left corner.
|
||||
@param x (positive number) x position
|
||||
|
||||
@param y (positive number) y position, starts from 0 in top left corner and goes down.
|
||||
@param y (positive number) y position
|
||||
|
||||
@notice Drawing on an existing black pixel produces white pixel (TODO check this!)
|
||||
@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!)
|
||||
|
||||
@status current Introduced in 2.0.0
|
||||
*/
|
||||
static int luaLcdDrawPoint(lua_State *L)
|
||||
{
|
||||
|
|
@ -99,6 +107,8 @@ Draws a straight line on LCD
|
|||
|
||||
@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)
|
||||
|
||||
@status current Introduced in 2.0.0
|
||||
*/
|
||||
static int luaLcdDrawLine(lua_State *L)
|
||||
{
|
||||
|
|
@ -113,12 +123,43 @@ static int luaLcdDrawLine(lua_State *L)
|
|||
return 0;
|
||||
}
|
||||
|
||||
/*luadoc
|
||||
@function lcd.getLastPos()
|
||||
|
||||
Returns the last x position from previous output
|
||||
|
||||
@retval number (integer) x position
|
||||
|
||||
@status current Introduced in 2.0.0
|
||||
*/
|
||||
static int luaLcdGetLastPos(lua_State *L)
|
||||
{
|
||||
lua_pushinteger(L, lcdLastPos);
|
||||
return 1;
|
||||
}
|
||||
|
||||
/*luadoc
|
||||
@function lcd.drawText(x, y, text [, flags])
|
||||
|
||||
Draws a text beginning at (x,y)
|
||||
|
||||
@param x,y (positive numbers) starting coordinate
|
||||
|
||||
@param text (string) text to display
|
||||
|
||||
@param flags (unsigned number) drawing flags. All values can be
|
||||
combined together using the + character. ie BLINK + DBLSIZE.
|
||||
See the Appendix 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
|
||||
|
||||
@status current Introduced in 2.0.0
|
||||
*/
|
||||
static int luaLcdDrawText(lua_State *L)
|
||||
{
|
||||
if (!luaLcdAllowed) return 0;
|
||||
|
|
@ -130,6 +171,22 @@ static int luaLcdDrawText(lua_State *L)
|
|||
return 0;
|
||||
}
|
||||
|
||||
/*luadoc
|
||||
@function lcd.drawTimer(x, y, value [, flags])
|
||||
|
||||
Display a value formatted as time at (x,y)
|
||||
|
||||
@param x,y (positive numbers) starting coordinate
|
||||
|
||||
@param value (number) time in seconds
|
||||
|
||||
@param flags (unsigned number) drawing flags:
|
||||
* `0 or not specified` normal representation (minutes and seconds)
|
||||
* `TIMEHOUR` display hours
|
||||
* other general LCD flag also apply
|
||||
|
||||
@status current Introduced in 2.0.0
|
||||
*/
|
||||
static int luaLcdDrawTimer(lua_State *L)
|
||||
{
|
||||
if (!luaLcdAllowed) return 0;
|
||||
|
|
@ -145,6 +202,23 @@ static int luaLcdDrawTimer(lua_State *L)
|
|||
return 0;
|
||||
}
|
||||
|
||||
/*luadoc
|
||||
@function lcd.drawNumber(x, y, value [, flags])
|
||||
|
||||
Display a number at (x,y)
|
||||
|
||||
@param x,y (positive numbers) starting coordinate
|
||||
|
||||
@param value (number) value to display
|
||||
|
||||
@param flags (unsigned number) drawing flags:
|
||||
* `0 or not specified` normal representation
|
||||
* `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 flag also apply
|
||||
|
||||
@status current Introduced in 2.0.0
|
||||
*/
|
||||
static int luaLcdDrawNumber(lua_State *L)
|
||||
{
|
||||
if (!luaLcdAllowed) return 0;
|
||||
|
|
@ -163,6 +237,20 @@ static int luaLcdDrawNumber(lua_State *L)
|
|||
return 0;
|
||||
}
|
||||
|
||||
/*luadoc
|
||||
@function lcd.drawChannel(x, y, source, flags)
|
||||
|
||||
Display a telemetry value at (x,y)
|
||||
|
||||
@param x,y (positive numbers) starting coordinate
|
||||
|
||||
@param source can be a source identifier (number) or a source name (string).
|
||||
See getValue()
|
||||
|
||||
@param flags (unsigned number) drawing flags
|
||||
|
||||
@status current Introduced in 2.0.6, changed in 2.1.0 (only telemetry sources are valid)
|
||||
*/
|
||||
static int luaLcdDrawChannel(lua_State *L)
|
||||
{
|
||||
if (!luaLcdAllowed) return 0;
|
||||
|
|
@ -186,6 +274,20 @@ static int luaLcdDrawChannel(lua_State *L)
|
|||
return 0;
|
||||
}
|
||||
|
||||
/*luadoc
|
||||
@function lcd.drawSwitch(x, y, switch, flags)
|
||||
|
||||
Draws a text representation of switch at (x,y)
|
||||
|
||||
@param x,y (positive numbers) starting coordinate
|
||||
|
||||
@param switch (number) number of switch to display, negative number
|
||||
displays negated switch
|
||||
|
||||
@param flags (unsigned number) drawing flags, only SMLSIZE, BLINK and INVERS.
|
||||
|
||||
@status current Introduced in 2.0.0
|
||||
*/
|
||||
static int luaLcdDrawSwitch(lua_State *L)
|
||||
{
|
||||
if (!luaLcdAllowed) return 0;
|
||||
|
|
@ -197,6 +299,19 @@ static int luaLcdDrawSwitch(lua_State *L)
|
|||
return 0;
|
||||
}
|
||||
|
||||
/*luadoc
|
||||
@function lcd.drawSource(x, y, source [, flags])
|
||||
|
||||
Displays the name of the corresponding input as defined by the source at (x,y)
|
||||
|
||||
@param x,y (positive numbers) starting coordinate
|
||||
|
||||
@param source (number) source index
|
||||
|
||||
@param flags (unsigned number) drawing flags
|
||||
|
||||
@status current Introduced in 2.0.0
|
||||
*/
|
||||
static int luaLcdDrawSource(lua_State *L)
|
||||
{
|
||||
if (!luaLcdAllowed) return 0;
|
||||
|
|
@ -208,6 +323,19 @@ static int luaLcdDrawSource(lua_State *L)
|
|||
return 0;
|
||||
}
|
||||
|
||||
/*luadoc
|
||||
@function lcd.drawPixmap(x, y, name)
|
||||
|
||||
Draws a bitmap at (x,y)
|
||||
|
||||
@param x,y (positive numbers) starting coordinate
|
||||
|
||||
@param name (string) full path to the bitmap on SD card (i.e. “/BMP/test.bmp”)
|
||||
|
||||
@notice Only available on monochrome screens
|
||||
|
||||
@status current Introduced in 2.0.0
|
||||
*/
|
||||
#if !defined(COLORLCD)
|
||||
static int luaLcdDrawPixmap(lua_State *L)
|
||||
{
|
||||
|
|
@ -224,6 +352,21 @@ static int luaLcdDrawPixmap(lua_State *L)
|
|||
}
|
||||
#endif
|
||||
|
||||
/*luadoc
|
||||
@function lcd.drawRectangle(x, y, w, h [, flags])
|
||||
|
||||
Draws a rectangle from top left corner (x,y) of specified width and height
|
||||
|
||||
@param x,y (positive numbers) top left corner position
|
||||
|
||||
@param w (number) width in pixels
|
||||
|
||||
@param h (number) height in pixels
|
||||
|
||||
@param flags (unsigned number) drawing flags
|
||||
|
||||
@status current Introduced in 2.0.0
|
||||
*/
|
||||
static int luaLcdDrawRectangle(lua_State *L)
|
||||
{
|
||||
if (!luaLcdAllowed) return 0;
|
||||
|
|
@ -236,6 +379,21 @@ static int luaLcdDrawRectangle(lua_State *L)
|
|||
return 0;
|
||||
}
|
||||
|
||||
/*luadoc
|
||||
@function lcd.drawFilledRectangle(x, y, w, h [, flags])
|
||||
|
||||
Draws a solid rectangle from top left corner (x,y) of specified width and height
|
||||
|
||||
@param x,y (positive numbers) top left corner position
|
||||
|
||||
@param w (number) width in pixels
|
||||
|
||||
@param h (number) height in pixels
|
||||
|
||||
@param flags (unsigned number) drawing flags
|
||||
|
||||
@status current Introduced in 2.0.0
|
||||
*/
|
||||
static int luaLcdDrawFilledRectangle(lua_State *L)
|
||||
{
|
||||
if (!luaLcdAllowed) return 0;
|
||||
|
|
@ -248,6 +406,25 @@ static int luaLcdDrawFilledRectangle(lua_State *L)
|
|||
return 0;
|
||||
}
|
||||
|
||||
/*luadoc
|
||||
@function lcd.drawGauge(x, y, w, h, fill, maxfill)
|
||||
|
||||
Draws a simple gauge that is filled based upon fill value
|
||||
|
||||
@param x,y (positive numbers) top left corner position
|
||||
|
||||
@param w (number) width in pixels
|
||||
|
||||
@param h (number) height in pixels
|
||||
|
||||
@param fill (number) amount of fill to apply
|
||||
|
||||
@param maxfill (number) total value of fill
|
||||
|
||||
@param flags (unsigned number) drawing flags
|
||||
|
||||
@status current Introduced in 2.0.0
|
||||
*/
|
||||
static int luaLcdDrawGauge(lua_State *L)
|
||||
{
|
||||
if (!luaLcdAllowed) return 0;
|
||||
|
|
@ -266,6 +443,22 @@ static int luaLcdDrawGauge(lua_State *L)
|
|||
return 0;
|
||||
}
|
||||
|
||||
/*luadoc
|
||||
@function lcd.drawScreenTitle(title, page, pages)
|
||||
|
||||
Draws a title bar
|
||||
|
||||
@param title (string) text for the title
|
||||
|
||||
@param page (number) page number
|
||||
|
||||
@param 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`)
|
||||
|
||||
@notice Only available on monochrome screens
|
||||
|
||||
@status current Introduced in 2.0.0
|
||||
*/
|
||||
#if !defined(COLORLCD)
|
||||
static int luaLcdDrawScreenTitle(lua_State *L)
|
||||
{
|
||||
|
|
@ -282,6 +475,28 @@ static int luaLcdDrawScreenTitle(lua_State *L)
|
|||
}
|
||||
#endif
|
||||
|
||||
/*luadoc
|
||||
@function lcd.drawCombobox(x, y, w, list, idx [, flags])
|
||||
|
||||
Draws a combo box
|
||||
|
||||
@param x,y (positive numbers) top left corner position
|
||||
|
||||
@param w (number) width of combo box in pixels
|
||||
|
||||
@param list (table) combo box elements, each element is a string
|
||||
|
||||
@param idx (integer) index of entry to highlight
|
||||
|
||||
@param page (number) page number
|
||||
|
||||
@param 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
|
||||
|
||||
@status current Introduced in 2.0.0
|
||||
*/
|
||||
static int luaLcdDrawCombobox(lua_State *L)
|
||||
{
|
||||
if (!luaLcdAllowed) return 0;
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue