├── FUNCTIONS ├── 01GtStd │ ├── GtStd.lua │ ├── GtStd.otx │ └── ReadMe.md ├── GoRace │ ├── !Archive │ │ └── GoRace.lua │ ├── GoRace-special-function.png │ ├── GoRace.lua │ ├── GoRace.otx │ ├── GoRace.zip │ └── ReadMe.md └── ReadMe.md ├── LICENSE ├── MIXES ├── GtStd.lua ├── ReadMe.md ├── Sqnc │ ├── ReadMe.md │ ├── Sqnc-Sounds.zip │ └── Sqnc.lua └── hold.lua ├── README.md ├── TELEMETRY ├── 01GtSt │ ├── 01GtSt.lua │ ├── ReadMe.md │ └── TeleGetStd-X7.otx ├── GPS │ ├── !Archive │ │ ├── GPS-BMP.zip │ │ ├── GPS-Log.csv │ │ ├── GPS-Sounds.zip │ │ ├── GPS.lua │ │ ├── GPS2-2018-01-21.lua │ │ ├── GPS2-2018-01-21b.lua │ │ ├── GPS2-X7.otx │ │ └── ReadMe.md │ ├── GPS2-Dutch.zip │ ├── GPS2-English.zip │ ├── GPS2-German.zip │ ├── GPS2-X7.otx │ ├── GPS2.lua │ └── ReadMe.md ├── HeadSpeed │ ├── !Archive │ │ └── ReadMe.md │ ├── ReadMe.md │ ├── hdspd-lua-x7.otx │ └── hdspd.lua ├── LapTmr │ ├── !Archive │ │ ├── LapTmr-2018-01-01.lua │ │ └── ReadMe.md │ ├── LapTimer-X7.otx │ ├── LapTmr-Sounds.zip │ ├── LapTmr.lua │ └── ReadMe.md ├── ReadMe.md ├── _Experiments │ ├── TmTst.lua │ └── TxBtSn.lua └── mAhRmn │ ├── !Archive │ ├── ReadMe.md │ ├── mAhRmain-Sounds.zip │ └── mAhRmn.lua │ ├── ReadMe.md │ ├── mahRe2-sounds.zip │ └── mahRe2.lua └── _CodeLibrary └── Arrow.lua /FUNCTIONS/01GtStd/GtStd.lua: -------------------------------------------------------------------------------- 1 | -- License https://www.gnu.org/licenses/gpl-3.0.en.html 2 | -- OpenTX Lua script 3 | -- FUNCTIONS 4 | -- Place this file in SD Card copy on your computer > /SCRIPTS/FUNCTIONS/.lua 5 | 6 | -- Works On OpenTX Companion Version: 2.2 7 | 8 | -- Author: RC diy 9 | -- Web: http://RCdiy.ca 10 | 11 | -- Description 12 | -- This is an introductory script to introduce some basics with regards to 13 | -- executing a function script. This scripts announces the hours and minutes 14 | -- since midnight. 15 | 16 | -- Global OpenTX variables used 17 | -- None 18 | 19 | -- Global Lua environment variables used 20 | -- None 21 | 22 | -- Variables local to this script 23 | -- must use the word "local" before the variable 24 | 25 | 26 | ----------------------------------------------------------------------------- 27 | ----------------------------------------------------------------------------- 28 | -- Avoid editing below here 29 | ----------------------------------------------------------------------------- 30 | ----------------------------------------------------------------------------- 31 | 32 | local timenow 33 | local timenowSeconds 34 | local hours 35 | local minutes 36 | local seconds 37 | local secondsNext 38 | local secondsGap 39 | 40 | local function init() 41 | secondsNext = 0 42 | secondsGap = 2 43 | end 44 | 45 | local function run() 46 | 47 | timenow = getTime() 48 | timenowSeconds = math.floor(timenow/100) -- 10ms tick count 49 | seconds = timenowSeconds % 60 50 | 51 | minutes = getValue('clock') -- minutes since midnght 52 | hours = minutes/60 53 | minutes = minutes % 60 54 | 55 | -- delay to allow previous announcemenst to complete 56 | if timenowSeconds > secondsNext then 57 | secondsNext = timenowSeconds + secondsGap 58 | -- playNumber(hours, 24, 0) 59 | -- playNumber(minutes, 25, 0) 60 | playNumber(hours, 0) 61 | playNumber(minutes, 0) 62 | end 63 | end 64 | 65 | return { init=init, run=run } 66 | -------------------------------------------------------------------------------- /FUNCTIONS/01GtStd/GtStd.otx: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/RCdiy/OpenTXLua/405906bca9deec257eca78757d2989029f67b5fd/FUNCTIONS/01GtStd/GtStd.otx -------------------------------------------------------------------------------- /FUNCTIONS/01GtStd/ReadMe.md: -------------------------------------------------------------------------------- 1 | ../ReadMe.md -------------------------------------------------------------------------------- /FUNCTIONS/GoRace/!Archive/GoRace.lua: -------------------------------------------------------------------------------- 1 | -- License https://www.gnu.org/licenses/gpl-3.0.en.html 2 | -- OpenTX Lua script 3 | -- FUNCTIONS 4 | -- 5 | -- File Locations On The Transmitter's SD Card 6 | -- This script file /SCRIPTS/FUNCTIONS/ 7 | -- Accompanying sound files /SCRIPTS/FUNCTIONS/GoRace/ 8 | 9 | -- Works On OpenTX Companion Version: 2.2 10 | 11 | -- Author: Dean Church 12 | -- Web: n/a 13 | 14 | -- Thanks: Dean Church 15 | 16 | -- Date: 2017 November 30 17 | -- Update: 2017 November 30 RCdiy 18 | 19 | -- Changes/Additions: 20 | -- Removed debug code 21 | -- Changed how switch position UP, Down, Middle is implemented 22 | -- Removed seperate function call for waitNowQue. 23 | 24 | -- To do: n/a 25 | 26 | -- Description 27 | -- 28 | -- A race timer suitable for quad racing. 29 | -- An announcement to get ready to race is made. After a random delay of 30 | -- upto 5 seconds a start buzzer sound is made. 31 | 32 | -- Race quads starting sequence 33 | -- Racers 34 | -- Place their quads on the start line and check to make sure their 35 | -- quad 'arms' ( motors spool up). They then disarm. 36 | -- Return to their seat, put on their goggles and wait for instructions. 37 | -- Race Starter 38 | -- Asks for a 'thumbs up' from racers when they are ready. 39 | -- Instructs racers to arm their quads. 40 | -- (spool up motors but remain stationary at the start line) 41 | -- "Pilots arm your quads, we go live on the tone is less then five." 42 | -- After a delay of up to 5 seconds the start tone sounds. 43 | -- Racers take off from the start line and begin to race. 44 | -- https://youtu.be/2Y0zDKB0FaU 45 | 46 | -- Configurations 47 | -- For help using functions scripts 48 | -- http://rcdiy.ca/getting-started-with-lua-function-scripts/ 49 | -- Configure this script to run as a function script. 50 | -- Select the switch "ON" as the switch and condition in the 1st column. 51 | -- ON Play Script GoRace 52 | local startRaceSwitch = "sh" -- Triggers announcement 53 | local startRaceSwitchPosition = "TOWARDS" -- Switch active position 54 | -- "TOWARDS", "AWAY" or "MIDDLE" 55 | local randomTime = 5 -- Maximum delay is seconds 56 | 57 | local audioDir = "/SCRIPTS/FUNCTIONS/GoRace/" -- Location of script audio files 58 | local raceStartPreface = audioDir.."GoRace.wav" -- Prepare to race announcement 59 | local startTone = audioDir.."RaceTone.wav" -- Race start sound 60 | 61 | -- AVOID EDITING BELOW HERE 62 | 63 | local TITLE = "GoRace.lua" -- .lua to start a race. 64 | local DEBUG = false 65 | local startSwitchActivated = false 66 | 67 | -- local DOWN, MIDDLE, UP = 1024, 0, -1024 --Switch position DOWN/Toward, MIDDLE, UP/Away 68 | if startRaceSwitchPosition == "TOWARDS" then startRaceSwitchPosition = 1024 end 69 | if startRaceSwitchPosition == "MIDDLE" then startRaceSwitchPosition = 0 end 70 | if startRaceSwitchPosition == "AWAY" then startRaceSwitchPosition = -1024 end 71 | 72 | local startRaceSwitchID 73 | local startRaceSwitchVal = 0 74 | local startTimeMilliseconds = 0 75 | local raceStartPrefaceTime = 8000 -- Time to play raceStartPreface in milliSeconds 76 | 77 | local targetTimeMilliSeconds = 0 78 | local presentTimeMilliseconds = 0 79 | local waitInProgress = false 80 | 81 | --[[ ****************************************************************** 82 | to start Wait 83 | startTheWait(waitTime) - all in mililiSeconds 84 | get present time = startTimeMilliseconds 85 | add wait time to presentTime = targetTimeMilliSeconds 86 | show waiting. set waitInProgress = true 87 | --]] 88 | local function setWaitMiliSeconds(waitTime) 89 | if waitInProgress == true then 90 | return -- do not restart the wait if we are waiting now 91 | else 92 | startTimeMilliseconds = getTime()*10 93 | targetTimeMilliSeconds = waitTime + startTimeMilliseconds 94 | waitInProgress = true 95 | end 96 | end 97 | 98 | 99 | 100 | -- *************************************************** 101 | -- Function: getTelemetryId 102 | -- Parameters: name 103 | -- Desc: Gets global id of telemetry field name requested 104 | local function getTelemetryId(name) 105 | local field = getFieldInfo(name) 106 | if field then 107 | return field.id 108 | else 109 | return -1 110 | end 111 | end--[[getTelemetryId]] 112 | 113 | -- Wait for an elapsed time in miliSecond 114 | local startTimeMilliseconds = 0 115 | local targetTimeMilliSeconds = 0 116 | local presentTimeMilliseconds = 0 117 | local waitInProgress = false 118 | 119 | --[[ ****************************************************************** 120 | to start Wait 121 | startTheWait(waitTime) - all in mililiSeconds 122 | get present time = startTimeMilliseconds 123 | add wait time to presentTime = targetTimeMilliSeconds 124 | show waiting. set waitInProgress = true 125 | --]] 126 | local function setWaitMiliSeconds(waitTime) 127 | if waitInProgress == true then 128 | return 129 | else 130 | startTimeMilliseconds = getTime()*10 131 | targetTimeMilliSeconds = waitTime + startTimeMilliseconds 132 | waitInProgress = true 133 | end 134 | end 135 | 136 | 137 | --############################################################################# 138 | local function init() 139 | 140 | startSwitchActivated = false 141 | startRaceSwitchID = getTelemetryId(startRaceSwitch) 142 | startTimeMilliseconds = 0 143 | presentTimeMilliseconds = 0 144 | waitInProgress = false 145 | end --init() 146 | 147 | --############################################################################# 148 | --############################################################################# 149 | --############################################################################# 150 | --local playedRunOnce = false 151 | 152 | local function run() 153 | local minutes 154 | local seconds 155 | local randomWait 156 | local remaining 157 | 158 | if waitInProgress == false then -- check if start switch activated 159 | presentTimeMilliseconds = getTime()*10 --convert to milliseconds 160 | startRaceSwitchVal = getValue(startRaceSwitchID) 161 | if startRaceSwitchVal == startRaceSwitchPosition 162 | and startSwitchActivated == false then 163 | startSwitchActivated = true -- ensures that file plays once 164 | playFile(raceStartPreface) 165 | startTimeMilliseconds = getTime()*10 -- tick count of 10ms each tick to seconds. 166 | randomWait = math.random(100, randomTime*1000) 167 | targetTimeMilliSeconds = presentTimeMilliseconds + raceStartPrefaceTime + randomWait 168 | end 169 | end 170 | 171 | if presentTimeMilliseconds > targetTimeMilliSeconds then 172 | waitInProgress = false 173 | if startRaceSwitchVal ~= startRaceSwitchPosition and startSwitchActivated == true then 174 | playFile(startTone) 175 | 176 | startSwitchActivated = false 177 | end 178 | else 179 | waitInProgress = true 180 | presentTimeMilliseconds = getTime()*10 181 | end 182 | if startRaceSwitchVal ~= startRaceSwitchPosition and startSwitchActivated == true then 183 | startSwitchActivated = false 184 | end 185 | 186 | end -- run() 187 | 188 | return { init=init, run=run } 189 | --############################################################################# 190 | -------------------------------------------------------------------------------- /FUNCTIONS/GoRace/GoRace-special-function.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/RCdiy/OpenTXLua/405906bca9deec257eca78757d2989029f67b5fd/FUNCTIONS/GoRace/GoRace-special-function.png -------------------------------------------------------------------------------- /FUNCTIONS/GoRace/GoRace.lua: -------------------------------------------------------------------------------- 1 | -- License https://www.gnu.org/licenses/gpl-3.0.en.html 2 | -- OpenTX Lua script 3 | -- FUNCTIONS 4 | -- 5 | -- File Locations On The Transmitter's SD Card 6 | -- This script file /SCRIPTS/FUNCTIONS/ 7 | -- Accompanying sound files /SCRIPTS/FUNCTIONS/GoRace/ 8 | 9 | -- Works On OpenTX Companion Version: 2.2 10 | 11 | -- Author: Dean Church 12 | -- Web: n/a 13 | 14 | -- Thanks: Dean Church 15 | 16 | -- Date: 2017 November 30 17 | -- Update: 2017 December 2 RCdiy 18 | 19 | -- Changes/Additions: 20 | -- Removed debug code 21 | -- Changed how switch position UP, Down, Middle is implemented 22 | -- Removed seperate function calls; Rewrote run function. 23 | 24 | -- To do: n/a 25 | 26 | -- Description 27 | -- 28 | -- A race timer suitable for quad racing. 29 | -- An announcement to get ready to race is made. After a random delay of 30 | -- upto 5 seconds a start buzzer sound is made. 31 | 32 | -- Race quads starting sequence 33 | -- Racers 34 | -- Place their quads on the start line and check to make sure their 35 | -- quad 'arms' ( motors spool up). They then disarm. 36 | -- Return to their seat, put on their goggles and wait for instructions. 37 | -- Race Starter 38 | -- Asks for a 'thumbs up' from racers when they are ready. 39 | -- Instructs racers to arm their quads. 40 | -- (spool up motors but remain stationary at the start line) 41 | -- "Pilots arm your quads, we go live on the tone is less then five." 42 | -- After a delay of up to 5 seconds the start tone sounds. 43 | -- Racers take off from the start line and begin to race. 44 | -- https://youtu.be/2Y0zDKB0FaU 45 | 46 | -- Configurations 47 | -- For help using functions scripts 48 | -- http://rcdiy.ca/getting-started-with-lua-function-scripts/ 49 | -- Configure this script to run as a function script. 50 | -- Select the switch "ON" as the switch and condition in the 1st column. 51 | -- ON Play Script GoRace 52 | local startRaceSwitch = "sf" -- Triggers announcement 53 | local startRaceSwitchPosition = "TOWARDS" -- Switch active position 54 | -- "TOWARDS", "AWAY" or "MIDDLE" 55 | local randomTimeMilliseconds = 5000 -- Maximum delay 56 | 57 | local audioDir = "/SCRIPTS/FUNCTIONS/GoRace/" -- Location of script audio files 58 | local raceStartPreface = audioDir.."GoRace.wav" -- Prepare to race announcement 59 | local startTone = audioDir.."RaceTone.wav" -- Race start sound 60 | 61 | -- AVOID EDITING BELOW HERE 62 | 63 | local TITLE = "GoRace.lua" -- .lua to start a race. 64 | local DEBUG = false 65 | 66 | -- local DOWN, MIDDLE, UP = 1024, 0, -1024 --Switch position DOWN/Toward, MIDDLE, UP/Away 67 | if startRaceSwitchPosition == "TOWARDS" then startRaceSwitchPosition = 1024 end 68 | if startRaceSwitchPosition == "MIDDLE" then startRaceSwitchPosition = 0 end 69 | if startRaceSwitchPosition == "AWAY" then startRaceSwitchPosition = -1024 end 70 | 71 | local startRaceSwitchID 72 | local startRaceSwitchVal = 0 73 | --local startTimeMilliseconds = 0 74 | local raceStartPrefaceLengthMilliseconds = 8000 -- Time to play raceStartPreface in milliSeconds 75 | local startTonePlayed = false 76 | 77 | local targetTimeMilliseconds = 0 78 | local presentTimeMilliseconds = 0 79 | --local waitInProgress = false 80 | local startSequenceReset = true 81 | 82 | 83 | local function init() 84 | startRaceSwitchID = getFieldInfo(startRaceSwitch).id --getTelemetryId(startRaceSwitch) 85 | end --init() 86 | 87 | local function run() 88 | presentTimeMilliseconds = getTime()*10 89 | startRaceSwitchVal = getValue(startRaceSwitchID) 90 | if presentTimeMilliseconds > targetTimeMilliseconds then 91 | -- not in start sequence 92 | if startRaceSwitchPosition == startRaceSwitchVal and startSequenceReset == true then 93 | -- enter start sequence 94 | startSequenceReset = false 95 | startTonePlayed = false 96 | playFile(raceStartPreface) 97 | targetTimeMilliseconds = presentTimeMilliseconds + 98 | raceStartPrefaceLengthMilliseconds + 99 | math.random(100, randomTimeMilliseconds) 100 | end 101 | else 102 | -- in start sequence 103 | if startTonePlayed == false then 104 | playFile(startTone) 105 | startTonePlayed = true 106 | end 107 | end 108 | if startRaceSwitchPosition ~= startRaceSwitchVal then 109 | --startTonePlayed = false 110 | startSequenceReset = true 111 | --targetTimeMilliseconds = 0 112 | end 113 | 114 | end -- run() 115 | 116 | return { init=init, run=run } 117 | --############################################################################# 118 | -------------------------------------------------------------------------------- /FUNCTIONS/GoRace/GoRace.otx: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/RCdiy/OpenTXLua/405906bca9deec257eca78757d2989029f67b5fd/FUNCTIONS/GoRace/GoRace.otx -------------------------------------------------------------------------------- /FUNCTIONS/GoRace/GoRace.zip: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/RCdiy/OpenTXLua/405906bca9deec257eca78757d2989029f67b5fd/FUNCTIONS/GoRace/GoRace.zip -------------------------------------------------------------------------------- /FUNCTIONS/GoRace/ReadMe.md: -------------------------------------------------------------------------------- 1 | ../ReadMe.md -------------------------------------------------------------------------------- /FUNCTIONS/ReadMe.md: -------------------------------------------------------------------------------- 1 | # Download 2 | 3 | * Top right - Click on "Go to file" 4 | * Click on the desired file 5 | * Top right - Right click on "Raw" and select "Save As" 6 | * **After download ensure it has a .lua extension** 7 | * if it is .txt or .lua.txt change it to .lua 8 | * if is .html the download was done incorrectly 9 | * Using a plain text editor (Windows Notepad) 10 | * Open the file 11 | * If the file has the word "html" the pile did not download correctly. 12 | * Try again or get help on how to download the file and not the webpage showing the contents of the file 13 | 14 | ## .Otx & .Zip Files 15 | * Click on the file 16 | * On the next page click on Download 17 | 18 | # Configuration 19 | * If you have not used a Function script before please read this post 20 | 21 | [http://rcdiy.ca/getting-started-with-lua-function-scripts/](http://rcdiy.ca/getting-started-with-lua-function-scripts/) 22 | * Open the dowloaded .lua file in a plain text editor 23 | * Notepad on Windows 24 | * TextEdit on macOS 25 | * Read through the documentation 26 | * Make configuration changes where required 27 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /MIXES/GtStd.lua: -------------------------------------------------------------------------------- 1 | -- License https://www.gnu.org/licenses/gpl-3.0.en.html 2 | -- OpenTX Lua script 3 | -- MIXES 4 | -- Place this file in the SD Card folder on your computer and Tx 5 | -- SD Card /SCRIPTS/MIXES/ 6 | -- Further instructions http://rcdiy.ca/mix-scripts-getting-started/ 7 | 8 | -- Works On OpenTX Version: 2.1.8 to 2.1.9 9 | 10 | -- Author: RCdiy 11 | -- Web: http://RCdiy.ca 12 | 13 | -- Thanks: Kilrah 14 | 15 | -- Date: 2017 January 12 16 | -- Update: none 17 | 18 | -- Description 19 | 20 | -- A simple getting started mixer script. 21 | -- Takes an input suchs as a stick and an integer. 22 | -- Outputs the stick value multiplied by the integer divided by 100. 23 | 24 | -- Configuration 25 | 26 | -- Custom Scripts Screen 27 | -- Select this script and configure inputs. 28 | 29 | -- Mixer Screen 30 | -- Create a mix using the input "GtSt" which is the output from this script. 31 | 32 | -- ---------------------------------------------------------------------------------------- 33 | -- ---------------------------------------------------------------------------------------- 34 | 35 | -- AVOID EDITING BELOW HERE 36 | 37 | -- Global Lua environment variables used (Global between scripts) 38 | -- None 39 | 40 | -- Variables local to this script 41 | -- must use the word "local" before the variable 42 | local inputs = { 43 | { "Input", SOURCE }, 44 | { "Percent", VALUE, -100, 100, 5 } 45 | } 46 | -- The display prompt and input type on the left of the custom scripts screen. 47 | -- Maximum of 10 characters will be displayed. 48 | -- SOURCE provides a popup menu from which any OpenTX input may be selected. 49 | -- Inputs may be switches, sliders, sticks, chanels or outputs from other 50 | -- mixer scripts. 51 | -- VALUE provides a number entry field ranging from -100 to 100 default of 5. 52 | local outputs = { "GtSt" } 53 | -- The names of the outputs from this script as they appear on the 54 | -- right of the custom scripts screen and in OptenTx list of inputs. 55 | -- Maximum of 4 characters will be displayed. 56 | 57 | local function run(i, p) 58 | return i*p/100 59 | end 60 | 61 | return { input=inputs, output=outputs, run=run } 62 | -------------------------------------------------------------------------------- /MIXES/ReadMe.md: -------------------------------------------------------------------------------- 1 | # Download 2 | 3 | * Top right - Click on "Go to file" 4 | * Click on the desired file 5 | * Top right - Right click on "Raw" and select "Save As" 6 | * **After download ensure it has a .lua extension** 7 | * if it is .txt or .lua.txt change it to .lua 8 | * if is .html the download was done incorrectly 9 | * Using a plain text editor (Windows Notepad) 10 | * Open the file 11 | * If the file has the word "html" the pile did not download correctly. 12 | 13 | ## .Otx & .Zip Files 14 | * Click on the file 15 | * On the next page click on Download 16 | 17 | # Configuration 18 | * If you have not used a Telemetry script before please read this post 19 | 20 | [http://rcdiy.ca/telemetry-scripts-getting-started/](http://rcdiy.ca/telemetry-scripts-getting-started/) 21 | * Open the dowloaded .lua file in a plain text editor 22 | * Notepad on Windows 23 | * TextEdit on macOS 24 | * Read through the documentation 25 | * Make configuration changes where required 26 | -------------------------------------------------------------------------------- /MIXES/Sqnc/ReadMe.md: -------------------------------------------------------------------------------- 1 | # Download 2 | 3 | * Top right - Click on "Go to file" 4 | * Click on the desired file 5 | * Top right - Right click on "Raw" and select "Save As" 6 | * **After download ensure it has a .lua extension** 7 | * if it is .txt or .lua.txt change it to .lua 8 | * if is .html the download was done incorrectly 9 | * Using a plain text editor (Windows Notepad) 10 | * Open the file 11 | * If the file has the word "html" the pile did not download correctly. 12 | * Try again or get help on how to download the file and not the webpage showing the contents of the file 13 | 14 | # Configuration 15 | * If you have not used a Telemetry script before please read this post 16 | 17 | [http://rcdiy.ca/telemetry-scripts-getting-started/](http://rcdiy.ca/telemetry-scripts-getting-started/) 18 | * Open the dowloaded .lua file in a plain text editor 19 | * Notepad on Windows 20 | * TextEdit on macOS 21 | * Read through the documentation 22 | * Make configuration changes where required 23 | -------------------------------------------------------------------------------- /MIXES/Sqnc/Sqnc-Sounds.zip: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/RCdiy/OpenTXLua/405906bca9deec257eca78757d2989029f67b5fd/MIXES/Sqnc/Sqnc-Sounds.zip -------------------------------------------------------------------------------- /MIXES/Sqnc/Sqnc.lua: -------------------------------------------------------------------------------- 1 | -- License https://www.gnu.org/licenses/gpl-3.0.en.html 2 | -- OpenTX Lua script 3 | -- MIXES 4 | -- Place this file in the SD Card folder on your computer and Tx 5 | -- SD Card /SCRIPTS/MIXES/ 6 | -- Place accompanying sound files in the SD Card folder on your computer and Tx 7 | -- SD Card /SCRIPTS/MIXES/Sqnc/ 8 | 9 | -- Further instructions http://rcdiy.ca/mixer-scripts-getting-started/ 10 | 11 | -- Works On OpenTX Version: 2.1.8 to 2.1.9 12 | 13 | -- Author: RCdiy 14 | -- Web: http://RCdiy.ca 15 | 16 | -- Thanks: 17 | 18 | -- Date: 2017 February 14 19 | -- Update: 20 | 21 | -- Description 22 | 23 | -- Two Step Sequence Of Output Values 24 | -- The script provides outputs to be used as inputs to mixes. The input to 25 | -- the mix starts with an initial precentage value. After a defined delay 26 | -- in seconds the value changes to the second configured value. 27 | -- Messages are played when the sequence starts, stops, is interrupted and 28 | -- at one second intervals during the countdown delay. The sequence and mix 29 | -- line are configured to start and and enable with the same switch in the 30 | -- down/towards pilot position. 31 | 32 | -- E.g. Hand launch a plane which has a flight controller with auto level 33 | -- Pilot places flight controller into auto level mode using a switch/pot on 34 | -- the Tx 35 | -- Pilot starts the sequence by moving the sequence switch down/towards pilot 36 | -- Sequence starts a countdown with voice prompts in seconds every second 37 | -- Pilot puts down the Tx and picks up the plane, checks auto level is working 38 | -- Sequence countdown reaches zero seconds the throttle goes up, some up 39 | -- elevator is added 40 | -- Pilot hand launches the plane 41 | -- Pilot picks up the Tx and moves the switch to turn off the sequence 42 | -- Pilot flies the plane 43 | 44 | -- Sequence - Inputs 45 | -- Switch (Any Tx switch) [E.g. SA, When SA down, sequence starts) 46 | -- Delay Seconds (0 to 120) [E.g. 20] 47 | -- Start Value 1 (-100 to 100) [E.g. 60] 48 | -- End Value  1 (-100 to 100) [E.g. 20] 49 | -- Start Value 2  50 | -- End Value  2 51 | 52 | -- Sequence - Outputs 53 | -- Seq1 - output used as input to mix 54 | -- Seq2 55 | -- Spoken messages when 56 | -- the sequence starts 57 | -- the sequence stops 58 | -- the sequence is interrupted 59 | -- the model is loaded with sequence configured and sequence switch is down 60 | -- Spoken countdown with 1 second intervals 61 | 62 | -- Safety 63 | -- The script can affect critical flight controls through a mix. 64 | -- The mix line must be set up with a switch to enable and disable it. Use the 65 | -- same switch as the sequence trigger switch. 66 | -- If the script cause any unwanted behaviour the mix can be disabled using 67 | -- the assigned switch. 68 | 69 | -- What happens if a sequence is interrupted and is selected to restart? 70 | -- The delay timer is reset and the sequence starts again from the beginning.  71 | -- If during the delay a problem is noticed the sequence can be stopped and 72 | -- restarted from the beginning 73 | 74 | -- Tx Configuration 75 | 76 | -- CUSTOM SCRIPTS Screen 77 | -- Select this script and configure inputs. 78 | 79 | -- MIXER Screen 80 | -- Create one or more mixes using one of Seq1, Seq2 as input. 81 | -- If you want only this script's values to be used on a channel set Multiplex 82 | -- to Replace. 83 | 84 | -- Change as desired 85 | 86 | -- Default values for configuration screen 87 | 88 | local delaySeconds = 10 -- The delay in seconds between start and end values 89 | 90 | local startValue1 = -100 -- Precent, the default values displayed when configuring 91 | local startValue2 = 0 92 | 93 | local endValue1 = 75 -- Precent, the default values displayed when configuring 94 | local endValue2 = 0 95 | 96 | -- ---------------------------------------------------------------------------------------- 97 | -- ---------------------------------------------------------------------------------------- 98 | 99 | -- AVOID EDITING BELOW HERE 100 | 101 | -- Global Lua environment variables used (Global between scripts) 102 | -- None 103 | 104 | -- Variables local to this script 105 | -- must use the word "local" before the variable 106 | 107 | -- Sound 108 | local soundFilesPath = "/SCRIPTS/MIXES/Sqnc/" 109 | local startFile = "start.wav" 110 | local endFile = "end.wav" 111 | local stopFile = "stop.wav" 112 | local errorFile = "error.wav" 113 | local startPlayed = false 114 | local stopPlayed = false 115 | local errorPlayed = false 116 | 117 | local playedSeconds = 0; 118 | 119 | -- Other 120 | local debuging = true 121 | 122 | local startTime = 0; 123 | 124 | local function getTimeSeconds() 125 | -- Returns the number of miliseconds elapsed since the Tx was turned on 126 | -- Increments in 10 milisecond intervals 127 | -- getTime() 128 | -- Return the time since the radio was started in multiple of 10ms 129 | -- Number of 10ms ticks since the radio was started 130 | -- Example: run time: 12.54 seconds, return value: 1254 131 | return getTime()/100 132 | end 133 | 134 | local inputs = { 135 | { "Switch", SOURCE }, 136 | { "Delay Sec.", VALUE, 0, 120, delaySeconds }, 137 | { "Start Val1", VALUE, -100, 100, startValue1 }, 138 | { "End Val1", VALUE, -100, 100, endValue1 }, 139 | { "Start Val2", VALUE, -100, 100, startValue2 }, 140 | { "End Val2", VALUE, -100, 100, endValue2 } 141 | } -- Maximum of 10 characters will be displayed. 142 | 143 | local outputs = { "Seq1", "Seq2" } -- Maximum 4 characters 144 | 145 | local function run(switch, delay, start1, end1, start2, end2) 146 | --print("Switch ", switch, delay, start1, end1, start2, end2) 147 | 148 | if switch > 0 and startTime == 0 then -- Error, Script loaded with switch down 149 | if not errorPlayed then 150 | playFile(soundFilesPath..errorFile) 151 | errorPlayed = true 152 | end 153 | return start1*10.24, start2*10.24 154 | elseif switch > 0 then -- Switch is down/towards, Countdown start 155 | if not startPlayed then -- Announce start, Play file only once 156 | playFile(soundFilesPath..startFile) 157 | startPlayed = true 158 | -- Add here to account for time to play file 159 | remainSeconds = delay - (getTimeSeconds() - startTime) 160 | playNumber(remainSeconds,0) -- 0 no units played 161 | playedSeconds = remainSeconds 162 | end 163 | remainSeconds = delay - (getTimeSeconds() - startTime) 164 | if remainSeconds > 0 then -- Countdown in progress 165 | if playedSeconds - remainSeconds >= 1 then -- Play value once every second 166 | playNumber(remainSeconds,0) -- 0 no units played 167 | playedSeconds = remainSeconds 168 | end 169 | return start1*10.24, start2*10.24 170 | else -- Countdown ended 171 | if not stopPlayed then -- Announce end, Play file only once 172 | playFile(soundFilesPath..endFile) 173 | stopPlayed = true 174 | end 175 | return end1*10.24, end2*10.24 176 | end 177 | else -- Countdown not started or has been interupted 178 | startTime = getTimeSeconds() 179 | if startPlayed and not stopPlayed then -- Countdown interrupted 180 | playFile(soundFilesPath..stopFile) -- Plays once 181 | startPlayed = false -- Reset variables 182 | elseif stopPlayed then -- Countdown completed 183 | startPlayed = false -- Reset variables 184 | stopPlayed = false 185 | end 186 | return start1*10.24, start2*10.24 187 | end 188 | end 189 | 190 | return { input=inputs, output=outputs, run=run } 191 | -------------------------------------------------------------------------------- /MIXES/hold.lua: -------------------------------------------------------------------------------- 1 | -- License https://www.gnu.org/licenses/gpl-3.0.en.html 2 | -- OpenTX Lua script 3 | -- MIXES 4 | -- Place this file in the SD Card folder on your computer and Tx 5 | -- SD Card /SCRIPTS/MIXES/ 6 | -- Further instructions http://rcdiy.ca/mixer-scripts-getting-started/ 7 | 8 | -- Works On OpenTX Version: 2.1.8 to 2.1.9 9 | 10 | -- Author: RCdiy 11 | -- Web: http://RCdiy.ca 12 | 13 | -- Thanks: Kilrah 14 | 15 | -- Date: 2017 January 12 16 | -- Update: 2017 January 17 17 | 18 | -- Description 19 | 20 | -- Holds the input value. 21 | -- E.g. Keep a boat on a fixed throttle and rudder setting. 22 | -- Enabled using a logical or physical switch. 23 | 24 | -- Up to 4 inputs may be configured. 25 | -- The inputs may be sticks, sliders, switches or channels (any OpenTX input). 26 | -- If an input is not configured the corresponding output is zero. 27 | -- For each input a corresponding switch is to be provided. 28 | -- The same switch may be used for all inputs. 29 | -- When the switch is up/away the output equals the input. 30 | -- When the switch is not up/away the input value gets held and from then on 31 | -- the output is a fixed value till the switch is back up/away. 32 | 33 | -- 4 outputs are provided Hld1, Hld2, Hld3, Hld4. 34 | -- These outputs are to be used as inputs to the mix on the mixer screen. 35 | -- The output is either a pass thru of the input or a fixed value. 36 | 37 | 38 | -- Configuration 39 | 40 | -- Custom Scripts Screen 41 | -- Select this script and configure inputs. 42 | 43 | -- Mixer Screen 44 | -- Create a mix using one of Hld1, Hld2, Hld3 or Hld4 as input. 45 | 46 | -- Change as desired 47 | 48 | 49 | 50 | -- ---------------------------------------------------------------------------------------- 51 | -- ---------------------------------------------------------------------------------------- 52 | 53 | -- AVOID EDITING BELOW HERE 54 | 55 | -- Global Lua environment variables used (Global between scripts) 56 | -- None 57 | 58 | -- Variables local to this script 59 | -- must use the word "local" before the variable 60 | 61 | -- Hold values 62 | local Output1 = 0 63 | local Output2 = 0 64 | local Output3 = 0 65 | local Output4 = 0 66 | 67 | -- Other 68 | local Debuging = false 69 | 70 | local inputs = { 71 | { "1st Input", SOURCE }, 72 | { "1st Switch", SOURCE }, 73 | { "2nd Input", SOURCE }, 74 | { "2nd Switch", SOURCE }, 75 | { "3rd Input", SOURCE }, 76 | { "3rd Switch", SOURCE }, 77 | { "4th Input", SOURCE }, 78 | { "4th Switch", SOURCE } 79 | } 80 | 81 | local outputs = { "Hld1", "Hld2", "Hld3", "Hld4"} 82 | -- Maximum 4 characters 83 | 84 | local function run(Ip1, Sw1, Ip2, Sw2, Ip3, Sw3, Ip4, Sw4) 85 | 86 | -- If the switch is up/away 87 | -- pass thru the input to the output 88 | -- else 89 | -- the output is the last input value before the switch was changed 90 | if Sw1 < 0 then 91 | Output1 = Ip1 92 | end 93 | if Sw2 < 0 then 94 | Output2 = Ip2 95 | end 96 | if Sw3 < 0 then 97 | Output3 = Ip3 98 | end 99 | if Sw4 < 0 then 100 | Output4 = Ip4 101 | end 102 | 103 | return Output1, Output2, Output3, Output4 104 | end 105 | 106 | return { input=inputs, output=outputs, run=run } 107 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # OpenTX Lua Scripts 2 | Lua scripts for the OpenTX software environment. 3 | 4 | http://RCdiy.ca 5 | 6 | info@RCdiy.ca 7 | 8 | These scripts are documented on the website and within the script files. 9 | 10 | ## Download 11 | 12 | - Click on the script type directory e.g. TELEMETRY 13 | - Click on subsequent folders and follow directions in the read me files. 14 | 15 | ## Use The Script 16 | 17 | - View the script in a text editor to get instructions on where to place the files and configuration options 18 | - New to lua scripts? 19 | - [http://rcdiy.ca/telemetry-scripts-getting-started/](http://rcdiy.ca/telemetry-scripts-getting-started/) 20 | - [http://rcdiy.ca/mix-scripts-getting-started/](http://rcdiy.ca/mix-scripts-getting-started/) 21 | 22 | ## Contribute 23 | - To contribute yours scripts to this repository please send in an email info@RCdiy.ca 24 | 25 | Depending on demand this repository may be opened up so others may help maintain it. 26 | 27 | ### Script Submission Conditions 28 | 29 | - Permission to use and modify your scripts (retaining author credit to you) without any conditions except as provided under GPL3.0 30 | - Working on the current release version of OpenTX and Companion simulator 31 | 32 | ### Suggested Documentation 33 | 34 | OpenTX Lua script 35 | TELEMETRY 36 | 37 | Place this file in SD Card copy on your computer > /SCRIPTS/TELEMETRY/.lua 38 | 39 | Works On OpenTX Companion Version: 2.1.8 40 | 41 | Author: RCdiy 42 | Web: http://RCdiy.ca 43 | Date: 2016 June 28 44 | 45 | Description 46 | 47 | Read a Tx global variable to determine battery capacity in mAh 48 | 49 | Read a sensor to determine current mAh consumption 50 | 51 | Display remaining battery mAh 52 | 53 | Display remaining battery percent 54 | 55 | Write remaining battery mAh to a Tx global variable 56 | 57 | Write remaining battery percent to a Tx global variable 58 | 59 | Note 60 | 61 | The OpenTX global variables have a 1024 limit. 62 | 63 | mAh values are expressed as mAh/100 64 | 65 | 2800 mAh will be 28 when stored in an OpenTX global variables 66 | 67 | 800 mAh will be 8 68 | 69 | Sensors 70 | 71 | mAh (calculated sensor based on VFAS, FrSky FAS-40) 72 | 73 | Global OpenTX variables used 74 | GV1 = Read battery capacity provided as mAh/100, 2800 mAh would be 28, 800 mAh would be 8 75 | 76 | GV2 = Write mAh remaining 77 | 78 | GV3 = Write % remaining 79 | 80 | Global Lua environment variables used 81 | 82 | None 83 | 84 | if required use a naming convention similar to below to reduce conflict with other scripts 85 | 86 | RCdiy