Added some auto-generated docs

Author: projectkk2glider

.gitignore

@@ -1 +1,3 @@
 /_book/
+/node_modules/
+/book.pdf

SUMMARY.md

@@ -27,48 +27,16 @@
    * [Constants](constants.md)
        * [Key Event Constants](key_events.md)
    * [General Functions](general_functions.md)
-       * [getTime()](gettime.md)
-       * [getDateTime()](getdatetime.md)
-       * [getVersion()](getversion.md)
-       * [getGeneralSettings()](getgeneralsettings.md)
-       * [getValue()](getvalue_function.md)
-       * [getFieldInfo()](getfieldinfo_function.md)
-       * [playFile()](playfile.md)
-       * [playNumber()](playnumber.md)
-       * [playDuration()](playduration.md)
-       * [playTone()](playtone.md)
-       * [popupInput()](popupinput.md)
-       * [defaultStick()](defaultstick.md)
-       * [defaultChannel()](defaultchannel.md)
-       * [killEvents()](killevents.md)
-       * [GREY()](grey.md)
+       * [general.getDateTime()](general/getDateTime.md)
+       * [general.getFieldInfo()](general/getFieldInfo.md)
+       * [general.getTime()](general/getTime.md)
+       * [general.getValue()](general/getValue.md)
+       * [general.getVersion()](general/getVersion.md)
+       * [general.playFile()](general/playFile.md)
    * [Model Functions](model/model_functions.md)
-       * [model.getInfo()](model/modelgetinfo.md)
-       * [model.setInfo()](model/modelsetinfo.md)
-       * [model.getModule()](model/modelgetmodule.md)
-       * [model.setModule()](model/modelsetmodule.md)
-       * [model.getTimer()](model/modelgettimer.md)
-       * [model.setTimer()](model/modelsettimer.md)
-       * [model.resetTimer()](model/modelresettimer.md)
-       * [model.getInputsCount()](model/modelgetinputscount.md)
-       * [model.getInput()](model/modelgetinput.md)
-       * [model.insertInput()](model/modelinsertinput.md)
-       * [model.deleteInput()](model/modeldeleteinput.md)
-       * [model.deleteInputs()](model/modeldeleteinputs.md)
-       * [model.getMixesCount()](model/modelgetmixescount.md)
-       * [model.getMix()](model/modelgetmix.md)
-       * [model.insertMix()](model/modelinsertmix.md)
-       * [model.deleteMix()](model/modeldeletemix.md)
-       * [model.deleteMixes()](model/modeldeletemixes.md)
-       * [model.getLogicalSwitch()](model/modelgetlogicalswitch.md)
-       * [model.setLogicalSwitch()](model/modelsetlogicalswitch.md)
-       * [model.getCustomFunction()](model/modelgetcustomfunction.md)
-       * [model.setCustomFunction()](model/modelsetcustomfunction.md)
-       * [model.getCurve()](model/modelgetcurve.md)
-       * [model.getOutput()](model/modelgetoutput.md)
-       * [model.setOutput()](model/modelsetoutput.md)
-       * [model.getGlobalVariable()](model/modelgetglobalvariable.md)
-       * [model.setGlobalVariable()](model/modelsetglobalvariable.md)
+       * [model.getGlobalVariable()](model/getGlobalVariable.md)
+       * [model.setGlobalVariable()](model/setGlobalVariable.md)
+       * [model.setOutput()](model/setOutput.md)
    * [Display Functions](lcd/display_functions.md)
        * [lcd.lock()](lcd/lcdlock.md)
        * [lcd.clear()](lcd/lcdclear.md)

general/getDateTime.md

@@ -0,0 +1,26 @@
+<!-- This file was generated by the script. Do not edit it, any changes will be lost! -->
+
+## getDateTime()
+
+
+
+#### Parameters
+
+none
+
+#### Return
+
+* `table` current date and time, table elements:
+ * `year` year
+ * `mon` month
+ * `day` day of month
+ * `hour` hours
+ * `min` minutes
+ * `sec` seconds
+
+
+
+---
+Returns current system date and time that is kept by the RTC unit
+
+

