Skip to Content

Changes for page Keypad Configuration

Last modified by Alexander Mott on 2024/05/31 19:33
From version 42.1
edited by Scott Kohlmann
on 2023/04/21 14:04
Change comment: There is no comment for this version
To version 46.1
edited by Alexander Mott
on 2024/05/31 19:33
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.scott\.kohlmann@chiefintegrations\.com
1 +XWiki.alexander\.mott@chiefintegrations\.com
Content
... ... @@ -2,8 +2,6 @@
2 2  {{toc/}}
3 3  {{/box}}
4 4  
5 -(% class="row" %)
6 -(((
7 7  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:
8 8  
9 9  * [[Cameo Keypads>>SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome||anchor="HCameoKeypads"]]
... ... @@ -13,10 +13,7 @@
13 13  * [[Zūm Wireless Keypads>>SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome||anchor="HZūmWirelessKeypads"]]
14 14  
15 15  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 -)))
17 17  
18 -(% class="row" %)
19 -(((
20 20  = Keypad Configuration Options =
21 21  
22 22  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.
... ... @@ -78,6 +78,24 @@
78 78  
79 79  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.
80 80  
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 +
81 81  == X-Type Templates ==
82 82  
83 83  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.
... ... @@ -100,7 +100,7 @@
100 100  *** The Template Actions menu uses the same workflow as the X-Type Actions configuration menu 
101 101  **** Select a button
102 102  **** Give the button a descriptive label
103 -**** Choose the required Button Model
116 +**** Choose the required [[Button Model>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Program Configuration.Keypad Configuration.WebHome||anchor="HX-TypeButtonModels"]]
104 104  **** Add actions for each interaction type on the button (Press, Tap, Double-Tap, Hold, or Release)
105 105  **** When adding an action to a button, you will be prompted to assign a number to the object.
106 106  ***** This number is known as the Host Global ID
... ... @@ -131,4 +131,3 @@
131 131  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.
132 132  
133 133  {{display excludeFirstHeading="false" reference="SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome" section="HX-TypeActionsTable"/}}
134 -)))