Start of 2.2 branch

Author: projectkk2glider

Bitmap/Bitmap_functions.md

@@ -0,0 +1,2 @@
+# Bitmap Functions
+

Bitmap/getSize.md

@@ -0,0 +1,25 @@
+<!-- This file was generated by the script. Do not edit it, any changes will be lost! -->
+
+## Bitmap.getSize(name)
+
+
+
+Return width, heigh of a bitmap in memory
+
+@status current Introduced in 2.2.0
+
+
+#### Parameters
+
+* `bitmap` (pointer) point to a bitmap previously opened with Bipmap.open()
+
+
+
+#### Return value
+
+none
+
+##### Notice
+Only available on color screens
+
+

Bitmap/open.md

@@ -0,0 +1,25 @@
+<!-- This file was generated by the script. Do not edit it, any changes will be lost! -->
+
+## Bitmap.open(name)
+
+
+
+Loads a bitmap in memory, for later use with lcd.drawBitmap()
+
+@status current Introduced in 2.2.0
+
+
+#### Parameters
+
+* `name` (string) full path to the bitmap on SD card (i.e. “/IMAGES/test.bmp”)
+
+
+
+#### Return value
+
+none
+
+##### Notice
+Only available on color screens
+
+

README.md

@@ -2,9 +2,9 @@
 
 [[![Join the chat at https://opentx.rocket.chat](https://camo.githubusercontent.com/3d659054abd6ce21c0e47cf3b83a51bda69ca282/68747470733a2f2f64656d6f2e726f636b65742e636861742f696d616765732f6a6f696e2d636861742e737667)](https://opentx.rocket.chat)]()
 
-Go to https://www.gitbook.com/book/opentx/opentx-lua-reference-guide/details for the latest published version of this guide.
+Go to https://opentx.gitbooks.io/opentx-2-2-lua-reference-guide/content/ for the latest published version of this guide.
 
-This guide covers the development of user-written scripts for R/C transmitters running the OpenTX 2.1 operating system with Lua support. Readers should be familiar with OpenTX, the OpenTX Companion, and know how to transfer files the SD card in the transmitter.
+This guide covers the development of user-written scripts for R/C transmitters running the OpenTX 2.2 operating system with Lua support. Readers should be familiar with OpenTX, the OpenTX Companion, and know how to transfer files the SD card in the transmitter.
 
 Part I of the guide shows how to enable Lua support for Taranis and includes basic examples of each types of script.
 
@@ -14,7 +14,9 @@ Part III is the OpenTX Lua API Reference
 
 Part IV addresses common issues in converting Lua scripts that were originally written for OpenTX 2.0
 
-Part V covers advanced topics with examples
+Part V addresses common issues in converting Lua scripts that were originally written for OpenTX 2.1
+
+Part VI covers advanced topics with examples
 
 
 

SUMMARY.md

@@ -1,6 +1,6 @@
 # Summary
 
-* [OpenTX 2.1 Lua Reference Guide](README.md)
+* [OpenTX 2.2 Lua Reference Guide](README.md)
    * [Introduction](introduction.md)
        * [Acknowledgments](acknowledgments.md)
        * [Getting Started](getting_started.md)
@@ -28,21 +28,30 @@
        * [Key Event Constants](key_events.md) 
    * [General Functions](general/general_functions.md) [//]: <> (LUADOC-BEGIN:general)
       * [GREY()](general/GREY.md)
+      * [crossfireTelemetryPop()](general/crossfireTelemetryPop.md)
+      * [crossfireTelemetryPush()](general/crossfireTelemetryPush.md)
       * [defaultChannel(stick)](general/defaultChannel.md)
       * [defaultStick(channel)](general/defaultStick.md)
       * [getDateTime()](general/getDateTime.md)
       * [getFieldInfo(name)](general/getFieldInfo.md)
       * [getFlightMode(mode)](general/getFlightMode.md)
       * [getGeneralSettings()](general/getGeneralSettings.md)
+      * [getRAS()](general/getRAS.md)
+      * [getRSSI()](general/getRSSI.md)
       * [getTime()](general/getTime.md)
       * [getValue(source)](general/getValue.md)
       * [getVersion()](general/getVersion.md)
       * [killEvents(key)](general/killEvents.md)
+      * [luaPlayHaptic(duration, pause [, flags])](general/luaPlayHaptic.md)
       * [playDuration(duration [, hourFormat])](general/playDuration.md)
       * [playFile(name)](general/playFile.md)
       * [playNumber(value, unit [, attributes])](general/playNumber.md)
       * [playTone(frequency, duration, pause [, flags [, freqIncr]])](general/playTone.md)
-      * [popupInput(title, event, input, min, max)](general/popupInput.md) [//]: <> (LUADOC-END:general)
+      * [popupConfirmation(title, event)](general/popupConfirmation.md)
+      * [popupInput(title, event, input, min, max)](general/popupInput.md)
+      * [popupWarning(title, event)](general/popupWarning.md)
+      * [sportTelemetryPop()](general/sportTelemetryPop.md)
+      * [sportTelemetryPush()](general/sportTelemetryPush.md) [//]: <> (LUADOC-END:general)
    * [Model Functions](model/model_functions.md) [//]: <> (LUADOC-BEGIN:model)
       * [model.defaultInputs()](model/defaultInputs.md)
       * [model.deleteInput(input, line)](model/deleteInput.md)
@@ -73,11 +82,13 @@
       * [model.setTimer(timer, value)](model/setTimer.md) [//]: <> (LUADOC-END:model)
    * [Lcd Functions](lcd/lcd_functions.md) [//]: <> (LUADOC-BEGIN:lcd)
       * [Lcd Functions Overview](lcd/lcd_functions-overview.md)
+      * [lcd.RGB(r, g, b)](lcd/RGB.md)
       * [lcd.clear()](lcd/clear.md)
+      * [lcd.drawBitmap(bitmap, x, y [, scale])](lcd/drawBitmap.md)
       * [lcd.drawChannel(x, y, source, flags)](lcd/drawChannel.md)
       * [lcd.drawCombobox(x, y, w, list, idx [, flags])](lcd/drawCombobox.md)
       * [lcd.drawFilledRectangle(x, y, w, h [, flags])](lcd/drawFilledRectangle.md)
-      * [lcd.drawGauge(x, y, w, h, fill, maxfill)](lcd/drawGauge.md)
+      * [lcd.drawGauge(x, y, w, h, fill, maxfill [, flags])](lcd/drawGauge.md)
       * [lcd.drawLine(x1, y1, x2, y2, pattern, flags)](lcd/drawLine.md)
       * [lcd.drawNumber(x, y, value [, flags])](lcd/drawNumber.md)
       * [lcd.drawPixmap(x, y, name)](lcd/drawPixmap.md)
@@ -89,12 +100,17 @@
       * [lcd.drawText(x, y, text [, flags])](lcd/drawText.md)
       * [lcd.drawTimer(x, y, value [, flags])](lcd/drawTimer.md)
       * [lcd.getLastPos()](lcd/getLastPos.md)
-      * [lcd.lock()](lcd/lock.md) [//]: <> (LUADOC-END:lcd)
+      * [lcd.refresh()](lcd/refresh.md)
+      * [lcd.setColor(area, color)](lcd/setColor.md) [//]: <> (LUADOC-END:lcd)
+   * [Bitmap Functions](Bitmap/Bitmap_functions.md) [//]: <> (LUADOC-BEGIN:Bitmap)
+      * [Bitmap.getSize(name)](Bitmap/getSize.md)
+      * [Bitmap.open(name)](Bitmap/open.md) [//]: <> (LUADOC-END:Bitmap)
 * [Part IV - Converting OpenTX 2.0 Scripts](part_iv_-_converting_opentx_20_scripts.md)
    * [General Issues](known_issues.md)
    * [Handling GPS Sensor data](handling_gps_sensor_data.md)
    * [Handling Lipo Sensor Data](handling_lipo_sensor_data.md)
-* [Part V - Advanced Topics](part_v_-_advanced_topics.md)
+* [Part V - Converting OpenTX 2.1 Scripts](part_v_-_converting_opentx_21_scripts.md)
+* [Part VI - Advanced Topics](part_vi_-_advanced_topics.md)
    * [Lua data sharing across scripts](lua_data_sharing_across_scripts.md)
    * [Debugging techniques](debugging_techniques.md)
 

function_scripts.md

@@ -17,7 +17,7 @@ Function scripts are invoked via the **'Lua Script'** option of Special Function
 
 * should not exceed allowed run-time/ number of instructions.
 * all function scripts are stopped while one-time script is running (see Lua One-time scripts)
-* Version 2.1 function scripts **DO NOT HAVE ACCESS TO LCD DISPLAY**
+* Function scripts **DO NOT HAVE ACCESS TO LCD DISPLAY**
 
 ##### Location
 

general/crossfireTelemetryPop.md

@@ -0,0 +1,23 @@
+<!-- This file was generated by the script. Do not edit it, any changes will be lost! -->
+
+## crossfireTelemetryPop()
+
+
+
+@status current Introduced in 2.2.0
+
+
+#### Parameters
+
+none
+
+#### Return value
+
+* `SPORT` paket as a quadruple:
+ * sensor ID (number)
+ * frame ID (number)
+ * data ID (number)
+ * value (number)
+
+
+

general/crossfireTelemetryPush.md

@@ -0,0 +1,31 @@
+<!-- This file was generated by the script. Do not edit it, any changes will be lost! -->
+
+## crossfireTelemetryPush()
+
+
+
+This functions allows for sending telemetry data toward the TBS Crossfire link.
+
+When called without parameters, it will only return the status of the ouput buffer without sending anything.
+
+@status current Introduced in 2.2.0
+
+
+#### Parameters
+
+* `sensorId`  physical sensor ID
+
+* `frameId`   frame ID
+
+* `dataId`    data ID
+
+* `value`     value
+
+
+
+#### Return value
+
+* `boolean`  data queued in output buffer or not.
+
+
+

general/defaultChannel.md

@@ -4,7 +4,7 @@
 
 
 
-Get channel assigned to stick. See Default Channel Order in General Settings 
+Get channel assigned to stick. See Default Channel Order in General Settings
 
 @status current Introduced in 2.0.0
 

general/getFieldInfo.md

@@ -12,12 +12,6 @@ The list of valid sources is available:
 * 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:
- * 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+"
-
 @status current Introduced in 2.0.8
 
 
@@ -30,9 +24,9 @@ To get a telemetry value simply use it's sensor name. For example:
 #### Return value
 
 * `table` information about requested field, table elements:
- * `id`   (number) field identifier 
- * `name` (string) field name 
- * `desc` (string) field description 
+ * `id`   (number) field identifier
+ * `name` (string) field name
+ * `desc` (string) field description
 
 * `nil` the requested field was not found