general/getFieldInfo.md

@@ -0,0 +1,27 @@
+<!-- This file was generated by the script. Do not edit it, any changes will be lost! -->
+
+## getFieldInfo(name)
+
+
+
+#### Parameters
+
+* `name`  name of the field (string)
+
+
+
+#### Return
+
+* `table` information about requested field, table elements:
+ * `id` field identifier (number)
+ * `name` field name (string)
+ * `desc` field description (string)
+
+* `nil` the requested filed was not found
+
+
+
+---
+Returns detailed information about a field
+
+

general/getTime.md

@@ -0,0 +1,23 @@
+<!-- This file was generated by the script. Do not edit it, any changes will be lost! -->
+
+## getTime()
+
+
+
+#### Parameters
+
+none
+
+#### Return
+
+* `number` current system time. Returned value is the 
+number of 10ms periods since the radio start. Example: 
+ *run time: 12.54 seconds, return value: 1254
+
+
+
+
+---
+Returns current system time
+
+

general/getValue.md

@@ -0,0 +1,42 @@
+<!-- This file was generated by the script. Do not edit it, any changes will be lost! -->
+
+## getValue(name_or_id)
+
+
+
+#### Parameters
+
+* `name_or_id`  identifier (number) or name (string) of the field
+
+
+
+#### Return
+
+* `value` current field value (number). Zero is returned for:
+ * non-existing fields
+ * for all telemetry fields when the telemetry stream is not received
+
+* `table` GPS position is returned in a table:
+ * `lat` latitude, positive is North (number)
+ * `lon` longitude, positive is East (number)
+
+* `table` GPS date/time is returned in a table, format is the same 
+as is returned from getDateTime()
+
+* `table` Cells are returned in a table 
+(except where no cells were detected in which 
+case the returned value is 0):
+ * table has one item for each detected cell
+ * each item name is a cell number (1 to number of cells)
+ * each item value is the current cell voltage
+
+
+
+---
+Returns current value of the requested field. 
+
+
+##### Notice
+Getting a value by its numerical identifier is faster then by its name.
+
+

general/getVersion.md

@@ -0,0 +1,24 @@
+<!-- This file was generated by the script. Do not edit it, any changes will be lost! -->
+
+## getVersion()
+
+
+
+#### Parameters
+
+none
+
+#### Return
+
+* `string` OpenTX version (ie "2.1.5")
+
+* `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)
+
+
+
+---
+Returns OpenTX version
+
+

general/playFile.md

@@ -0,0 +1,23 @@
+<!-- This file was generated by the script. Do not edit it, any changes will be lost! -->
+
+## playFile(name)
+
+
+
+#### 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`)
+
+
+
+
+#### Return
+
+none
+
+---
+Plays a track with given name
+
+

model/getGlobalVariable.md

@@ -0,0 +1,38 @@
+<!-- This file was generated by the script. Do not edit it, any changes will be lost! -->
+
+## model.getGlobalVariable(index [, phase])
+
+
+
+#### Parameters
+
+* `index`  zero based global variable index, use 0 for GV1, 8 for GV9
+
+* `phase`  zero based phase index, use 0 for Phase 1, 5 for Phase 6
+
+
+
+#### Return
+
+* `nil`   requested global variable does not exist
+
+* `number` current value of global variable
+
+
+
+---
+Returns current global variable value. 
+See also model.setGlobalVariable()
+
+Example:
+
+```lua
+  -- get GV3 (index = 2) from flight phase 1 (phase = 0)
+  val = model.getGlobalVariable(2, 0)
+```
+
+
+##### Notice
+a simple warning or notice
+
+

model/setGlobalVariable-example01.md

@@ -0,0 +1,3 @@
+### Example
+
+this is a sample example