Skip to Content

Changes for page Keypad Configuration

Last modified by Alexander Mott on 2024/05/31 19:33
From version 43.1
edited by Alexander Mott
on 2023/05/16 14:28
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
Content
... ... @@ -73,6 +73,24 @@
73 73  
74 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.
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 +
76 76  == X-Type Templates ==
77 77  
78 78  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.
... ... @@ -95,7 +95,7 @@
95 95  *** The Template Actions menu uses the same workflow as the X-Type Actions configuration menu 
96 96  **** Select a button
97 97  **** Give the button a descriptive label
98 -**** 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"]]
99 99  **** Add actions for each interaction type on the button (Press, Tap, Double-Tap, Hold, or Release)
100 100  **** When adding an action to a button, you will be prompted to assign a number to the object.
101 101  ***** This number is known as the Host Global ID