Skip to content

Commit 301eb52

Browse files
New pages that should be in the previous commit :)
1 parent a1de0d0 commit 301eb52

9 files changed

+229
-0
lines changed

general/defaultChannel.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<!-- This file was generated by the script. Do not edit it, any changes will be lost! -->
2+
3+
## defaultChannel(stick)
4+
5+
6+
7+
Get channel assigned to stick. See Default Channel Order in General Settings
8+
9+
@status current Introduced in 2.0.0
10+
11+
12+
#### Parameters
13+
14+
* `stick` (number) stick number (from 0 to 3)
15+
16+
17+
18+
#### Return value
19+
20+
* `number` channel assigned to this stick (from 0 to 3)
21+
22+
* `nil` stick not found
23+
24+
25+

general/defaultStick.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<!-- This file was generated by the script. Do not edit it, any changes will be lost! -->
2+
3+
## defaultStick(channel)
4+
5+
6+
7+
Get stick that is assigned to a channel. See Default Channel Order in General Settings.
8+
9+
@status current Introduced in 2.0.0
10+
11+
12+
#### Parameters
13+
14+
* `channel` (number) channel number (0 means CH1)
15+
16+
17+
18+
#### Return value
19+
20+
* `number` Stick assigned to this channel (from 0 to 3)
21+
22+
23+

general/popupInput.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<!-- This file was generated by the script. Do not edit it, any changes will be lost! -->
2+
3+
## popupInput(title, event, input, min, max)
4+
5+
6+
7+
Raises a popup on screen that allows uses input
8+
9+
@status current Introduced in 2.0.0
10+
11+
12+
#### Parameters
13+
14+
* `title` (string) text to display
15+
16+
* `event` (number) the event variable that is passed in from the
17+
Run function (key pressed)
18+
19+
* `input` (number) value that can be adjusted by the +/­- keys
20+
21+
* `min` (number) min value that input can reach (by pressing the -­ key)
22+
23+
* `max` (number) max value that input can reach
24+
25+
26+
27+
#### Return value
28+
29+
* `number` result of the input adjustment
30+
31+
* `"OK"` user pushed ENT key
32+
33+
* `"CANCEL"` user pushed EXIT key
34+
35+
36+
37+
##### Notice
38+
Use only from stand-alone and telemetry scripts.
39+
40+

model/defaultInputs.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!-- This file was generated by the script. Do not edit it, any changes will be lost! -->
2+
3+
## model.defaultInputs()
4+
5+
6+
7+
Set all inputs to defaults
8+
9+
@status current Introduced in 2.0.0
10+
11+
12+
#### Parameters
13+
14+
none
15+
16+
#### Return value
17+
18+
none
19+

model/deleteInput.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<!-- This file was generated by the script. Do not edit it, any changes will be lost! -->
2+
3+
## model.deleteInput(input, line)
4+
5+
6+
7+
Delete line from specified input
8+
9+
@status current Introduced in 2.0.0
10+
11+
12+
#### Parameters
13+
14+
* `input` (unsigned number) input number (use 0 for Input1)
15+
16+
* `line` (unsigned number) input line (use 0 for first line)
17+
18+
19+
20+
#### Return value
21+
22+
none
23+

model/deleteInputs.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!-- This file was generated by the script. Do not edit it, any changes will be lost! -->
2+
3+
## model.deleteInputs()
4+
5+
6+
7+
Delete all Inputs
8+
9+
@status current Introduced in 2.0.0
10+
11+
12+
#### Parameters
13+
14+
none
15+
16+
#### Return value
17+
18+
none
19+

model/getInput.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<!-- This file was generated by the script. Do not edit it, any changes will be lost! -->
2+
3+
## model.getInput(input, line)
4+
5+
6+
7+
Returns input data for given input and line number
8+
9+
@status current Introduced in 2.0.0, `switch` added in TODO
10+
11+
12+
#### Parameters
13+
14+
* `input` (unsigned number) input number (use 0 for Input1)
15+
16+
* `line` (unsigned number) input line (use 0 for first line)
17+
18+
19+
20+
#### Return value
21+
22+
* `nil` requested input or line does not exist
23+
24+
* `table` input data:
25+
* `name` (string) input line name
26+
* `source` (number) input source index
27+
* `weight` (number) input weight
28+
* `offset` (number) input offset
29+
* `switch` (number) input switch index
30+
31+
32+

model/getInputsCount.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<!-- This file was generated by the script. Do not edit it, any changes will be lost! -->
2+
3+
## model.getInputsCount(input)
4+
5+
6+
7+
Returns number of lines for given input
8+
9+
@status current Introduced in 2.0.0
10+
11+
12+
#### Parameters
13+
14+
* `input` (unsigned number) input number (use 0 for Input1)
15+
16+
17+
18+
#### Return value
19+
20+
* `number` number of configured lines for given input
21+
22+
23+

model/insertInput.md

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
<!-- This file was generated by the script. Do not edit it, any changes will be lost! -->
2+
3+
## model.insertInput(input, line, value)
4+
5+
6+
7+
Inserts an Input at specified line
8+
9+
@status current Introduced in 2.0.0, `switch` added in TODO
10+
11+
12+
#### Parameters
13+
14+
* `input` (unsigned number) input number (use 0 for Input1)
15+
16+
* `line` (unsigned number) input line (use 0 for first line)
17+
18+
* `value` (table) input data, see model.getInput()
19+
20+
21+
22+
#### Return value
23+
24+
none
25+

0 commit comments

Comments
 (0)