From e5ef862729167dbabc0d1c0f06db7640cea7bd70 Mon Sep 17 00:00:00 2001 From: Damjan Adamic Date: Thu, 12 Nov 2015 22:02:16 +0100 Subject: [PATCH] Docs added --- radio/src/lua_api.cpp | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/radio/src/lua_api.cpp b/radio/src/lua_api.cpp index 61da20c38..5098036f3 100644 --- a/radio/src/lua_api.cpp +++ b/radio/src/lua_api.cpp @@ -129,7 +129,29 @@ Returns OpenTX version @retval list (available since OpenTX 2.1.7) returns two values: * `string` OpenTX version (ie "2.1.5") - * `string` radio version (ie "Taranis", "TaranisPlus", if running in simulator the "-simu" is added) + * `string` radio version: `taranisx9e`, `taranisplus` or `taranis`. +If running in simulator the "-simu" is added + +### Example + +This example also runs in OpenTX versions where the radio version was not available: + +```lua +local function run(event) + local ver, radio = getVersion() + print("version: "..ver) + if radio then print ("radio: "..radio) end + return 1 +end + +return { run=run } +``` +Output of above script in simulator: +``` +version: 2.1.7 +radio: taranis-simu +Script finished with status 1 +``` */ static int luaGetVersion(lua_State *L) {