Mirror/opentx
1
0
Fork 0
mirror of https://github.com/opentx/opentx.git synced 2025-07-15 04:15:26 +03:00
Code Issues Wiki Activity

Lua docs updated

Browse source
This commit is contained in:
Damjan Adamic 2016-12-11 20:11:56 +01:00
parent a4d899844e
commit 4233e71954
3 changed files with 28 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

13
radio/src/lua/api_general.cpp
View file

@ -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)
{