Wiki source code of SHOWRUNNER™ Keypad Types
Version 138.1 by Alexander Mott on 2022/09/17 03:01
Show last authors
author | version | line-number | content |
---|---|---|---|
1 | {{box title="**CONTENTS**"}} | ||
2 | {{toc/}} | ||
3 | {{/box}} | ||
4 | |||
5 | = Overview = | ||
6 | |||
7 | The showrunner™ program includes several pre-built keypad types suitable for a wide variety of applications. In addition to standard keypad types, showrunner™ supports custom "X-Type" keypad configurations. Custom keypads can be configured from the showrunnerHUB™ Web Interface, or they can be manually added to the config and enabled using the XPanel Touchscreen interface. | ||
8 | |||
9 | = Cameo Keypads = | ||
10 | |||
11 | Wired and wireless Cameo keypads are fully supported by showrunner™ with both built-in and customizable keypad types. | ||
12 | |||
13 | |(% rowspan="10" %)[[image:cameo a,ah,b.png]]|**Cameo A-Type **|(% colspan="4" %)**Button Functions** | ||
14 | |(% rowspan="4" %)2-Button, area On/Off keypad|**Button**|**Label**|(% colspan="2" %)**Press** | ||
15 | |1|On|(% colspan="2" %)Area On | ||
16 | |2|Off|(% colspan="2" %)Area Off | ||
17 | | | | | | ||
18 | |**Supported Features**| | | | | ||
19 | |(% rowspan="4" %)DisableOff | ||
20 | LinkedAreaIds| | | | | ||
21 | | | | | | ||
22 | | | | | | ||
23 | | | | | | ||
24 | |(% rowspan="10" %)[[image:cameo a,ah,b.png]]|**Cameo AfterHours**|(% colspan="4" %)**Button Functions** | ||
25 | |(% rowspan="4" %)2-Button, area On/Off keypad with timeout|**Button**|**Label**|(% colspan="2" %)**Press** | ||
26 | |1|On|(% colspan="2" %)Area On w/timeout | ||
27 | |2|Off|(% colspan="2" %)Area Off | ||
28 | | | | | | ||
29 | |**Supported Features**| | | | | ||
30 | |(% rowspan="4" %)DisableOff | ||
31 | LinkedAreaIds| | | | | ||
32 | | | | | | ||
33 | | | | | | ||
34 | | | | | | ||
35 | |(% rowspan="10" %)[[image:cameo az.gif]]|**AZ-Type**|(% colspan="4" %)**Button Functions** | ||
36 | |(% rowspan="4" %)Variable 4 to 8-button Load Toggle/Dim keypad with All On/Off | ||
37 | (automatically selects layout based on number of loads in area)|**Button**|**Label**|**Press**|**Hold** | ||
38 | |1-7|Zone #|Toggle Load #|Cycle Raise/Lower Load # | ||
39 | |8|On|All Loads On|All Loads Raise | ||
40 | |9|Off|All Loads Off|All Loads Lower | ||
41 | |**Supported Features**| | | | | ||
42 | |(% rowspan="4" %)DirectLoadIds (2-6 loads) | ||
43 | DisableOff (v3.002 or later) | ||
44 | FlipRaiseLower (v3.002 or later)| | | | | ||
45 | | | | | | ||
46 | | | | | | ||
47 | | | | | | ||
48 | |(% rowspan="10" %)[[image:cameo a,ah,b.png]]|**Cameo B-Type**|(% colspan="4" %)**Button Functions** | ||
49 | |(% rowspan="4" %)2-Button, area On/Off keypad with hold to Raise/Lower|**Button**|**Label**|**Press**|**Hold** | ||
50 | |1|On|Area On|Area Raise | ||
51 | |2|Off|Area Off|Area Lower | ||
52 | | | | | | ||
53 | |**Supported Features**| | | | | ||
54 | |(% rowspan="4" %)DirectLoadIds | ||
55 | DisableOff| | | | | ||
56 | | | | | | ||
57 | | | | | | ||
58 | | | | | | ||
59 | |(% rowspan="10" %)[[image:cameo c.png]]|**Cameo C-Type**|(% colspan="4" %)**Button Functions** | ||
60 | |(% rowspan="4" %)3-Button On/Off/Dim keypad|**Button**|**Label**|**Press**|**Hold** | ||
61 | |1|On|Area On|n/a | ||
62 | |2|Off|Area Off|n/a | ||
63 | |3|Dim|n/a|Cycle Raise/Lower | ||
64 | |**Supported Features**| | | | | ||
65 | |(% rowspan="4" %)DisableOff| | | | | ||
66 | | | | | | ||
67 | | | | | | ||
68 | | | | | | ||
69 | |(% rowspan="10" %)[[image:cameo d.png]]|**Cameo D-Type**|(% colspan="4" %)**Button Functions** | ||
70 | |(% rowspan="4" %)4-Button On/Off, Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
71 | |1|On|Area On|n/a | ||
72 | |2|▲|n/a|Area Raise | ||
73 | |3|▼|n/a|Area Lower | ||
74 | |**Supported Features**|4|Off|Area Off|n/a | ||
75 | |(% rowspan="4" %)DirectLoadIds (1 load) | ||
76 | DisableOff| | | | | ||
77 | | | | | | ||
78 | | | | | | ||
79 | | | | | | ||
80 | |(% rowspan="10" %)[[image:cameo e.png]]|**Cameo E-Type**|(% colspan="4" %)**Button Functions** | ||
81 | |(% rowspan="4" %)5-Button On/Off/Scene keypad|**Button**|**Label**|(% colspan="2" %)**Press** | ||
82 | |1|On|(% colspan="2" %)Area On | ||
83 | |2|Scene 2|(% colspan="2" %)Recall Scene 2 | ||
84 | |3|Scene 3|(% colspan="2" %)Recall Scene 3 | ||
85 | |**Supported Features**|4|Scene 4|(% colspan="2" %)Recall Scene 4 | ||
86 | |(% rowspan="4" %)DisableOff|5|Off|(% colspan="2" %)Area Off | ||
87 | | | | | | ||
88 | | | | | | ||
89 | | | | | | ||
90 | |(% rowspan="10" %)[[image:cameo e7.png]]|**Cameo E7-Type**|(% colspan="4" %)**Button Functions** | ||
91 | |(% rowspan="4" %)7-Button On/Off/Scene keypad|**Button**|**Label**|(% colspan="2" %)**Press** | ||
92 | |1|On|(% colspan="2" %)Area On | ||
93 | |2|Scene 2|(% colspan="2" %)Recall Scene 2 | ||
94 | |3|Scene 3|(% colspan="2" %)Recall Scene 3 | ||
95 | |**Supported Features**|4|Scene 4|(% colspan="2" %)Recall Scene 4 | ||
96 | |(% rowspan="4" %)DisableOff|5|Scene 5|(% colspan="2" %)Recall Scene 5 | ||
97 | |6|6|(% colspan="2" %)Recall Scene 6 | ||
98 | |7|Off|(% colspan="2" %)Area Off | ||
99 | | | | | | ||
100 | |(% rowspan="10" %)[[image:cameo e8.png]]|**Cameo E8-Type**|(% colspan="4" %)**Button Functions** | ||
101 | |(% rowspan="4" %)8-Button On/Off/Scene keypad|**Button**|**Label**|(% colspan="2" %)**Press** | ||
102 | |1|On|(% colspan="2" %)Area On | ||
103 | |2|Scene 2|(% colspan="2" %)Recall Scene 2 | ||
104 | |3|Scene 3|(% colspan="2" %)Recall Scene 3 | ||
105 | |**Supported Features**|4|Scene 4|(% colspan="2" %)Recall Scene 4 | ||
106 | |(% rowspan="4" %)DisableOff|5|5|(% colspan="2" %)Recall Scene 5 | ||
107 | |6|6|(% colspan="2" %)Recall Scene 6 | ||
108 | |7|7|(% colspan="2" %)Recall Scene 7 | ||
109 | |8|Off|(% colspan="2" %)Area Off | ||
110 | |(% rowspan="10" %)[[image:cameo f.png]]|**Cameo F-Type**|(% colspan="4" %)**Button Functions** | ||
111 | |(% rowspan="4" %)7-Button On/Off/Scene/Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
112 | |1|On|Area On|n/a | ||
113 | |2|Scene 2|Recall Scene 2|n/a | ||
114 | |3|Scene 3|Recall Scene 3|n/a | ||
115 | |**Supported Features**|4|Scene 4|Recall Scene 4|n/a | ||
116 | |(% rowspan="4" %)DirectLoadIds | ||
117 | DisableOff | ||
118 | FlipRaiseLower|5|Off|Area Off|n/a | ||
119 | |6|▲|n/a|Area Raise | ||
120 | |7|▼|n/a|Area Lower | ||
121 | | | | | | ||
122 | |(% rowspan="10" %)[[image:cameo f8.png]]|**Cameo F8-Type**|(% colspan="4" %)**Button Functions** | ||
123 | |(% rowspan="4" %)8-Button On/Off/Scene/Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
124 | |1|On|Area On|n/a | ||
125 | |2|Scene 2|Recall Scene 2|n/a | ||
126 | |3|Scene 3|Recall Scene 3|n/a | ||
127 | |**Supported Features**|4|Scene 4|Recall Scene 4|n/a | ||
128 | |(% rowspan="4" %)DisableOff | ||
129 | FlipRaiseLower|5|5|Off|n/a | ||
130 | |6|Off|Area Off|n/a | ||
131 | |7|▲|n/a|Area Raise | ||
132 | |8|▼|n/a|Area Lower | ||
133 | |(% rowspan="10" %)[[image:cameo g.png]]|**Cameo G-Type**|(% colspan="4" %)**Button Functions** | ||
134 | |(% rowspan="4" %)4-Button Toggle Load by Type, Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
135 | |1|Dimming On/Off|Toggle dimmable loads on/off|n/a | ||
136 | |2|▲|n/a|Area Raise | ||
137 | |3|▼|n/a|Area Lower | ||
138 | |**Supported Features**|4|Switching On/Off|Toggle switched loads on/off|n/a | ||
139 | |(% rowspan="4" %)n/a| | | | | ||
140 | | | | | | ||
141 | | | | | | ||
142 | | | | | | ||
143 | |(% rowspan="10" %)[[image:cameo h.png]]|**Cameo H-Type**|(% colspan="4" %)**Button Functions** | ||
144 | |(% rowspan="4" %)7-Button Area On/Off/Scene/Raise/Lower keypad with Shade Control|**Button**|**Label**|**Press**|**Hold** | ||
145 | |1|On|Area On|n/a | ||
146 | |2|Scene 2|Recall Scene 2|n/a | ||
147 | |3|Scene 3|Recall Scene 3|n/a | ||
148 | |**Supported Features**|4|Off|Area Off|n/a | ||
149 | |(% rowspan="4" %)DisableOff | ||
150 | FlipRaiseLower|5|Shades|(% colspan="2" %)Raise/Lower affects shades for 5s | ||
151 | |6|▲|n/a|Raise | ||
152 | |7|▼|n/a|Lower | ||
153 | | | | | | ||
154 | |(% rowspan="10" %)[[image:cameo n.png]]|**Cameo N-Type**|(% colspan="4" %)**Button Functions** | ||
155 | |(% rowspan="4" %)7-Button Area/Load Toggle, Area Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
156 | |1|On/Off|Toggle Area On/Off|n/a | ||
157 | |2|Zone 1|Load 1 On|Load 1 Off | ||
158 | |3|Zone 2|Load 2 On|Load 2 Off | ||
159 | |**Supported Features**|4|Zone 3|Load 3 On|Load 3 Off | ||
160 | |(% rowspan="4" %)DirectLoadIds (4 loads) | ||
161 | DisableOff (v3.002 or later) | ||
162 | FlipRaiseLower (v2.210 or later)|5|Zone 4|Load 4 On|Load 4 Off | ||
163 | |6|▲|n/a|Area Raise | ||
164 | |7|▼|n/a|Area Lower | ||
165 | | | | | | ||
166 | |(% rowspan="10" %)[[image:cameo n5.png]]|**Cameo N5-Type**|(% colspan="4" %)**Button Functions** | ||
167 | |(% rowspan="4" %)7-Button Load Toggle, Area Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
168 | |1|Zone 1|Load 1 On|Load 1 Off | ||
169 | |2|Zone 2|Load 2 On|Load 2 Off | ||
170 | |3|Zone 3|Load 3 On|Load 3 Off | ||
171 | |**Supported Features**|4|Zone 4|Load 4 On|Load 4 Off | ||
172 | |(% rowspan="4" %)DirectLoadIds (5 loads) | ||
173 | DisableOff (v3.002 or later) | ||
174 | FlipRaiseLower (v2.210 or later)|5|Zone 5|Load 5 On|Load 5 Off | ||
175 | |6|▲|n/a|Area Raise | ||
176 | |7|▼|n/a|Area Lower | ||
177 | | | | | | ||
178 | |(% rowspan="10" %)[[image:cameo noff.png]]|**Cameo NOFF-Type**|(% colspan="4" %)**Button Functions** | ||
179 | |(% rowspan="4" %)7-Button Load Toggle, Area On/Off/Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
180 | |1|On|Area On|n/a | ||
181 | |2|Zone 1|Load 1 On|Load 1 Off | ||
182 | |3|Zone 2|Load 2 On|Load 2 Off | ||
183 | |**Supported Features**|4|Zone 3|Load 3 On|Load 3 Off | ||
184 | |(% rowspan="4" %)DirectLoadIds (3 loads) | ||
185 | DisableOff (v2.210 or later) | ||
186 | FlipRaiseLower (v2.210 or later)|5|Off|Area Off|n/a | ||
187 | |6|▲|n/a|Area Raise | ||
188 | |7|▼|n/a|Area Lower | ||
189 | | | | | | ||
190 | |(% rowspan="10" %)[[image:cameo ovr.png]]|**Cameo OVR-Type**|(% colspan="4" %)**Button Functions** | ||
191 | |(% rowspan="4" %)2-Button, area override keypad|**Button**|**Label**|(% colspan="2" %)**Press** | ||
192 | |1|OVR On|(% colspan="2" %)Enable Area Override | ||
193 | |2|OVR Off|(% colspan="2" %)Disable Area Override | ||
194 | | | | | | ||
195 | |**Supported Features**| | | | | ||
196 | |(% rowspan="4" %)ControllerIds | ||
197 | DisableOff (v2.210 or later)| | | | | ||
198 | | | | | | ||
199 | | | | | | ||
200 | | | | | | ||
201 | |(% rowspan="10" %)[[image:cameo t.png]]|**Cameo T-Type**|(% colspan="4" %)**Button Functions** | ||
202 | |(% rowspan="4" %)3-Button Area or Load Toggle with Raise/Lower|**Button**|**Label**|**Press**|**Hold** | ||
203 | |1|On/Off|Area or Load Toggle On/Off|n/a | ||
204 | |2|▲|n/a|Area or Load Raise | ||
205 | |3|▼|n/a|Area or Load Lower | ||
206 | |**Supported Features**| | | | | ||
207 | |(% rowspan="4" %)DirectLoadIds (1 load)| | | | | ||
208 | | | | | | ||
209 | | | | | | ||
210 | | | | | | ||
211 | |(% rowspan="10" %)[[image:cameo w.png]]|**Cameo W-Type**|(% colspan="4" %)**Button Functions** | ||
212 | |(% rowspan="4" %)4-Button Last Level/Off/Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
213 | |1|On|Recall Last Levels|n/a | ||
214 | |2|Off|Area Off|n/a | ||
215 | |3|▲|n/a|Area Raise | ||
216 | |**Supported Features**|4|▼|n/a|Area Lower | ||
217 | |(% rowspan="4" %)DirectLoadIds (1 load) | ||
218 | DisableOff | ||
219 | FlipRaiseLower| | | | | ||
220 | | | | | | ||
221 | | | | | | ||
222 | | | | | | ||
223 | |||
224 | = Horizon Keypads = | ||
225 | |||
226 | Wired and wireless Horizon keypads are fully supported by showrunner™ with both built-in and customizable keypad types. | ||
227 | |||
228 | |(% rowspan="10" %)[[image:hz a,ah,b.png]]|**Horizon A-Type **|(% colspan="4" %)**Button Functions** | ||
229 | |(% rowspan="4" %)2-Button, area On/Off keypad|**Button**|**Label**|(% colspan="2" %)**Press** | ||
230 | |1|On|(% colspan="2" %)Area On | ||
231 | |2|Off|(% colspan="2" %)Area Off | ||
232 | | | | | | ||
233 | |**Supported Features**| | | | | ||
234 | |(% rowspan="4" %)DisableOff | ||
235 | LinkedAreaIds| | | | | ||
236 | | | | | | ||
237 | | | | | | ||
238 | | | | | | ||
239 | |(% rowspan="10" %)[[image:hz a,ah,b.png]]|**Horizon AfterHours**|(% colspan="4" %)**Button Functions** | ||
240 | |(% rowspan="4" %)2-Button, area On/Off keypad with timeout|**Button**|**Label**|(% colspan="2" %)**Press** | ||
241 | |1|On|(% colspan="2" %)Area On w/timeout | ||
242 | |2|Off|(% colspan="2" %)Area Off | ||
243 | | | | | | ||
244 | |**Supported Features**| | | | | ||
245 | |(% rowspan="4" %)DisableOff | ||
246 | LinkedAreaIds| | | | | ||
247 | | | | | | ||
248 | | | | | | ||
249 | | | | | | ||
250 | |(% rowspan="10" %)[[image:hz az.gif]]|**Horizon AZ-Type**|(% colspan="4" %)**Button Functions** | ||
251 | |(% rowspan="4" %)Variable 4 to 8-button Load Toggle/Dim keypad with All On/Off | ||
252 | (automatically selects layout based on number of loads in area)|**Button**|**Label**|**Press**|**Hold** | ||
253 | |1-8|Zone #|Toggle Load #|Cycle Raise/Lower Load # | ||
254 | |9|Off|All Loads Off|All Loads Lower | ||
255 | |10|On|All Loads On|All Loads Raise | ||
256 | |**Supported Features**| | | | | ||
257 | |(% rowspan="4" %)DirectLoadIds (2-8 loads) | ||
258 | DisableOff (v3.002 or later) | ||
259 | FlipRaiseLower (v3.002 or later)| | | | | ||
260 | | | | | | ||
261 | | | | | | ||
262 | | | | | | ||
263 | |(% rowspan="10" %)[[image:hz a,ah,b.png]]|**Horizon B-Type**|(% colspan="4" %)**Button Functions** | ||
264 | |(% rowspan="4" %)2-Button, area On/Off keypad with hold to Raise/Lower|**Button**|**Label**|**Press**|**Hold** | ||
265 | |1|On|Area On|Area Raise | ||
266 | |2|Off|Area Off|Area Lower | ||
267 | | | | | | ||
268 | |**Supported Features**| | | | | ||
269 | |(% rowspan="4" %)DirectLoadIds | ||
270 | DisableOff| | | | | ||
271 | | | | | | ||
272 | | | | | | ||
273 | | | | | | ||
274 | |(% rowspan="10" %)[[image:hz d.png]]|**Horizon D-Type**|(% colspan="4" %)**Button Functions** | ||
275 | |(% rowspan="4" %)4-Button On/Off, Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
276 | |1|On|Area On|n/a | ||
277 | |2|▲|n/a|Area Raise | ||
278 | |3|▼|n/a|Area Lower | ||
279 | |**Supported Features**|4|Off|Area Off|n/a | ||
280 | |(% rowspan="4" %)DirectLoadIds (1 load) | ||
281 | DisableOff| | | | | ||
282 | | | | | | ||
283 | | | | | | ||
284 | | | | | | ||
285 | |(% rowspan="10" %)[[image:hz e.png]]|**Horizon E-Type**|(% colspan="4" %)**Button Functions** | ||
286 | |(% rowspan="4" %)5-Button On/Off/Scene keypad|**Button**|**Label**|(% colspan="2" %)**Press** | ||
287 | |1|On|(% colspan="2" %)Area On | ||
288 | |2|Scene 2|(% colspan="2" %)Recall Scene 2 | ||
289 | |3|Scene 3|(% colspan="2" %)Recall Scene 3 | ||
290 | |**Supported Features**|4|Scene 4|(% colspan="2" %)Recall Scene 4 | ||
291 | |(% rowspan="4" %)DisableOff|5|Off|(% colspan="2" %)Area Off | ||
292 | | | | | | ||
293 | | | | | | ||
294 | | | | | | ||
295 | |(% rowspan="10" %)[[image:hz e8.png]]|**Horizon E8-Type**|(% colspan="4" %)**Button Functions** | ||
296 | |(% rowspan="4" %)8-Button On/Off/Scene keypad|**Button**|**Label**|(% colspan="2" %)**Press** | ||
297 | |1|On|(% colspan="2" %)Area On | ||
298 | |2|Scene 2|(% colspan="2" %)Recall Scene 2 | ||
299 | |3|Scene 3|(% colspan="2" %)Recall Scene 3 | ||
300 | |**Supported Features**|4|Scene 4|(% colspan="2" %)Recall Scene 4 | ||
301 | |(% rowspan="4" %)DisableOff|5|Scene 5|(% colspan="2" %)Recall Scene 5 | ||
302 | |6|Scene 6|(% colspan="2" %)Recall Scene 6 | ||
303 | |7|Scene 7|(% colspan="2" %)Recall Scene 7 | ||
304 | |8|Off|(% colspan="2" %)Area Off | ||
305 | |(% rowspan="10" %)[[image:hz f.png]]|**Horizon F-Type**|(% colspan="4" %)**Button Functions** | ||
306 | |(% rowspan="4" %)7-Button On/Off/Scene/Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
307 | |1|Off|Area Off|n/a | ||
308 | |2|On|Area On|n/a | ||
309 | |3|Scene 2|Recall Scene 2|n/a | ||
310 | |**Supported Features**|4|Scene 3|Recall Scene 3|n/a | ||
311 | |(% rowspan="4" %)DirectLoadIds | ||
312 | DisableOff | ||
313 | FlipRaiseLower|5|Scene 4|Recall Scene 4|n/a | ||
314 | |6|▲|n/a|Area Raise | ||
315 | |7|▼|n/a|Area Lower | ||
316 | | | | | | ||
317 | |(% rowspan="10" %)[[image:hz f8.png]]|**Horizon F8-Type**|(% colspan="4" %)**Button Functions** | ||
318 | |(% rowspan="4" %)10-Button On/Off/Scene/Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
319 | |1|Off|Area Off|n/a | ||
320 | |2|On|Area On|n/a | ||
321 | |3-8|Scene #|Recall Scene #|n/a | ||
322 | |**Supported Features**|9|▲|n/a|Area Raise | ||
323 | |(% rowspan="4" %)DisableOff | ||
324 | FlipRaiseLower|10|▼|n/a|Area Lower | ||
325 | | | | | | ||
326 | | | | | | ||
327 | | | | | | ||
328 | |(% rowspan="10" %)[[image:hz h.png]]|**Horizon H-Type**|(% colspan="4" %)**Button Functions** | ||
329 | |(% rowspan="4" %)8-Button Area On/Off/Scene/Raise/Lower keypad with Shade Raise/Lower|**Button**|**Label**|**Press**|**Hold** | ||
330 | |1|On|Area On|n/a | ||
331 | |2|Scene 2|Recall Scene 2|n/a | ||
332 | |3|Scene 3|Recall Scene 3|n/a | ||
333 | |**Supported Features**|4|Off|Area Off|n/a | ||
334 | |(% rowspan="4" %)DisableOff | ||
335 | FlipRaiseLower|5|□|n/a|Shade Open | ||
336 | |6|■|n/a|Shade Close | ||
337 | |7|▲|n/a|Area Raise | ||
338 | |8|▼|n/a|Area Lower | ||
339 | |(% rowspan="10" %)[[image:hz n.png]]|**Horizon N-Type**|(% colspan="4" %)**Button Functions** | ||
340 | |(% rowspan="4" %)7-Button Area/Load Toggle, Area Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
341 | |1|On/Off|Toggle Area On/Off|n/a | ||
342 | |2|Zone 1|Load 1 On|Load 1 Off | ||
343 | |3|Zone 2|Load 2 On|Load 2 Off | ||
344 | |**Supported Features**|4|Zone 3|Load 3 On|Load 3 Off | ||
345 | |(% rowspan="4" %)DirectLoadIds (3 loads) | ||
346 | DisableOff (v3.002 or later) | ||
347 | FlipRaiseLower (v2.210 or later)|5|▲|n/a|Area Raise | ||
348 | |6|▼|n/a|Area Lower | ||
349 | | | | | | ||
350 | | | | | | ||
351 | |(% rowspan="10" %)[[image:hz n5.png]]|**Horizon N5-Type**|(% colspan="4" %)**Button Functions** | ||
352 | |(% rowspan="4" %)10-Button Load Toggle, Area Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
353 | |1|Off|Area Off|n/a | ||
354 | |2|On|Area On|n/a | ||
355 | |3-8|Zone #|Load # On|Load # Off | ||
356 | |**Supported Features**|9|▲|n/a|Area Raise | ||
357 | |(% rowspan="4" %)DirectLoadIds (6 loads) | ||
358 | DisableOff (v3.002 or later) | ||
359 | FlipRaiseLower (v2.210 or later)|10|▼|n/a|Area Lower | ||
360 | | | | | | ||
361 | | | | | | ||
362 | | | | | | ||
363 | |(% rowspan="10" %)[[image:hz ovr.png]]|**Horizon OVR-Type**|(% colspan="4" %)**Button Functions** | ||
364 | |(% rowspan="4" %)2-Button, area override keypad|**Button**|**Label**|(% colspan="2" %)**Press** | ||
365 | |1|OVR On|(% colspan="2" %)Enable Area Override | ||
366 | |2|OVR Off|(% colspan="2" %)Disable Area Override | ||
367 | | | | | | ||
368 | |**Supported Features**| | | | | ||
369 | |(% rowspan="4" %)ControllerIds | ||
370 | DisableOff (v2.210 or later)| | | | | ||
371 | | | | | | ||
372 | | | | | | ||
373 | | | | | | ||
374 | |(% rowspan="10" %)[[image:hz w.png]]|**Horizon W-Type**|(% colspan="4" %)**Button Functions** | ||
375 | |(% rowspan="4" %)4-Button Last Level/Off/Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
376 | |1|On|Recall Last Levels|n/a | ||
377 | |2|▲|n/a|Area Raise | ||
378 | |3|▼|n/a|Area Lower | ||
379 | |**Supported Features**|4|Off|Area Off|n/a | ||
380 | |(% rowspan="4" %)DirectLoadIds (1 load) | ||
381 | DisableOff | ||
382 | FlipRaiseLower| | | | | ||
383 | | | | | | ||
384 | | | | | | ||
385 | | | | | | ||
386 | |||
387 | = GLPPA-KP Keypads = | ||
388 | |||
389 | Due to firmware limitations, showrunner™ is only able to customize the functionality for GLPPA-KP model keypads. GLPPA-KP1, GLPPA-KP2, GLPPA-KP3, and GLPPA-KP4 keypads cannot be modified. | ||
390 | |||
391 | |(% rowspan="10" %)[[image:glppa a,ah,b.png]]|**GLPPA A-Type **|(% colspan="4" %)**Button Functions** | ||
392 | |(% rowspan="4" %)2-Button, area On/Off keypad|**Button**|**Label**|(% colspan="2" %)**Press** | ||
393 | |1|On|(% colspan="2" %)Area On | ||
394 | |2|Off|(% colspan="2" %)Area Off | ||
395 | | | | | | ||
396 | |**Supported Features**| | | | | ||
397 | |(% rowspan="4" %)DisableOff | ||
398 | LinkedAreaIds| | | | | ||
399 | | | | | | ||
400 | | | | | | ||
401 | | | | | | ||
402 | |(% rowspan="10" %)[[image:glppa a,ah,b.png]]|**GLPPA AfterHours**|(% colspan="4" %)**Button Functions** | ||
403 | |(% rowspan="4" %)2-Button, area On/Off keypad with timeout|**Button**|**Label**|(% colspan="2" %)**Press** | ||
404 | |1|On|(% colspan="2" %)Area On w/timeout | ||
405 | |2|Off|(% colspan="2" %)Area Off | ||
406 | | | | | | ||
407 | |**Supported Features**| | | | | ||
408 | |(% rowspan="4" %)DisableOff | ||
409 | LinkedAreaIds| | | | | ||
410 | | | | | | ||
411 | | | | | | ||
412 | | | | | | ||
413 | |(% rowspan="10" %)[[image:glppa a,ah,b.png]]|**GLPPA B-Type**|(% colspan="4" %)**Button Functions** | ||
414 | |(% rowspan="4" %)2-Button, area On/Off keypad with hold to Raise/Lower|**Button**|**Label**|**Press**|**Hold** | ||
415 | |1|On|Area On|Area Raise | ||
416 | |2|Off|Area Off|Area Lower | ||
417 | | | | | | ||
418 | |**Supported Features**| | | | | ||
419 | |(% rowspan="4" %)DirectLoadIds | ||
420 | DisableOff| | | | | ||
421 | | | | | | ||
422 | | | | | | ||
423 | | | | | | ||
424 | |(% rowspan="10" %)[[image:glppa d.png]]|**GLPPA D-Type**|(% colspan="4" %)**Button Functions** | ||
425 | |(% rowspan="4" %)4-Button On/Off, Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
426 | |1|On|Area On|n/a | ||
427 | |2|▲|n/a|Area Raise | ||
428 | |3|▼|n/a|Area Lower | ||
429 | |**Supported Features**|4|Off|Area Off|n/a | ||
430 | |(% rowspan="4" %)DirectLoadIds (1 load) | ||
431 | DisableOff| | | | | ||
432 | | | | | | ||
433 | | | | | | ||
434 | | | | | | ||
435 | |(% rowspan="10" %)[[image:glppa e.png]]|**GLPPA E-Type**|(% colspan="4" %)**Button Functions** | ||
436 | |(% rowspan="4" %)4-Button On/Off/Scene keypad|**Button**|**Label**|(% colspan="2" %)**Press** | ||
437 | |1|On|(% colspan="2" %)Area On | ||
438 | |2|Scene 2|(% colspan="2" %)Recall Scene 2 | ||
439 | |3|Scene 3|(% colspan="2" %)Recall Scene 3 | ||
440 | |**Supported Features**|4|Off|(% colspan="2" %)Area Off | ||
441 | |(% rowspan="4" %)DisableOff| | | | | ||
442 | | | | | | ||
443 | | | | | | ||
444 | | | | | | ||
445 | |(% rowspan="10" %)[[image:glppa f.png]]|**GLPPA F-Type**|(% colspan="4" %)**Button Functions** | ||
446 | |(% rowspan="4" %)4-Button On/Off/Scene keypad with hold to Raise/Lower|**Button**|**Label**|**Press**|**Hold** | ||
447 | |1|On|Area On|Area Raise | ||
448 | |2|Scene 2|Recall Scene 2|n/a | ||
449 | |3|Scene 3|Recall Scene 3|n/a | ||
450 | |**Supported Features**|4|Off|Area Off|Area Lower | ||
451 | |(% rowspan="4" %)DirectLoadIds | ||
452 | DisableOff | ||
453 | FlipRaiseLower| | | | | ||
454 | | | | | | ||
455 | | | | | | ||
456 | | | | | | ||
457 | |(% rowspan="10" %)[[image:glppa g.png]]|**GLPPA G-Type**|(% colspan="4" %)**Button Functions** | ||
458 | |(% rowspan="4" %)4-Button Toggle Load by Type, Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
459 | |1|Dimming On/Off|Toggle dimmable loads on/off|n/a | ||
460 | |2|▲|n/a|Area Raise | ||
461 | |3|▼|n/a|Area Lower | ||
462 | |**Supported Features**|4|Switching On/Off|Toggle switched loads on/off|n/a | ||
463 | |(% rowspan="4" %)n/a| | | | | ||
464 | | | | | | ||
465 | | | | | | ||
466 | | | | | | ||
467 | |(% rowspan="10" %)[[image:glppa ovr.png]]|**GLPPA OVR-Type**|(% colspan="4" %)**Button Functions** | ||
468 | |(% rowspan="4" %)2-Button, area override keypad|**Button**|**Label**|(% colspan="2" %)**Press** | ||
469 | |1|OVR On|(% colspan="2" %)Enable Area Override | ||
470 | |2|OVR Off|(% colspan="2" %)Disable Area Override | ||
471 | | | | | | ||
472 | |**Supported Features**| | | | | ||
473 | |(% rowspan="4" %)ControllerIds | ||
474 | DisableOff (v2.210 or later)| | | | | ||
475 | | | | | | ||
476 | | | | | | ||
477 | | | | | | ||
478 | |(% rowspan="10" %)[[image:glppa w.png]]|**GLPPA W-Type**|(% colspan="4" %)**Button Functions** | ||
479 | |(% rowspan="4" %)4-Button Last Level/Off/Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
480 | |1|On|Recall Last Levels|n/a | ||
481 | |2|Off|Area Off|n/a | ||
482 | |3|▲|n/a|Area Raise | ||
483 | |**Supported Features**|4|▼|n/a|Area Lower | ||
484 | |(% rowspan="4" %)DirectLoadIds (1 load) | ||
485 | DisableOff | ||
486 | FlipRaiseLower| | | | | ||
487 | | | | | | ||
488 | | | | | | ||
489 | | | | | | ||
490 | |||
491 | = Zūm Wired Keypads = | ||
492 | |||
493 | To use custom showrunner™ keypad types with Zūm Wired keypads, the ZUMNET-JBOX for the keypad must be in Cresnet mode. If the ZUMNET-JBOX is not in Cresnet mode then the keypads will perform the functions as programmed from the Crestron Zūm App. | ||
494 | |||
495 | |(% rowspan="10" %)[[image:zum a,ah,b.png]]|**Zūm Wired A-Type **|(% colspan="4" %)**Button Functions** | ||
496 | |(% rowspan="4" %)2-Button, area On/Off keypad|**Button**|**Label**|(% colspan="2" %)**Press** | ||
497 | |1|On|(% colspan="2" %)Area On | ||
498 | |2|Off|(% colspan="2" %)Area Off | ||
499 | | | | | | ||
500 | |**Supported Features**| | | | | ||
501 | |(% rowspan="4" %)DisableOff | ||
502 | LinkedAreaIds| | | | | ||
503 | | | | | | ||
504 | | | | | | ||
505 | | | | | | ||
506 | |(% rowspan="10" %)[[image:zum a,ah,b.png]]|**Zūm Wired AfterHours**|(% colspan="4" %)**Button Functions** | ||
507 | |(% rowspan="4" %)2-Button, area On/Off keypad with timeout|**Button**|**Label**|(% colspan="2" %)**Press** | ||
508 | |1|On|(% colspan="2" %)Area On w/timeout | ||
509 | |2|Off|(% colspan="2" %)Area Off | ||
510 | | | | | | ||
511 | |**Supported Features**| | | | | ||
512 | |(% rowspan="4" %)DisableOff | ||
513 | LinkedAreaIds| | | | | ||
514 | | | | | | ||
515 | | | | | | ||
516 | | | | | | ||
517 | |(% rowspan="10" %)[[image:zum az.gif]]|**Zūm Wired AZ-Type**|(% colspan="4" %)**Button Functions** | ||
518 | |(% rowspan="4" %)Variable 4 to 8-button Load Toggle/Dim keypad with All On/Off | ||
519 | (automatically selects layout based on number of loads in area)|**Button**|**Label**|**Press**|**Hold** | ||
520 | |1-6|Zone #|Toggle Load #|Cycle Raise/Lower Load # | ||
521 | |7|On or ▲|All Loads On|All Loads Raise | ||
522 | |8|Off or ▼|All Loads Off|All Loads Lower | ||
523 | |**Supported Features**| | | | | ||
524 | |(% rowspan="4" %)DirectLoadIds (2, 4, or 6 loads) | ||
525 | DisableOff (v3.002 or later) | ||
526 | FlipRaiseLower (v3.002 or later)| | | | | ||
527 | | | | | | ||
528 | | | | | | ||
529 | | | | | | ||
530 | |(% rowspan="10" %)[[image:zum a,ah,b.png]]|**Zūm Wired B-Type**|(% colspan="4" %)**Button Functions** | ||
531 | |(% rowspan="4" %)2-Button, area On/Off keypad with hold to Raise/Lower|**Button**|**Label**|**Press**|**Hold** | ||
532 | |1|On|Area On|Area Raise | ||
533 | |2|Off|Area Off|Area Lower | ||
534 | | | | | | ||
535 | |**Supported Features**| | | | | ||
536 | |(% rowspan="4" %)DirectLoadIds | ||
537 | DisableOff| | | | | ||
538 | | | | | | ||
539 | | | | | | ||
540 | | | | | | ||
541 | |(% rowspan="10" %)[[image:zum d.png]]|**Zūm Wired D-Type**|(% colspan="4" %)**Button Functions** | ||
542 | |(% rowspan="4" %)4-Button On/Off, Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
543 | |1|On|Area On|n/a | ||
544 | |2|▲|n/a|Area Raise | ||
545 | |3|▼|n/a|Area Lower | ||
546 | |**Supported Features**|4|Off|Area Off|n/a | ||
547 | |(% rowspan="4" %)DirectLoadIds (1 load) | ||
548 | DisableOff| | | | | ||
549 | | | | | | ||
550 | | | | | | ||
551 | | | | | | ||
552 | |(% rowspan="10" %)[[image:zum e.png]]|**Zūm Wired E-Type**|(% colspan="4" %)**Button Functions** | ||
553 | |(% rowspan="4" %)4-Button On/Off/Scene keypad|**Button**|**Label**|(% colspan="2" %)**Press** | ||
554 | |1|On|(% colspan="2" %)Area On | ||
555 | |2|Scene 2|(% colspan="2" %)Recall Scene 2 | ||
556 | |3|Scene 3|(% colspan="2" %)Recall Scene 3 | ||
557 | |**Supported Features**|4|Off|(% colspan="2" %)Area Off | ||
558 | |(% rowspan="4" %)DisableOff| | | | | ||
559 | | | | | | ||
560 | | | | | | ||
561 | | | | | | ||
562 | |(% rowspan="10" %)[[image:zum f.png]]|**Zūm Wired F-Type**|(% colspan="2" %)**Button Functions**| | | ||
563 | |(% rowspan="4" %)6-Button On/Off/Scene/Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
564 | |1|On|Area On|n/a | ||
565 | |2|Scene 2|Recall Scene 2|n/a | ||
566 | |3|Scene 3|Recall Scene 3|n/a | ||
567 | |**Supported Features**|4|Off|Area Off|n/a | ||
568 | |(% rowspan="4" %)DirectLoadIds | ||
569 | DisableOff | ||
570 | FlipRaiseLower|5|▲|n/a|Area Raise | ||
571 | |6|▼|n/a|Area Lower | ||
572 | | | | | | ||
573 | | | | | | ||
574 | |(% rowspan="10" %)[[image:zum g.png]]|**Zūm Wired G-Type**|(% colspan="4" %)**Button Functions** | ||
575 | |(% rowspan="4" %)4-Button Toggle Load by Type, Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
576 | |1|Dimming On/Off|Toggle dimmable loads on/off|n/a | ||
577 | |2|▲|n/a|Area Raise | ||
578 | |3|▼|n/a|Area Lower | ||
579 | |**Supported Features**|4|Switching On/Off|Toggle switched loads on/off|n/a | ||
580 | |(% rowspan="4" %)n/a| | | | | ||
581 | | | | | | ||
582 | | | | | | ||
583 | | | | | | ||
584 | |(% rowspan="10" %)[[image:zum n.png]]|**Zūm Wired N-Type**|(% colspan="4" %)**Button Functions** | ||
585 | |(% rowspan="4" %)6-Button Area/Load Toggle, Area Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
586 | |1|On/Off|Toggle Area On/Off|n/a | ||
587 | |2|Zone 1|Load 1 On|Load 1 Off | ||
588 | |3|Zone 2|Load 2 On|Load 2 Off | ||
589 | |**Supported Features**|4|Zone 3|Load 3 On|Load 3 Off | ||
590 | |(% rowspan="4" %)DirectLoadIds (3 loads) | ||
591 | DisableOff (v3.002 or later) | ||
592 | FlipRaiseLower (v2.210 or later)|5|▲|n/a|Area Raise | ||
593 | |6|▼|n/a|Area Lower | ||
594 | | | | | | ||
595 | | | | | | ||
596 | |(% rowspan="10" %)[[image:zum noff.png]]|**Zūm Wired NOFF-Type**|(% colspan="4" %)**Button Functions** | ||
597 | |(% rowspan="4" %)6-Button Load Toggle, Area On/Off/Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
598 | |1|On|Area On|n/a | ||
599 | |2|Zone 1|Load 1 On|Load 1 Off | ||
600 | |3|Zone 2|Load 2 On|Load 2 Off | ||
601 | |**Supported Features**|4|Off|Area Off|n/a | ||
602 | |(% rowspan="4" %)DirectLoadIds (2 loads) | ||
603 | DisableOff (v2.210 or later) | ||
604 | FlipRaiseLower (v2.210 or later)|5|▲|n/a|Area Raise | ||
605 | |6|▼|n/a|Area Lower | ||
606 | | | | | | ||
607 | | | | | | ||
608 | |(% rowspan="10" %)[[image:zum ovr.png]]|**Zūm Wired OVR-Type**|(% colspan="4" %)**Button Functions** | ||
609 | |(% rowspan="4" %)2-Button, area override keypad|**Button**|**Label**|(% colspan="2" %)**Press** | ||
610 | |1|OVR On|(% colspan="2" %)Enable Area Override | ||
611 | |2|OVR Off|(% colspan="2" %)Disable Area Override | ||
612 | | | | | | ||
613 | |**Supported Features**| | | | | ||
614 | |(% rowspan="4" %)ControllerIds | ||
615 | DisableOff (v2.210 or later)| | | | | ||
616 | | | | | | ||
617 | | | | | | ||
618 | | | | | | ||
619 | |(% rowspan="10" %)[[image:zum w.png]]|**Zūm Wired W-Type**|(% colspan="4" %)**Button Functions** | ||
620 | |(% rowspan="4" %)4-Button Last Level/Off/Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
621 | |1|On|Recall Last Levels|n/a | ||
622 | |2|Off|Area Off|n/a | ||
623 | |3|▲|n/a|Area Raise | ||
624 | |**Supported Features**|4|▼|n/a|Area Lower | ||
625 | |(% rowspan="4" %)DirectLoadIds (1 load) | ||
626 | DisableOff | ||
627 | FlipRaiseLower| | | | | ||
628 | | | | | | ||
629 | | | | | | ||
630 | | | | | | ||
631 | |||
632 | = Zūm Wireless Keypads = | ||
633 | |||
634 | Due to limitations with Zūm Wireless firmware, showrunner™ is not able to provide the same level of customization for Zūm Wireless keypads as is possible with other keypad types. Instead, showrunner™ supports only the standard Crestron Zūm Wireless keypad types. | ||
635 | |||
636 | |(% rowspan="10" %)[[image:zumwl a.png]]|**Zūm Wireless A-Type **|(% colspan="4" %)**Button Functions** | ||
637 | |(% rowspan="4" %)2-Button, area On/Off keypad with hold to Raise/Lower|**Button**|**Label**|**Press**|**Hold** | ||
638 | |1|On|Area On|Area Raise | ||
639 | |2|Off|Area Off|Area Lower | ||
640 | | | | | | ||
641 | |**Supported Features**| | | | | ||
642 | |(% rowspan="4" %)n/a| | | | | ||
643 | | | | | | ||
644 | | | | | | ||
645 | | | | | | ||
646 | |(% rowspan="10" %)[[image:zumwl b.png]]|**Zūm Wireless B-Type**|(% colspan="4" %)**Button Functions** | ||
647 | |(% rowspan="4" %)4-Button area On/Off/Scene keypad|**Button**|**Label**|**Press**|**Hold** | ||
648 | |1|On|Area On|Area Raise | ||
649 | |2|Scene 2|Recall Scene 2|Save Scene 2 | ||
650 | |3|Scene 3|Recall Scene 3|Save Scene 3 | ||
651 | |**Supported Features**|4|Off|Area Off|Area Lower | ||
652 | |(% rowspan="4" %)n/a| | | | | ||
653 | | | | | | ||
654 | | | | | | ||
655 | | | | | | ||
656 | |(% rowspan="10" %)[[image:zumwl c.png]]|**Zūm Wireless C-Type**|(% colspan="4" %)**Button Functions** | ||
657 | |(% rowspan="4" %)6-Button area On/Off/Scene keypad with Raise/Lower|**Button**|**Label**|**Press**|**Hold** | ||
658 | |1|On|Area On|n/a | ||
659 | |2|Scene 2|Recall Scene 2|Save Scene 2 | ||
660 | |3|Scene 3|Recall Scene 3|Save Scene 3 | ||
661 | |**Supported Features**|4|Off|Area Off|n/a | ||
662 | |(% rowspan="4" %)n/a|5|▲|n/a|Area Raise | ||
663 | |6|▼|n/a|Area Lower | ||
664 | | | | | | ||
665 | | | | | | ||
666 | |(% rowspan="10" %)[[image:zumwl d.png]]|**Zūm Wireless D-Type**|(% colspan="4" %)**Button Functions** | ||
667 | |(% rowspan="4" %)6-Button area On/Off/Scene keypad with Raise/Lower and Sensor Disable|**Button**|**Label**|**Press**|**Hold** | ||
668 | |1|On|Area On|n/a | ||
669 | |2|Scene 2|Recall Scene 2|Save Scene 2 | ||
670 | |3|Sensor Disable|Disable Occupancy|Enable Occupancy | ||
671 | |**Supported Features**|4|Off|Area Off|n/a | ||
672 | |(% rowspan="4" %)n/a|5|▲|n/a|Area Raise | ||
673 | |6|▼|n/a|Area Lower | ||
674 | | | | | | ||
675 | | | | | | ||
676 | |||
677 | = X-Type Keypad Actions = | ||
678 | |||
679 | The showrunner™ X-Type keypad is a customizable keypad type available for Cameo, Horizon, GLPPA-KP, and Zūm Wired keypads. See[[ this document>>attach:showrunnerKeypadStyles.pdf]] for a list of possible keypad layouts for all keypad types. Instructions for configuring X-Type keypads from the showrunnerHUB UI are available [[here>>https://wiki.chiefintegrations.com/download/SHOWRUNNER%E2%84%A2%20Setup%20Guide/showrunnerHUB%E2%84%A2/Keypad%20Configuration/WebHome/CI%20Keypad%20Editor%20UI%20Guide.pdf?rev=1.2]]. | ||
680 | |||
681 | The table below is a comprehensive list of actions which can be used to manually configure X-Type keypads from the SrConfig.json file. The table was generated using showrunner™ v3.019, but can be viewed for any version of showrunner™ by connecting to a processor running the desired version of showrunner™ and running the command: ##sr sh ac## | ||
682 | |||
683 | Note that actions with "None" listed under "Triggers" are read-only and are only able to be used for keypad or keyswitch feedback. | ||
684 | |||
685 | == X-Type Actions Table == | ||
686 | (% class="table-condensed" id="xActionsTable" %) | ||
687 | |** Type**|**Action**|**Action Description**|**Reference Property**|**Reference Required**|**Triggers**|**Supported Properties** | ||
688 | |EDmxReceiver|Disable|Turns off E-DMX Receiver|n/a|False|Digital, Analog|n/a | ||
689 | |EDmxReceiver|Enable|Turns on the E-DMX Receiver|n/a|False|Digital, Analog|n/a | ||
690 | |EDmxReceiver|UpdateLoadsDisable|Disables the transfer of E-DMX Values to hardware loads|n/a|False|Digital, Analog|n/a | ||
691 | |EDmxReceiver|UpdateLoadsEnable|Enables the transfer of E-DMX Values to hardware loads|n/a|False|Digital, Analog|n/a | ||
692 | |GlobalActions|CctSourceSensor|Select which sensor the system will accept CCT values from|SensorId|True|Digital, Analog|'SensorId'{{{:(}}}Integer)'Id of the sensor to use as reference' | ||
693 | |GlobalActions|DemandResponseOff|Turns demand response off system wide|n/a|False|Digital, Analog|n/a | ||
694 | |GlobalActions|DemandResponseOn|Turns demand response system wide|n/a|False|Digital, Analog|n/a | ||
695 | |GlobalActions|Execute|Executes the global action|ActionId|True|Digital, Analog|'ActionId'{{{:(}}}Integer)'Action to recall' | ||
696 | |GlobalActions|ExecuteLastEvent|Executes the last event that fired before the current time globally and in each group|n/a|False|Digital, Analog|Global'{{{:(}}}Boolean)'Recall last global event' | ||
697 | 'GroupUniqueIds'{{{:(}}}String)'Limits group IDs to those specified in the list. Specify n/a if all groups or comma separated list of UniqueIDs' | ||
698 | |GlobalActions|Log|Adds an entry to the system log|n/a|False|Digital, Analog|Message'{{{:(}}}String)'Message to add to the log' | ||
699 | 'Severity'{{{:(}}}String)'Severity, default to 'Notice' if not specified. Valid values: Notice ~| Warn ~| Error ~| Exception' | ||
700 | |GlobalActions|MasterOff|Turns off areas system wide|n/a|False|Digital, Analog|n/a | ||
701 | |GlobalActions|MasterOn|Turns On areas system wide|n/a|False|Digital, Analog|n/a | ||
702 | |GlobalActions|MasterOverrideOff|Deactivates the system wide override|n/a|False|Digital, Analog|n/a | ||
703 | |GlobalActions|MasterOverrideOn|Activates the system wide override|n/a|False|Digital, Analog|n/a | ||
704 | |GlobalActions|NodeOff|Turns off areas system wide|n/a|False|Digital, Analog|'NodeId'{{{:(}}}String)'GUID of the Node' | ||
705 | |GlobalActions|NodeOn|Turns On areas system wide|n/a|False|Digital, Analog|'NodeId'{{{:(}}}String)'GUID of the Node' | ||
706 | |GlobalActions|RemoteGlobalExecute|Execute a global action on a remote system|n/a|False|Digital, Analog|GlobalActionId'{{{:(}}}Integer)'Global Action Id on the Remote System to execute' | ||
707 | 'RemoteSystemId'{{{:(}}}Integer)'System ID of the Remote System' | ||
708 | |GlobalActions|SchedulerDisable|Disables the scheduler|n/a|False|Digital, Analog|n/a | ||
709 | |GlobalActions|SchedulerEnable|Enables the scheduler|n/a|False|Digital, Analog|n/a | ||
710 | |GlobalActions|TagOff|Turns off areas system wide|n/a|False|Digital, Analog|'TagId'{{{:(}}}String)'GUID of the Tag' | ||
711 | |GlobalActions|TagOn|Turns On areas system wide|n/a|False|Digital, Analog|'TagId'{{{:(}}}String)'GUID of the Tag' | ||
712 | |Load|CctLower|Lowers the CCT for a CCT load|n/a|False|Digital, Analog|n/a | ||
713 | |Load|CctRaise|CctRaises the light level on the load|n/a|False|Digital, Analog|n/a | ||
714 | |Load|CctRaiseLower|Raises/Lowers the CCT on the load|n/a|False|Digital, Analog|n/a | ||
715 | |Load|CctStop|Stop CCT raise/lower on the load|n/a|False|Digital, Analog|n/a | ||
716 | |Load|Disable|Turns off the load and prevents it from being controlled|n/a|False|Digital, Analog|n/a | ||
717 | |Load|Enable|Enables the load and allows normal operation|n/a|False|Digital, Analog|n/a | ||
718 | |Load|Lower|Lowers the load|n/a|False|Digital, Analog|n/a | ||
719 | |Load|LowerScene|Lowers all loads that belong to a scene|SceneId|True|Digital, Analog|'SceneId'{{{:(}}}Integer)'Scene Number to raise' | ||
720 | |Load|Off|Turns off the load|n/a|False|Digital, Analog|n/a | ||
721 | |Load|On|Turns on the load|n/a|False|Digital, Analog|n/a | ||
722 | |Load|OnWithTimeout|Turns on the load for a specified time|Timeout|False|Digital, Analog|'Timeout'{{{:(}}}Integer)'Timeout in seconds' | ||
723 | |Load|OverrideDisable|Deactivates override on the load|n/a|False|Digital, Analog|n/a | ||
724 | |Load|OverrideEnable|Activates override on the load|n/a|False|Digital, Analog|n/a | ||
725 | |Load|Raise|Raises the light level on the load|n/a|False|Digital, Analog|n/a | ||
726 | |Load|RaiseLower|Raise/Lowers the light level on the load|n/a|False|Digital, Analog|n/a | ||
727 | |Load|RaiseLowerScene|Raises/Lowers all loads that belong to a scene|SceneId|True|Digital, Analog|'SceneId'{{{:(}}}Integer)'Scene Number to raise/lower' | ||
728 | |Load|RaiseScene|Raises all loads that belong to a scene|SceneId|True|Digital, Analog|'SceneId'{{{:(}}}Integer)'Scene Number to raise' | ||
729 | |Load|RecallScene|Recalls the specified scene on this load|SceneId|False|Digital, Analog|'SceneId'{{{:(}}}Integer)'Scene Number to recall' | ||
730 | |Load|ReleaseScene|Releases the scene from the load, functionally turning off any loads that are included in the scene|SceneId|True|Digital, Analog|'SceneId'{{{:(}}}Integer)'Scene Number to recall' | ||
731 | |Load|SceneToggle|SceneToggle switches between two scenes on a load|OnScene|True|Digital, Analog|OffScene'{{{:(}}}Integer)'Scene used when toggle triggers the off state' | ||
732 | 'OnScene'{{{:(}}}Integer)'Scene used when toggle triggers the on state' | ||
733 | |Load|SetCct|Recalls the specified Cct on this load|Cct|True|Digital, Analog|Cct'{{{:(}}}Integer)'Cct to recall' | ||
734 | 'FadeTime'{{{:(}}}Double)'Fade time to recall level over' | ||
735 | |Load|SetLevel|Recalls the specified level on this load|Level|True|Digital, Analog|FadeTime'{{{:(}}}Double)'Fade time to recall level over' | ||
736 | 'Level'{{{:(}}}Integer)'Level to recall' | ||
737 | |Load|SetLevelByByte|Recalls the specified level on this load as a byte|Level|True|Digital, Analog|FadeTime'{{{:(}}}Double)'Fade time to recall level over' | ||
738 | 'Level'{{{:(}}}Integer)'Level to recall as a byte' | ||
739 | |Load|Stop|Stop raise/lower on the load|n/a|False|Digital, Analog|n/a | ||
740 | |Load|StopScene|Releases the scene from the load, functionally turning off any loads that are included in the scene|SceneId|True|Digital, Analog|'SceneId'{{{:(}}}Integer)'Scene Number to recall' | ||
741 | |Load|Toggle|Toggles the load|n/a|False|Digital, Analog|n/a | ||
742 | |LoadController|OverrideDisable|Deactivates override on the load controller|n/a|False|Digital, Analog|n/a | ||
743 | |LoadController|OverrideEnable|Activates override on the load controller|n/a|False|Digital, Analog|n/a | ||
744 | |LoadController|RecallScene|Recalls the specified scene on this load|SceneId|False|Digital, Analog|'SceneId'{{{:(}}}Integer)'Scene Number to recall' | ||
745 | |LoadController|ReleaseScene|Releases the specified scene on this load controller|SceneId|False|Digital, Analog|'SceneId'{{{:(}}}Integer)'Scene Number to Release' | ||
746 | |OutputSignal|Disable|Disables the output signal|n/a|False|Digital, Analog|n/a | ||
747 | |OutputSignal|Enable|Enables the output signal|n/a|False|Digital, Analog|n/a | ||
748 | |PartitionSensor|Combined|Reports the sensor is combined|n/a|False|None|n/a | ||
749 | |PartitionSensor|Disable|Disables the paritition sensor|n/a|False|Digital, Analog|n/a | ||
750 | |PartitionSensor|Divided|Reports the sensor is Divided|n/a|False|None|n/a | ||
751 | |PartitionSensor|Enable|Enables the partition sensor|n/a|False|Digital, Analog|n/a | ||
752 | |PartitionSensor|ModeAuto|Sets the sensor to auto mode|n/a|False|Digital, Analog|n/a | ||
753 | |PartitionSensor|ModeCombined|Sets the sensor to combined mode|n/a|False|Digital, Analog|n/a | ||
754 | |PartitionSensor|ModeDivided|Sets the sensor to divided mode|n/a|False|Digital, Analog|n/a | ||
755 | |Photocell|AboveThreshold|Photocell reading is above the threshold (it's bright out)|n/a|False|None|n/a | ||
756 | |Photocell|BelowThreshold|Photocell reading is below the threshold (it's dark out)|n/a|False|None|n/a | ||
757 | |Photocell|Disable|Disables the photocell sensor|n/a|False|Digital, Analog|n/a | ||
758 | |Photocell|Enable|Enables the photocell sensor|n/a|False|Digital, Analog|n/a | ||
759 | |Shade|Close|Closes the shade|n/a|False|Digital, Analog|n/a | ||
760 | |Shade|JogClose|Jog Close the shade|JogTime|True|Digital, Analog|'JogTime'{{{:(}}}Integer)'Time to Jog in ms' | ||
761 | |Shade|JogOpen|Jog Open the shade|JogTime|True|Digital, Analog|'JogTime'{{{:(}}}Integer)'Time to Jog in ms' | ||
762 | |Shade|Lower|Lowers the shade|n/a|False|Digital, Analog|n/a | ||
763 | |Shade|NextPreset|Steps to the next preset on the shade, goes back to start if at end|n/a|False|Digital, Analog|n/a | ||
764 | |Shade|Open|Opens the shade|n/a|False|Digital, Analog|n/a | ||
765 | |Shade|PreviousPreset|Steps to the Previous preset on the shade, goes back to end if at start|n/a|False|Digital, Analog|n/a | ||
766 | |Shade|Raise|Raises the shade|n/a|False|Digital, Analog|n/a | ||
767 | |Shade|SetPosition|Sets the position of the shade|Position|True|Digital, Analog|'Position'{{{:(}}}Integer)'Position of the shade 0-65535' | ||
768 | |Shade|Stop|Stop raise/lower on the load|n/a|False|Digital, Analog|n/a | ||
769 | |Shade|Toggle|Toggles the shade between open and close|n/a|False|Digital, Analog|n/a | ||
770 | |LoadGroup|Disable|Turns off the load and prevents it from being controlled|n/a|False|Digital, Analog|n/a | ||
771 | |LoadGroup|Enable|Enables the load and allows normal operation|n/a|False|Digital, Analog|n/a | ||
772 | |LoadGroup|Lower|Lowers the load|n/a|False|Digital, Analog|n/a | ||
773 | |LoadGroup|Off|Turns off the load|n/a|False|Digital, Analog|n/a | ||
774 | |LoadGroup|On|Turns on the load|n/a|False|Digital, Analog|n/a | ||
775 | |LoadGroup|OnWithTimeout|Turns on the load group for a specified time|Timeout|False|Digital, Analog|'Timeout'{{{:(}}}Integer)'Timeout in seconds' | ||
776 | |LoadGroup|OverrideDisable|Deactivates override on the load|n/a|False|Digital, Analog|n/a | ||
777 | |LoadGroup|OverrideEnable|Activates override on the load|n/a|False|Digital, Analog|n/a | ||
778 | |LoadGroup|Raise|Raises the light level on the load|n/a|False|Digital, Analog|n/a | ||
779 | |LoadGroup|RaiseLower|Raise/Lowers the light level on the load|n/a|False|Digital, Analog|n/a | ||
780 | |LoadGroup|RaiseLowerScene|Raises/Lowers all loads that belong to a scene|SceneId|True|Digital, Analog|'SceneId'{{{:(}}}Integer)'Scene Number to raise/lower' | ||
781 | |LoadGroup|RecallScene|Recalls the specified scene on this load|SceneId|False|Digital, Analog|'SceneId'{{{:(}}}Integer)'Scene Number to recall' | ||
782 | |LoadGroup|ReleaseScene|Releases the scene from the load, functionally turning off any loads that are included in the scene|SceneId|True|Digital, Analog|'SceneId'{{{:(}}}Integer)'Scene Number to recall' | ||
783 | |LoadGroup|SceneToggle|SceneToggle switches between two scenes on a load|OnScene|True|Digital, Analog|OffScene'{{{:(}}}Integer)'Scene used when toggle triggers the off state' | ||
784 | 'OnScene'{{{:(}}}Integer)'Scene used when toggle triggers the on state' | ||
785 | |LoadGroup|SetCct|Recalls the specified Cct on this load|Cct|True|Digital, Analog|'Cct'{{{:(}}}Integer)'Cct to recall' | ||
786 | |LoadGroup|SetLevel|Recalls the specified level on this load|Level|True|Digital, Analog|FadeTime'{{{:(}}}Double)'Fade time to recall level over' | ||
787 | 'Level'{{{:(}}}Integer)'Level to recall' | ||
788 | |LoadGroup|Stop|Stop raise/lower on the load|n/a|False|Digital, Analog|n/a | ||
789 | |LoadGroup|StopScene|Stops the raise/lower on any load that is included in the scene|SceneId|True|Digital, Analog|'SceneId'{{{:(}}}Integer)'Scene Number to affect' | ||
790 | |LoadGroup|Toggle|Toggles the load|n/a|False|Digital, Analog|n/a | ||
791 | |ShadeGroup|Close|Closes the shade|n/a|False|Digital, Analog|n/a | ||
792 | |ShadeGroup|NextPreset|Steps to the next preset on the shade, goes back to start if at end|n/a|False|Digital, Analog|n/a | ||
793 | |ShadeGroup|Open|Opens the shade|n/a|False|Digital, Analog|n/a | ||
794 | |ShadeGroup|PreviousPreset|Steps to the Previous preset on the shade, goes back to end if at start|n/a|False|Digital, Analog|n/a | ||
795 | |ShadeGroup|Stop|Stop raise/lower on the load|n/a|False|Digital, Analog|n/a | ||
796 | |BaseKeypad|Disable|Disables the keypad|n/a|False|Digital, Analog|n/a | ||
797 | |BaseKeypad|Enable|Enables the keypad|n/a|False|Digital, Analog|n/a | ||
798 | |BaseKeypad|EnableToggle|Toggles Enable for the keypad|n/a|False|Digital, Analog|n/a | ||
799 | |BaseKeypad|MasterRaiseLowerReference|Evaluates to see if the referenced HostGlobalId is in the master raise/lower list|GlobalIds|True|None|'GlobalIds'{{{:(}}}String)'GlobalIds to reference when comparing to see if master raise/lower is active. Use comma/dash separated list of numbers.' | ||
800 | |Area|CancelTimeout|Cancel Timeout operation|n/a|False|Digital, Analog|n/a | ||
801 | |Area|ExtendOccupancyTimeoutSetting|Extend the Occupancy Timeout Setting in the area|Timeout|True|Digital, Analog|'Timeout'{{{:(}}}Integer)'Timeout in seconds' | ||
802 | |Area|Lower|Lowers the area|n/a|False|Digital, Analog|n/a | ||
803 | |Area|LowerScene|Lowers all loads that belong to a scene|SceneId|True|Digital, Analog|'SceneId'{{{:(}}}Integer)'Scene Number to lower' | ||
804 | |Area|OccupancyMode|Changes the occupancy mode of an area|Mode|True|Digital, Analog|'Mode'{{{:(}}}String)'Name of the mode' | ||
805 | |Area|Occupied|Reports the occupied status of an area|n/a|False|None|n/a | ||
806 | |Area|Off|Turns off the area|n/a|False|Digital, Analog|n/a | ||
807 | |Area|On|Turns on the area|n/a|False|Digital, Analog|n/a | ||
808 | |Area|OnWithTimeout|Turns on the area for a specified time|Timeout|False|Digital, Analog|'Timeout'{{{:(}}}Integer)'Timeout in Seconds' | ||
809 | |Area|OverrideDisable|Deactivates override on the area|n/a|False|Digital, Analog|n/a | ||
810 | |Area|OverrideEnable|Activates override on the area|n/a|False|Digital, Analog|n/a | ||
811 | |Area|Raise|Raises the light level on the area|n/a|False|Digital, Analog|n/a | ||
812 | |Area|RaiseLower|Raise/Lowers the light level on the area|n/a|False|Digital, Analog|n/a | ||
813 | |Area|RaiseLowerScene|Raises/Lowers all loads that belong to a scene|SceneId|True|Digital, Analog|'SceneId'{{{:(}}}Integer)'Scene Number to raise/lower' | ||
814 | |Area|RaiseScene|Raises all loads that belong to a scene|SceneId|True|Digital, Analog|'SceneId'{{{:(}}}Integer)'Scene Number to raise' | ||
815 | |Area|RecallLastLevel|Turns RecallLastLevel the area|n/a|False|Digital, Analog|n/a | ||
816 | |Area|RecallScene|Recalls the specified scene on this load|SceneId|False|Digital, Analog|'SceneId'{{{:(}}}Integer)'Scene Number to recall' | ||
817 | |Area|ReleaseScene|Releases the scene from the load, functionally turning off any loads that are included in the scene|SceneId|True|Digital, Analog|'SceneId'{{{:(}}}Integer)'Scene Number to recall' | ||
818 | |Area|SceneCycle|SceneCycle steps through a list of scenes|OnScene|True|Digital, Analog|OnScene'{{{:(}}}Integer)'Scene used to indicate feedback' | ||
819 | 'SceneList'{{{:(}}}String)'Comma and dash delimited list of scenes to cycle through' | ||
820 | |Area|SceneToggle|SceneToggle switches between two scenes on an area|OnScene|True|Digital, Analog|OffScene'{{{:(}}}Integer)'Scene used when toggle triggers the off state' | ||
821 | 'OnScene'{{{:(}}}Integer)'Scene used when toggle triggers the on state' | ||
822 | |Area|SetCct|Recalls the specified Cct on this area|Cct|True|Digital, Analog|'Cct'{{{:(}}}Integer)'Cct to recall' | ||
823 | |Area|SetCctAuto|Sets the CCT Mode to auto|n/a|False|Digital, Analog|n/a | ||
824 | |Area|ShadeClose|Close All Area Shades|n/a|False|Digital, Analog|n/a | ||
825 | |Area|ShadeOpen|Open All Area Shades|n/a|False|Digital, Analog|n/a | ||
826 | |Area|ShadeStop|Stop All Area Shades|n/a|False|Digital, Analog|n/a | ||
827 | |Area|Stop|Stop raise/lower on the area|n/a|False|Digital, Analog|n/a | ||
828 | |Area|StopScene|Stops the raise/lower on any load that is included in the scene|SceneId|True|Digital, Analog|'SceneId'{{{:(}}}Integer)'Scene Number to affect' | ||
829 | |Area|Toggle|Toggles the area on/off|n/a|False|Digital, Analog|n/a | ||
830 | |Keyswitch|Active|Reports the keyswitch state|n/a|False|Digital, Analog|n/a | ||
831 | |Keyswitch|Disable|Disables the keyswitch|n/a|False|Digital, Analog|n/a | ||
832 | |Keyswitch|Enable|Enables the keyswitch|n/a|False|Digital, Analog|n/a | ||
833 | |Occupancy|Disable|Disables the occupancy sensor|n/a|False|Digital, Analog|n/a | ||
834 | |Occupancy|Enable|Enables the occupancy sensor|n/a|False|Digital, Analog|n/a | ||
835 | |Occupancy|Occupied|Reports the occupied status of an occupancy sensor|n/a|False|None|n/a |