Wiki source code of SHOWRUNNER™ Keypad Types
Version 93.1 by Alexander Mott on 2022/08/23 21:10
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box title="**Contents**"}} | ||
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 5 | (% class="row" %) | ||
| 6 | ((( | ||
| 7 | = Overview = | ||
| 8 | |||
| 9 | 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. | ||
| 10 | |||
| 11 | = Cameo Keypads = | ||
| 12 | |||
| 13 | The | ||
| 14 | |||
| 15 | (% style="color:inherit; font-family:inherit; font-size:29px" %)Horizon Keypads | ||
| 16 | |||
| 17 | The | ||
| 18 | |||
| 19 | = GLPPA-KP Keypads = | ||
| 20 | |||
| 21 | 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. | ||
| 22 | |||
| 23 | |(% rowspan="10" %)[[image:glppa a,ah,b.png]]|**GLPPA A-Type **|(% colspan="4" %)**Button Functions** | ||
| 24 | |(% rowspan="4" %)2-Button, area On/Off keypad|**Button**|**Label**|(% colspan="2" %)**Press** | ||
| 25 | |1|On|(% colspan="2" %)Area On | ||
| 26 | |2|Off|(% colspan="2" %)Area Off | ||
| 27 | | | | | | ||
| 28 | |**Supported Features**| | | | | ||
| 29 | |(% rowspan="4" %)DisableOff | ||
| 30 | LinkedAreaIds| | | | | ||
| 31 | | | | | | ||
| 32 | | | | | | ||
| 33 | | | | | | ||
| 34 | |(% rowspan="10" %)[[image:glppa a,ah,b.png]]|**GLPPA AfterHours**|(% colspan="4" %)**Button Functions** | ||
| 35 | |(% rowspan="4" %)2-Button, area On/Off keypad with timeout|**Button**|**Label**|(% colspan="2" %)**Press** | ||
| 36 | |1|On|(% colspan="2" %)Area On w/timeout | ||
| 37 | |2|Off|(% colspan="2" %)Area Off | ||
| 38 | | | | | | ||
| 39 | |**Supported Features**| | | | | ||
| 40 | |(% rowspan="4" %)DisableOff | ||
| 41 | LinkedAreaIds| | | | | ||
| 42 | | | | | | ||
| 43 | | | | | | ||
| 44 | | | | | | ||
| 45 | |(% rowspan="10" %)[[image:glppa a,ah,b.png]]|**GLPPA B-Type**|(% colspan="4" %)**Button Functions** | ||
| 46 | |(% rowspan="4" %)2-Button, area On/Off keypad with hold to Raise/Lower|**Button**|**Label**|**Press**|**Hold** | ||
| 47 | |1|On|Area On|Area Raise | ||
| 48 | |2|Off|Area Off|Area Lower | ||
| 49 | | | | | | ||
| 50 | |**Supported Features**| | | | | ||
| 51 | |(% rowspan="4" %)DirectLoadIds | ||
| 52 | DisableOff| | | | | ||
| 53 | | | | | | ||
| 54 | | | | | | ||
| 55 | | | | | | ||
| 56 | |(% rowspan="10" %)[[image:glppa d.png]]|**GLPPA D-Type**|(% colspan="4" %)**Button Functions** | ||
| 57 | |(% rowspan="4" %)4-Button On/Off, Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
| 58 | |1|On|Area On|n/a | ||
| 59 | |2|▲|n/a|Area Raise | ||
| 60 | |3|▼|n/a|Area Lower | ||
| 61 | |**Supported Features**|4|Off|Area Off|n/a | ||
| 62 | |(% rowspan="4" %)DirectLoadIds (1 load) | ||
| 63 | DisableOff| | | | | ||
| 64 | | | | | | ||
| 65 | | | | | | ||
| 66 | | | | | | ||
| 67 | |(% rowspan="10" %)[[image:glppa e.png]]|**GLPPA E-Type**|(% colspan="4" %)**Button Functions** | ||
| 68 | |(% rowspan="4" %)4-Button On/Off/Scene keypad|**Button**|**Label**|(% colspan="2" %)**Press** | ||
| 69 | |1|On|(% colspan="2" %)Area On | ||
| 70 | |2|Scene 2|(% colspan="2" %)Recall Scene 2 | ||
| 71 | |3|Scene 3|(% colspan="2" %)Recall Scene 3 | ||
| 72 | |**Supported Features**|4|Off|(% colspan="2" %)Area Off | ||
| 73 | |(% rowspan="4" %)DisableOff| | | | | ||
| 74 | | | | | | ||
| 75 | | | | | | ||
| 76 | | | | | | ||
| 77 | |(% rowspan="10" %)[[image:glppa f.png]]|**GLPPA F-Type**|(% colspan="4" %)**Button Functions** | ||
| 78 | |(% rowspan="4" %)4-Button On/Off/Scene keypad with hold to Raise/Lower|**Button**|**Label**|**Press**|**Hold** | ||
| 79 | |1|On|Area On|Area Raise | ||
| 80 | |2|Scene 2|Recall Scene 2|n/a | ||
| 81 | |3|Scene 3|Recall Scene 3|n/a | ||
| 82 | |**Supported Features**|4|Off|Area Off|Area Lower | ||
| 83 | |(% rowspan="4" %)DirectLoadIds | ||
| 84 | DisableOff | ||
| 85 | FlipRaiseLower| | | | | ||
| 86 | | | | | | ||
| 87 | | | | | | ||
| 88 | | | | | | ||
| 89 | |(% rowspan="10" %)[[image:glppa g.png]]|**GLPPA G-Type**|(% colspan="4" %)**Button Functions** | ||
| 90 | |(% rowspan="4" %)4-Button Toggle Load by Type, Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
| 91 | |1|Dimming On/Off|Toggle dimmable loads on/off|n/a | ||
| 92 | |2|▲|n/a|Area Raise | ||
| 93 | |3|▼|n/a|Area Lower | ||
| 94 | |**Supported Features**|4|Switching On/Off|Toggle switched loads on/off|n/a | ||
| 95 | |(% rowspan="4" %)n/a| | | | | ||
| 96 | | | | | | ||
| 97 | | | | | | ||
| 98 | | | | | | ||
| 99 | |(% rowspan="10" %)[[image:glppa ovr.png]]|**GLPPA OVR-Type**|(% colspan="4" %)**Button Functions** | ||
| 100 | |(% rowspan="4" %)2-Button, area override keypad|**Button**|**Label**|(% colspan="2" %)**Press** | ||
| 101 | |1|OVR On|(% colspan="2" %)Enable Area Override | ||
| 102 | |2|OVR Off|(% colspan="2" %)Disable Area Override | ||
| 103 | | | | | | ||
| 104 | |**Supported Features**| | | | | ||
| 105 | |(% rowspan="4" %)ControllerIds | ||
| 106 | DisableOff (v2.210 or later)| | | | | ||
| 107 | | | | | | ||
| 108 | | | | | | ||
| 109 | | | | | | ||
| 110 | |(% rowspan="10" %)[[image:glppa w.png]]|**GLPPA W-Type**|(% colspan="4" %)**Button Functions** | ||
| 111 | |(% rowspan="4" %)4-Button Last Level/Off/Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
| 112 | |1|On|Recall Last Levels|n/a | ||
| 113 | |2|Off|Area Off|n/a | ||
| 114 | |3|▲|n/a|Area Raise | ||
| 115 | |**Supported Features**|4|▼|n/a|Area Lower | ||
| 116 | |(% rowspan="4" %)DirectLoadIds (1 load) | ||
| 117 | DisableOff | ||
| 118 | FlipRaiseLower| | | | | ||
| 119 | | | | | | ||
| 120 | | | | | | ||
| 121 | | | | | | ||
| 122 | |||
| 123 | = Zūm Wired Keypads = | ||
| 124 | |||
| 125 | 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. | ||
| 126 | |||
| 127 | |(% rowspan="10" %)[[image:zum a,ah,b.png]]|**Zūm Wired A-Type **|(% colspan="4" %)**Button Functions** | ||
| 128 | |(% rowspan="4" %)2-Button, area On/Off keypad|**Button**|**Label**|(% colspan="2" %)**Press** | ||
| 129 | |1|On|(% colspan="2" %)Area On | ||
| 130 | |2|Off|(% colspan="2" %)Area Off | ||
| 131 | | | | | | ||
| 132 | |**Supported Features**| | | | | ||
| 133 | |(% rowspan="4" %)DisableOff | ||
| 134 | LinkedAreaIds| | | | | ||
| 135 | | | | | | ||
| 136 | | | | | | ||
| 137 | | | | | | ||
| 138 | |(% rowspan="10" %)[[image:zum a,ah,b.png]]|**Zūm Wired AfterHours**|(% colspan="4" %)**Button Functions** | ||
| 139 | |(% rowspan="4" %)2-Button, area On/Off keypad with timeout|**Button**|**Label**|(% colspan="2" %)**Press** | ||
| 140 | |1|On|(% colspan="2" %)Area On w/timeout | ||
| 141 | |2|Off|(% colspan="2" %)Area Off | ||
| 142 | | | | | | ||
| 143 | |**Supported Features**| | | | | ||
| 144 | |(% rowspan="4" %)DisableOff | ||
| 145 | LinkedAreaIds| | | | | ||
| 146 | | | | | | ||
| 147 | | | | | | ||
| 148 | | | | | | ||
| 149 | |(% rowspan="10" %)[[image:zum az.gif]]|**Zūm Wired AZ-Type**|(% colspan="4" %)**Button Functions** | ||
| 150 | |(% rowspan="4" %)Variable 4 to 8-button Load Toggle/Dim keypad with All On/Off | ||
| 151 | (automatically selects layout based on number of loads in area)|**Button**|**Label**|**Press**|**Hold** | ||
| 152 | |1-6|Zone #|Toggle Load #|Cycle Raise/Lower Load # | ||
| 153 | |7|On or ▲|All Loads On|All Loads Raise | ||
| 154 | |8|Off or ▼|All Loads Off|All Loads Lower | ||
| 155 | |**Supported Features**| | | | | ||
| 156 | |(% rowspan="4" %)DirectLoadIds (2, 4, or 6 loads) | ||
| 157 | DisableOff (v3.002 or later) | ||
| 158 | FlipRaiseLower (v3.002 or later)| | | | | ||
| 159 | | | | | | ||
| 160 | | | | | | ||
| 161 | | | | | | ||
| 162 | |(% rowspan="10" %)[[image:zum a,ah,b.png]]|**Zūm Wired B-Type**|(% colspan="4" %)**Button Functions** | ||
| 163 | |(% rowspan="4" %)2-Button, area On/Off keypad with hold to Raise/Lower|**Button**|**Label**|**Press**|**Hold** | ||
| 164 | |1|On|Area On|Area Raise | ||
| 165 | |2|Off|Area Off|Area Lower | ||
| 166 | | | | | | ||
| 167 | |**Supported Features**| | | | | ||
| 168 | |(% rowspan="4" %)DirectLoadIds | ||
| 169 | DisableOff| | | | | ||
| 170 | | | | | | ||
| 171 | | | | | | ||
| 172 | | | | | | ||
| 173 | |(% rowspan="10" %)[[image:zum d.png]]|**Zūm Wired D-Type**|(% colspan="4" %)**Button Functions** | ||
| 174 | |(% rowspan="4" %)4-Button On/Off, Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
| 175 | |1|On|Area On|n/a | ||
| 176 | |2|▲|n/a|Area Raise | ||
| 177 | |3|▼|n/a|Area Lower | ||
| 178 | |**Supported Features**|4|Off|Area Off|n/a | ||
| 179 | |(% rowspan="4" %)DirectLoadIds (1 load) | ||
| 180 | DisableOff| | | | | ||
| 181 | | | | | | ||
| 182 | | | | | | ||
| 183 | | | | | | ||
| 184 | |(% rowspan="10" %)[[image:zum e.png]]|**Zūm Wired E-Type**|(% colspan="4" %)**Button Functions** | ||
| 185 | |(% rowspan="4" %)4-Button On/Off/Scene keypad|**Button**|**Label**|(% colspan="2" %)**Press** | ||
| 186 | |1|On|(% colspan="2" %)Area On | ||
| 187 | |2|Scene 2|(% colspan="2" %)Recall Scene 2 | ||
| 188 | |3|Scene 3|(% colspan="2" %)Recall Scene 3 | ||
| 189 | |**Supported Features**|4|Off|(% colspan="2" %)Area Off | ||
| 190 | |(% rowspan="4" %)DisableOff| | | | | ||
| 191 | | | | | | ||
| 192 | | | | | | ||
| 193 | | | | | | ||
| 194 | |(% rowspan="10" %)[[image:zum f.png]]|**Zūm Wired F-Type**|(% colspan="2" %)**Button Functions**| | | ||
| 195 | |(% rowspan="4" %)6-Button On/Off/Scene/Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
| 196 | |1|On|Area On|n/a | ||
| 197 | |2|Scene 2|Recall Scene 2|n/a | ||
| 198 | |3|Scene 3|Recall Scene 3|n/a | ||
| 199 | |**Supported Features**|4|Off|Area Off|n/a | ||
| 200 | |(% rowspan="4" %)DirectLoadIds | ||
| 201 | DisableOff | ||
| 202 | FlipRaiseLower|5|▲|n/a|Area Raise | ||
| 203 | |6|▼|n/a|Area Lower | ||
| 204 | | | | | | ||
| 205 | | | | | | ||
| 206 | |(% rowspan="10" %)[[image:zum g.png]]|**Zūm Wired G-Type**|(% colspan="4" %)**Button Functions** | ||
| 207 | |(% rowspan="4" %)4-Button Toggle Load by Type, Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
| 208 | |1|Dimming On/Off|Toggle dimmable loads on/off|n/a | ||
| 209 | |2|▲|n/a|Area Raise | ||
| 210 | |3|▼|n/a|Area Lower | ||
| 211 | |**Supported Features**|4|Switching On/Off|Toggle switched loads on/off|n/a | ||
| 212 | |(% rowspan="4" %)n/a| | | | | ||
| 213 | | | | | | ||
| 214 | | | | | | ||
| 215 | | | | | | ||
| 216 | |(% rowspan="10" %)[[image:zum n.png]]|**Zūm Wired N-Type**|(% colspan="4" %)**Button Functions** | ||
| 217 | |(% rowspan="4" %)6-Button Area/Load Toggle, Area Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
| 218 | |1|On/Off|Toggle Area On/Off|n/a | ||
| 219 | |2|Zone 1|Load 1 On|Load 1 Off | ||
| 220 | |3|Zone 2|Load 2 On|Load 2 Off | ||
| 221 | |**Supported Features**|4|Zone 3|Load 3 On|Load 3 Off | ||
| 222 | |(% rowspan="4" %)DirectLoadIds (3 loads) | ||
| 223 | DisableOff (v3.002 or later) | ||
| 224 | FlipRaiseLower (v2.210 or later)|5|▲|n/a|Area Raise | ||
| 225 | |6|▼|n/a|Area Lower | ||
| 226 | | | | | | ||
| 227 | | | | | | ||
| 228 | |(% rowspan="10" %)[[image:zum noff.png]]|**Zūm Wired NOFF-Type**|(% colspan="4" %)**Button Functions** | ||
| 229 | |(% rowspan="4" %)6-Button Load Toggle, Area On/Off/Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
| 230 | |1|On|Area On|n/a | ||
| 231 | |2|Zone 1|Load 1 On|Load 1 Off | ||
| 232 | |3|Zone 2|Load 2 On|Load 2 Off | ||
| 233 | |**Supported Features**|4|Off|Area Off|n/a | ||
| 234 | |(% rowspan="4" %)DirectLoadIds (2 loads) | ||
| 235 | DisableOff (v2.210 or later) | ||
| 236 | FlipRaiseLower (v2.210 or later)|5|▲|n/a|Area Raise | ||
| 237 | |6|▼|n/a|Area Lower | ||
| 238 | | | | | | ||
| 239 | | | | | | ||
| 240 | |(% rowspan="10" %)[[image:zum ovr.png]]|**Zūm Wired OVR-Type**|(% colspan="4" %)**Button Functions** | ||
| 241 | |(% rowspan="4" %)2-Button, area override keypad|**Button**|**Label**|(% colspan="2" %)**Press** | ||
| 242 | |1|OVR On|(% colspan="2" %)Enable Area Override | ||
| 243 | |2|OVR Off|(% colspan="2" %)Disable Area Override | ||
| 244 | | | | | | ||
| 245 | |**Supported Features**| | | | | ||
| 246 | |(% rowspan="4" %)ControllerIds | ||
| 247 | DisableOff (v2.210 or later)| | | | | ||
| 248 | | | | | | ||
| 249 | | | | | | ||
| 250 | | | | | | ||
| 251 | |(% rowspan="10" %)[[image:zum w.png]]|**Zūm Wired W-Type**|(% colspan="4" %)**Button Functions** | ||
| 252 | |(% rowspan="4" %)4-Button Last Level/Off/Raise/Lower keypad|**Button**|**Label**|**Press**|**Hold** | ||
| 253 | |1|On|Recall Last Levels|n/a | ||
| 254 | |2|Off|Area Off|n/a | ||
| 255 | |3|▲|n/a|Area Raise | ||
| 256 | |**Supported Features**|4|▼|n/a|Area Lower | ||
| 257 | |(% rowspan="4" %)DirectLoadIds (1 load) | ||
| 258 | DisableOff | ||
| 259 | FlipRaiseLower| | | | | ||
| 260 | | | | | | ||
| 261 | | | | | | ||
| 262 | | | | | | ||
| 263 | |||
| 264 | = Zūm Wireless Keypads = | ||
| 265 | |||
| 266 | 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. | ||
| 267 | |||
| 268 | |(% rowspan="10" %)[[image:zumwl a.png]]|**Zūm Wireless A-Type **|(% colspan="4" %)**Button Functions** | ||
| 269 | |(% rowspan="4" %)2-Button, area On/Off keypad with hold to Raise/Lower|**Button**|**Label**|**Press**|**Hold** | ||
| 270 | |1|On|Area On|Area Raise | ||
| 271 | |2|Off|Area Off|Area Lower | ||
| 272 | | | | | | ||
| 273 | |**Supported Features**| | | | | ||
| 274 | |(% rowspan="4" %)n/a| | | | | ||
| 275 | | | | | | ||
| 276 | | | | | | ||
| 277 | | | | | | ||
| 278 | |(% rowspan="10" %)[[image:zumwl b.png]]|**Zūm Wireless B-Type**|(% colspan="4" %)**Button Functions** | ||
| 279 | |(% rowspan="4" %)4-Button area On/Off/Scene keypad|**Button**|**Label**|**Press**|**Hold** | ||
| 280 | |1|On|Area On|Area Raise | ||
| 281 | |2|Scene 2|Recall Scene 2|Save Scene 2 | ||
| 282 | |3|Scene 3|Recall Scene 3|Save Scene 3 | ||
| 283 | |**Supported Features**|4|Off|Area Off|Area Lower | ||
| 284 | |(% rowspan="4" %)n/a| | | | | ||
| 285 | | | | | | ||
| 286 | | | | | | ||
| 287 | | | | | | ||
| 288 | |(% rowspan="10" %)[[image:zumwl c.png]]|**Zūm Wireless C-Type**|(% colspan="4" %)**Button Functions** | ||
| 289 | |(% rowspan="4" %)6-Button area On/Off/Scene keypad with Raise/Lower|**Button**|**Label**|**Press**|**Hold** | ||
| 290 | |1|On|Area On|n/a | ||
| 291 | |2|Scene 2|Recall Scene 2|Save Scene 2 | ||
| 292 | |3|Scene 3|Recall Scene 3|Save Scene 3 | ||
| 293 | |**Supported Features**|4|Off|Area Off|n/a | ||
| 294 | |(% rowspan="4" %)n/a|5|▲|n/a|Area Raise | ||
| 295 | |6|▼|n/a|Area Lower | ||
| 296 | | | | | | ||
| 297 | | | | | | ||
| 298 | |(% rowspan="10" %)[[image:zumwl d.png]]|**Zūm Wireless D-Type**|(% colspan="4" %)**Button Functions** | ||
| 299 | |(% rowspan="4" %)6-Button area On/Off/Scene keypad with Raise/Lower and Sensor Disable|**Button**|**Label**|**Press**|**Hold** | ||
| 300 | |1|On|Area On|n/a | ||
| 301 | |2|Scene 2|Recall Scene 2|Save Scene 2 | ||
| 302 | |3|Sensor Disable|Disable Occupancy|Enable Occupancy | ||
| 303 | |**Supported Features**|4|Off|Area Off|n/a | ||
| 304 | |(% rowspan="4" %)n/a|5|▲|n/a|Area Raise | ||
| 305 | |6|▼|n/a|Area Lower | ||
| 306 | | | | | | ||
| 307 | | | | | | ||
| 308 | |||
| 309 | = X-Type Keypads = | ||
| 310 | |||
| 311 | The showrunner™ X-Type keypad is a customizable keypad type available for Cameo, Horizon, GLPPA-KP, and Zūm Wired keypads. | ||
| 312 | |||
| 313 | 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]]. | ||
| 314 | ))) |