mirror of
https://github.com/opentx/opentx.git
synced 2025-07-15 12:25:12 +03:00
Lua docs updated
This commit is contained in:
parent
a4d899844e
commit
4233e71954
3 changed files with 28 additions and 13 deletions
|
@ -514,7 +514,9 @@ Returns the value of a source.
|
|||
|
||||
The list of valid sources is available:
|
||||
* for OpenTX 2.0.x at http://downloads-20.open-tx.org/firmware/lua_fields.txt
|
||||
* for OpenTX 2.1.x at http://downloads-21.open-tx.org/firmware/lua_fields.txt
|
||||
* for OpenTX 2.1.x at http://downloads-21.open-tx.org/firmware/lua_fields.txt (depreciated)
|
||||
* for OpenTX 2.1.x Taranis and Taranis Plus at http://downloads-21.open-tx.org/firmware/lua_fields_taranis.txt
|
||||
* for OpenTX 2.1.x Taranis X9E at http://downloads-21.open-tx.org/firmware/lua_fields_taranis_x9e.txt
|
||||
|
||||
In OpenTX 2.1.x the telemetry sources no longer have a predefined name.
|
||||
To get a telemetry value simply use it's sensor name. For example:
|
||||
|
@ -578,6 +580,8 @@ Return the RAS value or nil if no valid hardware found
|
|||
@retval number representing RAS value. Value bellow 0x33 (51 decimal) are all ok, value above 0x33 indicate a hardware antenna issue.
|
||||
This is just a hardware pass/fail measure and does not represent the quality of the radio link
|
||||
|
||||
@notice RAS was called SWR in the past
|
||||
|
||||
@status current Introduced in 2.2.0
|
||||
*/
|
||||
static int luaGetRAS(lua_State * L)
|
||||
|
@ -842,6 +846,9 @@ Returns gray value which can be used in LCD functions
|
|||
|
||||
@retval (number) a value that represents amount of *greyness* (from 0 to 15)
|
||||
|
||||
@notice Only available on Taranis
|
||||
|
||||
@status current Introduced in 2.0.13
|
||||
*/
|
||||
static int luaGrey(lua_State * L)
|
||||
{
|
||||
|
@ -865,7 +872,7 @@ Returns (some of) the general radio settings
|
|||
* `voice` (string) voice language (used for speech)
|
||||
|
||||
@status current Introduced in 2.0.6, `imperial` added in TODO,
|
||||
`language` and `voice` added int 2.2.0.
|
||||
`language` and `voice` added in 2.2.0.
|
||||
|
||||
*/
|
||||
static int luaGetGeneralSettings(lua_State * L)
|
||||
|
@ -1039,6 +1046,8 @@ static int luaDefaultStick(lua_State * L)
|
|||
* `present` Sensor takes name of the argument. Argument must have name surrounded by quotes: e.g., "Name"
|
||||
|
||||
@retval true, if the sensor was just added. In this case the value is ignored (subsequent call will set the value)
|
||||
|
||||
@status current Introduced in 2.2.0
|
||||
*/
|
||||
static int luaSetTelemetryValue(lua_State * L)
|
||||
{
|
||||
|
|
|
@ -129,6 +129,8 @@ Returns the last x position from previous output
|
|||
|
||||
@retval number (integer) x position
|
||||
|
||||
@notice Only available on Taranis and X7D
|
||||
|
||||
@status current Introduced in 2.0.0
|
||||
*/
|
||||
static int luaLcdGetLastPos(lua_State *L)
|
||||
|
@ -327,7 +329,7 @@ Loads a bitmap in memory, for later use with lcd.drawBitmap()
|
|||
|
||||
@param name (string) full path to the bitmap on SD card (i.e. “/IMAGES/test.bmp”)
|
||||
|
||||
@notice Only available on color screens
|
||||
@notice Only available on Horus
|
||||
|
||||
@status current Introduced in 2.2.0
|
||||
*/
|
||||
|
@ -366,7 +368,7 @@ Return width, heigh of a bitmap in memory
|
|||
|
||||
@param bitmap (pointer) point to a bitmap previously opened with Bipmap.open()
|
||||
|
||||
@notice Only available on color screens
|
||||
@notice Only available on Horus
|
||||
|
||||
@status current Introduced in 2.2.0
|
||||
*/
|
||||
|
@ -419,7 +421,7 @@ Displays a bitmap at (x,y)
|
|||
|
||||
@param scale (positive numbers) scale in %, 50 divides size by two, 100 is unchanged, 200 doubles size
|
||||
|
||||
@notice Only available on color screens
|
||||
@notice Only available on Horus
|
||||
|
||||
@status current Introduced in 2.2.0
|
||||
*/
|
||||
|
@ -447,7 +449,7 @@ Draw a bitmap at (x,y)
|
|||
|
||||
@param name (string) full path to the bitmap on SD card (i.e. “/IMAGES/test.bmp”)
|
||||
|
||||
@notice Only available on monochrome screens
|
||||
@notice Only available on Taranis
|
||||
|
||||
@status current Introduced in 2.0.0
|
||||
*/
|
||||
|
@ -468,7 +470,7 @@ static int luaLcdDrawPixmap(lua_State *L)
|
|||
#endif
|
||||
|
||||
/*luadoc
|
||||
@function lcd.drawRectangle(x, y, w, h [, flags])
|
||||
@function lcd.drawRectangle(x, y, w, h [, flags [, t]])
|
||||
|
||||
Draw a rectangle from top left corner (x,y) of specified width and height
|
||||
|
||||
|
@ -480,9 +482,9 @@ Draw a rectangle from top left corner (x,y) of specified width and height
|
|||
|
||||
@param flags (unsigned number) drawing flags
|
||||
|
||||
@param t (number) thickness in pixels
|
||||
@param t (number) thickness in pixels, defaults to 1 (only on Horus)
|
||||
|
||||
@status current Introduced in 2.0.0
|
||||
@status current Introduced in 2.0.0, changed in 2.2.0
|
||||
*/
|
||||
static int luaLcdDrawRectangle(lua_State *L)
|
||||
{
|
||||
|
@ -546,7 +548,7 @@ Draw a simple gauge that is filled based upon fill value
|
|||
|
||||
@param flags (unsigned number) drawing flags
|
||||
|
||||
@status current Introduced in 2.0.0
|
||||
@status current Introduced in 2.0.0, changed in 2.2.0
|
||||
*/
|
||||
static int luaLcdDrawGauge(lua_State *L)
|
||||
{
|
||||
|
@ -582,7 +584,7 @@ Draw a title bar
|
|||
@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
|
||||
@notice Only available on Taranis
|
||||
|
||||
@status current Introduced in 2.0.0
|
||||
*/
|
||||
|
@ -622,6 +624,8 @@ Draw a combo box
|
|||
* `INVERS` combo box collapsed, text inversed
|
||||
* `0 or not present` combo box collapsed, text normal
|
||||
|
||||
@notice Only available on Taranis
|
||||
|
||||
@status current Introduced in 2.0.0
|
||||
*/
|
||||
static int luaLcdDrawCombobox(lua_State *L)
|
||||
|
@ -744,6 +748,8 @@ Returns a 5/6/5 rgb color code, that can be used with lcd.setColor
|
|||
|
||||
@retval number (integer) rgb color expressed in 5/6/5 format
|
||||
|
||||
@notice Only available on Horus
|
||||
|
||||
@status current Introduced in 2.2.0
|
||||
*/
|
||||
static int luaRGB(lua_State *L)
|
||||
|
|
|
@ -31,9 +31,9 @@ Get current Model information
|
|||
|
||||
@retval table model information:
|
||||
* `name` (string) model name
|
||||
* `bitmap` (string) bitmap name
|
||||
* `bitmap` (string) bitmap name (not present on X7D)
|
||||
|
||||
@status current Introduced in 2.0.6, changed in TODO
|
||||
@status current Introduced in 2.0.6, changed in 2.2.0
|
||||
*/
|
||||
static int luaModelGetInfo(lua_State *L)
|
||||
{
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue