Skip to Content

Changes for page Keypad Configuration

Last modified by Alexander Mott on 2024/05/31 19:33
From version 46.1
edited by Alexander Mott
on 2024/05/31 19:33
Change comment: There is no comment for this version
To version 41.1
edited by Alexander Mott
on 2023/02/08 21:58
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -2,7 +2,9 @@
2 2  {{toc/}}
3 3  {{/box}}
4 4  
5 -The ShowRunnerCLC™ 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. The [[ShowRunner™ Keypad Types >>SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome]]page lists all the available built-in keypad types for the most common keypad models:
5 +(% class="row" %)
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. The [[SHOWRUNNER™ Keypad Types >>SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome]]page lists all the available built-in keypad types for the most common keypad models:
6 6  
7 7  * [[Cameo Keypads>>SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome||anchor="HCameoKeypads"]]
8 8  * [[Horizon Keypads>>SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome||anchor="HHorizonKeypads"]]
... ... @@ -11,18 +11,21 @@
11 11  * [[Zūm Wireless Keypads>>SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome||anchor="HZūmWirelessKeypads"]]
12 12  
13 13  It is recommended to use built-in keypad types whenever possible, as configuring custom (X-Type) keypads is a more complex and time-consuming process. If custom keypad programming is required, there are several methods of configuring custom actions detailed in subsequent sections.
16 +)))
14 14  
18 +(% class="row" %)
19 +(((
15 15  = Keypad Configuration Options =
16 16  
17 -Keypads in ShowRunnerCLC™ can be configured using either the XPanel UI or the ShowRunnerHUB™ UI. Both user interfaces allow for enabling/disabling keypads, changing the keypad area assignment, and modifying the keypad type.
22 +Keypads in showrunner™ can be configured using either the XPanel UI or the showrunnerHUB™ UI. Both user interfaces allow for enabling/disabling keypads, changing the keypad area assignment, and modifying the keypad type.
18 18  
19 19  If a keypad is manually enabled or disabled through the Keypad Configuration menu, it will stay in that enabled or disabled state until something else (e.g. a scheduled event or a global action) occurs that changes its status. For this reason, it is only recommended to enable or disable keypads through the Keypad Configuration menu for testing purposes. During normal operation, keypads should be enabled and disabled using Scheduled Events. To prevent specific keypads from being disabled by scheduled events, check the "Disallow Disable" box.
20 20  
21 -Note that while it is possible to use the XPanel UI to change a keypad from a standard keypad type to a custom X-Type keypad, defining custom functions is only possible through the ShowRunnerHUB™ UI or by editing the configuration manually. X-Type keypads will perform any actions that are defined in the configuration. If no actions are defined for the keypad, then it will not perform any functions as an X-Type keypad. This means that correctly configured X-Type keypads can be changed into standard type keypads and then changed back into X-Type keypads without any loss of the custom functionality, but that standard type keypads cannot be changed into X-Type keypads without also configuring their custom actions using the ShowRunnerHUB™ UI or manually editing the configuration file.
26 +Note that while it is possible to use the XPanel UI to change a keypad from a standard keypad type to a custom X-Type keypad, defining custom functions is only possible through the showrunnerHUB™ UI or by editing the configuration manually. X-Type keypads will perform any actions that are defined in the configuration. If no actions are defined for the keypad, then it will not perform any functions as an X-Type keypad. This means that correctly configured X-Type keypads can be changed into standard type keypads and then changed back into X-Type keypads without any loss of the custom functionality, but that standard type keypads cannot be changed into X-Type keypads without also configuring their custom actions using the showrunnerHUB™ UI or manually editing the configuration file.
22 22  
23 23  == XPanel ==
24 24  
25 -The XPanel and touchscreen user interfaces can be used to configure standard keypad types. Custom keypad actions cannot be configured using the XPanel UI, and must be either manually added to the config file or configured using the ShowRunnerHUB™ UI.
30 +The XPanel and touchscreen user interfaces can be used to configure standard keypad types. Custom keypad actions cannot be configured using the XPanel UI, and must be either manually added to the config file or configured using the showrunnerHUB™ UI.
26 26  
27 27  To configure keypads using the XPanel or touchscreen:
28 28  
... ... @@ -31,24 +31,24 @@
31 31  * Tap the "Keypad Configuration" button
32 32  * Select the desired keypad from the list of keypads on the left
33 33  * Edit the keypad attributes as desired
34 -** The Keypad Label can be edited from this menu
35 -*** The Contractor Label still exists, but can only be edited through the ShowRunnerHUB™ UI or by manually editing the configuration file
39 +** The Keypad Label can be edited from this menu.
40 +*** The Contractor Label still exists, but can only be edited through the showrunnerHUB™ UI or by manually editing the configuration file
36 36  ** The Area Assignment determines what areas and loads are controlled by standard type keypads
37 37  ** The Area Assignment also determines whether a scheduled event will change the keypad's behavior
38 38  *** The Ignore Disable checkbox allows excluding individual keypads from being disabled by scheduled events. Useful in situations where there are multiple keypads assigned to the same area, but only some of them need to be disabled during specific times of day
39 39  *** The Disable Off checkbox allows for using standard keypads with "Area Off" functionality (e.g. F-Type keypads) in front-of-house or otherwise public areas without fear of the lights being turned off by accident
40 40  ** The Keypad Type determines the keypad functionality
41 -*** See the [[ShowRunner™ Keypad Types >>SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome]]page for a list of standard keypad types
42 -*** Some Keypad Types support direct loads (i.e. performing load-level actions rather than area-level actions), but they can only be edited through the ShowRunnerHUB™ UI or by manually editing the configuration file
43 -*** Setting a keypad to "X-Type" allows the keypad to perform any previously configured custom actions, but these actions can only be configured through the ShowRunnerHUB™ UI or by manually editing the configuration file
46 +*** See the [[SHOWRUNNER™ Keypad Types >>SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome]]page for a list of standard keypad types
47 +*** Some Keypad Types support direct loads (i.e. performing load-level actions rather than area-level actions), but they can only be edited through the showrunnerHUB™ UI or by manually editing the configuration file
48 +*** Setting a keypad to "X-Type" allows the keypad to perform any previously configured custom actions, but these actions can only be configured through the showrunnerHUB™ UI or by manually editing the configuration file
44 44  
45 -== ShowRunnerHUB™ ==
50 +== showrunnerHUB™ ==
46 46  
47 -The ShowRunnerHUB™ Web Interface can be used to configure both standard keypads as well as custom X-Type keypads. If an X-Type keypad was configured manually by editing the configuration file, then it might be missing some information that is required for the showrunnerHUB™ UI to be able to view and edit the keypad correctly. In these cases it is recommended to either continue editing the keypad manually using the configuration, or re-do the keypad customization with the showrunnerHUB™ UI in order to ensure that all the required information is generated.
52 +The showrunnerHUB™ Web Interface can be used to configure both standard keypads as well as custom X-Type keypads. If an X-Type keypad was configured manually by editing the configuration file, then it might be missing some information that is required for the showrunnerHUB™ UI to be able to view and edit the keypad correctly. In these cases it is recommended to either continue editing the keypad manually using the configuration, or re-do the keypad customization with the showrunnerHUB™ UI in order to ensure that all the required information is generated.
48 48  
49 -Note that the ShowRunnerHUB™ UI performance on 3-Series processors can be slow, and it can require quite a bit of time for all the keypads, areas, loads, etc. to populate. If configuring a large number of keypads using the ShowRunnerHUB™ UI, it is recommended to load the configuration to a 4-Series processor running the same version of ShowRunnerCLC™ to make changes and then save/load that configuration to the 3-Series processor whenever possible.
54 +Note that the showrunnerHUB™ UI performance on 3-Series processors can be slow, and it can require quite a bit of time for all the keypads, areas, loads, etc. to populate. If configuring a large number of keypads using the showrunnerHUB™ UI, it is recommended to load the configuration to a 4-Series processor running the same version of showrunner™ to make changes and then save/load that configuration to the 3-Series processor whenever possible.
50 50  
51 -To configure keypads using the ShowRunnerHUB™ UI:
56 +To configure keypads using the showrunnerHUB™ UI:
52 52  
53 53  * Log in to the web interface
54 54  * Click the "Setup" gear icon from the top right of the screen to navigate to the setup menu
... ... @@ -61,43 +61,25 @@
61 61  *** The Ignore Disable checkbox allows excluding individual keypads from being disabled by scheduled events. Useful in situations where there are multiple keypads assigned to the same area, but only some of them need to be disabled during specific times of day
62 62  *** The Disable Off checkbox allows for using standard keypads with "Area Off" functionality (e.g. F-Type keypads) in front-of-house or otherwise public areas without fear of the lights being turned off by accident
63 63  ** The Keypad Type determines the keypad functionality
64 -*** See the [[ShowRunnerCLC™ Keypad Types >>SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome]]page for a list of standard keypad types
69 +*** See the [[SHOWRUNNER™ Keypad Types >>SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome]]page for a list of standard keypad types
65 65  *** Some Keypad Types support direct loads (i.e. performing load-level actions rather than area-level actions). Note that direct loads require saving the configuration and performing a progreset before they take effect.
66 66  *** Setting the keypad to "X-Type" brings up additional options for keypad customization and assigning custom keypad templates
67 67  *** Keypad logic can be verified by toggling on the "Simulate" function, selecting a type of interaction (Press, Tap, Double-Tap, or Hold), and then clicking on the buttons you wish to simulate
68 -** Detailed instructions on using the Keypad Configuration menu in the ShowRunnerHUB™ UI are available [[here>>attach:SHOWRUNNER™ Setup Guide.showrunnerHUB™.Keypad Configuration.WebHome@CI Keypad Editor UI Guide.pdf]]
73 +** Detailed instructions on using the Keypad Configuration menu in the showrunnerHUB™ UI are available [[here>>attach:SHOWRUNNER™ Setup Guide.showrunnerHUB™.Keypad Configuration.WebHome@CI Keypad Editor UI Guide.pdf]]
69 69  
70 70  The next section contains more detailed information regarding specific custom keypad functions and X-Type templates.
71 71  
72 72  = Custom (X-Type) Keypad Configuration =
73 73  
74 -The ShowRunnerCLC™ X-Type keypad is a customizable keypad type available for Cameo, Horizon, GLPPA-KP, and Zūm Wired keypads. See[[ this document>>attach:SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome@showrunnerKeypadStyles.pdf]] for a list of possible keypad layouts for all keypad types. It is recommended to customize keypads using the ShowRunnerHUB™ UI whenever possible, as keypads which have been manually customized in the configuration will be missing certain attributes that are required to allow them to be subsequently editable from the ShowRunnerHUB™ UI.
79 +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:SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome@showrunnerKeypadStyles.pdf]] for a list of possible keypad layouts for all keypad types. It is recommended to customize keypads using the showrunnerHUB™ UI whenever possible, as keypads which have been manually customized in the configuration will be missing certain attributes that are required to allow them to be subsequently editable from the showrunnerHUB™ UI.
75 75  
76 -== X-Type Button Models ==
77 -
78 -(% class="box warningmessage" %)
79 -(((
80 -When configuring a button to perform Raise, Lower, or RaiseLower actions, you must also configure a Stop action to trigger on Release. This requires either a Press/Hold/Release or Tap/Hold/Release Button Model to be selected: if no action is to be triggered by a simple button press, then either Button Model is suitable. If an action is to be triggered on button press, you must select either a Press/Hold/Release or Tap/Hold/Release depending on whether you want the press action to trigger every time the button is pressed (Press) or only trigger when the button is not subsequently held (Tap)
81 -)))
82 -
83 -When configuring X-Type keypads through the ShowRunnerHUB™ UI, there are several "Button Models" available to describe what types of button interactions will have actions assigned to them. There are four main types of button interaction (Press, Tap, Double-Tap, and Hold) plus Release, and Button Models are available for a number of different interaction combinations. The table below describes each of the button interaction types and when they are triggered:
84 -
85 -(% class="table-condensed" %)
86 -|(% style="width:246px" %)**Interaction Type**|(% style="width:1244px" %)**Behavior**
87 -|(% style="width:246px" %)Press|(% style="width:1244px" %)Always executes immediately upon button press detected
88 -|(% style="width:246px" %)Tap|(% style="width:1244px" %)Delayed execution after a button press is detected unless a Double-Tap or Hold is detected
89 -|(% style="width:246px" %)Double-Tap|(% style="width:1244px" %)Delayed execution after a second button press is detected within the ##"DoubleTapTime"## specified in the configuration
90 -|(% style="width:246px" %)Hold|(% style="width:1244px" %)Delayed execution after a button is pressed and held longer than the ##"HoldTime"## specified in the configuration
91 -|(% style="width:246px" %)Release|(% style="width:1244px" %)Always executed
92 -|(% colspan="2" style="width:219px" %)**Note:** ##"HoldTime"## and ##"DoubleTapTime"## properties are set per-keypad in the ShowRunnerCLC™ configuration and dictate the delay between button press detection and action execution. Valid range is 0.1 to 1.0s, default is 0.5s
93 -
94 94  == X-Type Templates ==
95 95  
96 -X-Type templates are a powerful tool available in ShowRunnerCLC™ that enable a technician to streamline configuring custom keypads on larger jobs. X-Type templates are similar to custom "standard" type keypads: once a custom template is created, it can be assigned to many different keypads and used to perform the same set of actions on different areas by simply re-mapping the template for each keypad.
83 +X-Type templates are a powerful tool available in showrunner™ that enable a technician to streamline configuring custom keypads on larger jobs. X-Type templates are similar to custom "standard" type keypads: once a custom template is created, it can be assigned to many different keypads and used to perform the same set of actions on different areas by simply re-mapping the template for each keypad.
97 97  
98 98  Setting up custom keypads can be time consuming, as every action for every button for every keypad must be individually configured. If the types of functions (e.g. recall scene, toggle load 1, toggle load 2) are repeated across multiple keypads and the only thing that changes between them is the specific loads or areas being affected, then it is worthwhile to set up a template. Templates essentially allow a technician to configure a custom keypad one time, and then easily repeat it for multiple different keypads. When a keypad template is assigned to a keypad, all that is required is that the template be remapped so that it knows which areas, loads, etc. it is targeting for each keypad.
99 99  
100 -To create an X-Type template using the ShowRunnerHUB™ UI:
87 +To create an X-Type template using the showrunnerHUB™ UI:
101 101  
102 102  * Log in to the web interface
103 103  * Click the "Setup" gear icon from the top right of the screen to navigate to the setup menu
... ... @@ -113,7 +113,7 @@
113 113  *** The Template Actions menu uses the same workflow as the X-Type Actions configuration menu 
114 114  **** Select a button
115 115  **** Give the button a descriptive label
116 -**** Choose the required [[Button Model>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Program Configuration.Keypad Configuration.WebHome||anchor="HX-TypeButtonModels"]]
103 +**** Choose the required Button Model
117 117  **** Add actions for each interaction type on the button (Press, Tap, Double-Tap, Hold, or Release)
118 118  **** When adding an action to a button, you will be prompted to assign a number to the object.
119 119  ***** This number is known as the Host Global ID
... ... @@ -139,8 +139,9 @@
139 139  ** In certain situations, keypad templates can be used even if the actual keypad layout does not match the template
140 140  *** For example, a custom 4-button GLPPA-KP template can be used on a 2-button rocker GLPPA-KP as long as buttons 1 and 4 in the template do what is required. The extra functions assigned to buttons 2 and 3 do not matter because they can be skipped when mapping the template and the physical buttons cannot be pressed due to the rocker button cap
141 141  
142 -The table below contains a comprehensive list of possible actions for X-Type keypads (taken from the [[ShowRunnerCLC™ Keypad Types page>>SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome]]). The table was generated using ShowRunnerCLC™ version 3.019, but can be viewed for any version of ShowRunnerCLC™ by connecting to a processor running the desired version of ShowRunnerCLC™ and executing the command: ##sr sh ac##
129 +The table below contains a comprehensive list of possible actions for X-Type keypads (taken from the [[SHOWRUNNER™ Keypad Types page>>SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome]]). The table was generated using showrunner™ version 3.019, but can be viewed for any version of showrunner™ by connecting to a processor running the desired version of showrunner™ and executing the command: ##sr sh ac##
143 143  
144 144  Note that actions with "None" listed under "Triggers" are read-only and are only able to be used for keypad or keyswitch feedback, not for performing actions.
145 145  
146 146  {{display excludeFirstHeading="false" reference="SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome" section="HX-TypeActionsTable"/}}
134 +)))