Auto generated docs updated

Author: projectkk2glider

SUMMARY.md

@@ -28,6 +28,8 @@
        * [Key Event Constants](key_events.md)
    * [General Functions](general_functions.md)
        * [GREY()](general/GREY.md)
+       * [defaultChannel()](general/defaultChannel.md)
+       * [defaultStick()](general/defaultStick.md)
        * [getDateTime()](general/getDateTime.md)
        * [getFieldInfo()](general/getFieldInfo.md)
        * [getGeneralSettings()](general/getGeneralSettings.md)
@@ -39,8 +41,15 @@
        * [playFile()](general/playFile.md)
        * [playNumber()](general/playNumber.md)
        * [playTone()](general/playTone.md)
+       * [popupInput()](general/popupInput.md)
    * [Model Functions](model/model_functions.md)
+       * [model.defaultInputs()](model/defaultInputs.md)
+       * [model.deleteInput()](model/deleteInput.md)
+       * [model.deleteInputs()](model/deleteInputs.md)
        * [model.getGlobalVariable()](model/getGlobalVariable.md)
+       * [model.getInput()](model/getInput.md)
+       * [model.getInputsCount()](model/getInputsCount.md)
+       * [model.insertInput()](model/insertInput.md)
        * [model.setGlobalVariable()](model/setGlobalVariable.md)
        * [model.setOutput()](model/setOutput.md)
    * [Display Functions](lcd/display_functions.md)

general/getFieldInfo.md

@@ -4,23 +4,25 @@
 
 
 
-Returns detailed information about a field
+Returns detailed information about field (source)
+
+@status current Introduced in 2.0.8
 
 
 #### Parameters
 
-* `name`  name of the field (string)
+* `name` (string) name of the field
 
 
 
 #### Return value
 
 * `table` information about requested field, table elements:
- * `id` field identifier (number)
- * `name` field name (string)
- * `desc` field description (string)
+ * `id`   (number) field identifier 
+ * `name` (string) field name 
+ * `desc` (string) field description 
 
-* `nil` the requested filed was not found
+* `nil` the requested field was not found
 
 
 

general/getGeneralSettings.md

@@ -6,12 +6,13 @@
 
 Returns (some of) the general radio settings
 
+@status current Introduced in 2.0.6, `imperial` added in TODO
 
-#### Parameters
 
-* `index`  zero based global variable index, use 0 for GV1, 8 for GV9
 
+#### Parameters
 
+none
 
 #### Return value
 
@@ -23,4 +24,3 @@ Returns (some of) the general radio settings
 
 
 
-

general/getTime.md

@@ -4,7 +4,9 @@
 
 
 
-Returns current system time
+Returns the time since the radio was started in multiple of 10ms
+
+@status current Introduced in 2.0.0
 
 
 #### Parameters
@@ -13,10 +15,8 @@ none
 
 #### Return value
 
-* `number` current system time. Returned value is the 
-number of 10ms periods since the radio start. Example: 
+* `number` Number of 10ms ticks since the radio was started Example: 
 run time: 12.54 seconds, return value: 1254
 
 
 
-

general/getValue.md

@@ -1,23 +1,36 @@
 <!-- This file was generated by the script. Do not edit it, any changes will be lost! -->
 
-## getValue(name_or_id)
+## getValue(source)
 
 
 
-Returns current value of the requested field. 
+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
+
+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:
+ * 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.0, changed in 2.1.0
 
 
 #### Parameters
 
-* `name_or_id`  identifier (number) or name (string) of the field
+* `source`  can be an identifier (number) (which was obtained by the getFieldInfo())
+or a name (string) of the source.
 
 
 
 #### Return value
 
-* `value` current field value (number). Zero is returned for:
- * non-existing fields
- * for all telemetry fields when the telemetry stream is not received
+* `value` current source value (number). Zero is returned for:
+ * non-existing sources
+ * for all telemetry source when the telemetry stream is not received
 
 * `table` GPS position is returned in a table:
  * `lat` latitude, positive is North (number)

general/getVersion.md

@@ -6,6 +6,8 @@
 
 Returns OpenTX version
 
+@status current Introduced in 2.0.0, expanded in 2.1.7
+
 ### Example
 
 This example also runs in OpenTX versions where the radio version was not available:

general/killEvents.md

@@ -1,15 +1,19 @@
 <!-- This file was generated by the script. Do not edit it, any changes will be lost! -->
 
-## killEvents(event)
+## killEvents(eventMask)
 
 
 
 Cancels the key press propagation to the normal user interface algorithm.
 
+@status current Introduced in 2.0.0
+
+TODO table of events/masks
+
 
 #### Parameters
 
-* `event` (number) event to be suppressed
+* `eventMask` (number) events to be suppressed
 
 
 

general/playDuration.md

@@ -4,7 +4,9 @@
 
 
 
-Plays a numerical value (text to speech)
+Plays a time value (text to speech)
+
+@status current Introduced in 2.1.0
 
 
 #### Parameters
@@ -17,7 +19,6 @@ Plays a numerical value (text to speech)
 
 
 
-
 #### Return value
 
 none

general/playFile.md

@@ -4,15 +4,16 @@
 
 
 
-Plays a track with a given name
+Plays a file from the SD card 
 
+@status current Introduced in 2.0.0, changed in 2.1.0
 
-#### Parameters
 
-* `name` (string) file name (including path) to play. If the path is not 
-absolute (name starts with the `/` character), then the given name is used relative to
-the current language path (example for English language: `/SOUNDS/en`)
+#### Parameters
 
+* `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)
 
 
 

general/playNumber.md

@@ -6,21 +6,22 @@
 
 Plays a numerical value (text to speech)
 
+@status current Introduced in 2.0.0
+
 
 #### Parameters
 
 * `value` (number) number to play. Value is interpreted as integer.
 
 * `unit` (number) unit identifier (see table todo)
 
-* `attributes` possible values:
+* `attributes` (unsigned number) possible values:
  * `0 or not present` plays integral part of the number (for a number 123 it plays 123)
  * `PREC1` plays a number with one decimal place (for a number 123 it plays 12.3)
  * `PREC2` plays a number with two decimal places (for a number 123 it plays 1.23)
 
 
 
-
 #### Return value
 
 none