Skip to Content

Changes for page Keypad Configuration

Last modified by Alexander Mott on 2024/05/31 19:33
From version 40.8
edited by Alexander Mott
on 2023/02/08 20:59
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
... ... @@ -80,8 +80,52 @@
80 80  
81 81  == X-Type Templates ==
82 82  
83 -X-Type templates are a powerful tool available in showrunner™ that enable
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.
84 84  
85 +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.
86 +
87 +To create an X-Type template using the showrunnerHUB™ UI:
88 +
89 +* Log in to the web interface
90 +* Click the "Setup" gear icon from the top right of the screen to navigate to the setup menu
91 +* Click "Keypad Configuration" from the list on the left to bring up a list of keypads defined in the configuration
92 +* Select the first keypad that will be assigned a template
93 +* Change the Keypad Type to "X-Type"
94 +* Click the gear icon next to the "Keypad Template" field
95 +* Click "ADD" underneath the "Keypad Templates" heading and name the template
96 +* Once the template has been created, customize it as necessary
97 +** Use the Model field to create custom templates for C2N-CBD, HZ-KPCN, GLPPA-KP, or other types of keypads
98 +** Use the Style Picker button to select the desired button layout
99 +** Once the Model and Style are selected, click the Edit Actions button to define the template's actions
100 +*** The Template Actions menu uses the same workflow as the X-Type Actions configuration menu 
101 +**** Select a button
102 +**** Give the button a descriptive label
103 +**** Choose the required Button Model
104 +**** Add actions for each interaction type on the button (Press, Tap, Double-Tap, Hold, or Release)
105 +**** When adding an action to a button, you will be prompted to assign a number to the object.
106 +***** This number is known as the Host Global ID
107 +***** The Host Global ID is shown in the "[object] #" field. The name for this field updates depending on the type of object being targeted by the action (e.g. it will become "Load #" if the action is targeting loads)
108 +***** Do not repeat Host Global IDs within a template unless you intend for multiple buttons to target the same object
109 +****** E.g., if one button acts on an Area and another button acts on a Load, do not use "Area #: 1" and "Load #: 1" - instead, use "Area #:1" and "Load #: 2"
110 +*** Once all the actions for all the buttons have been configured, exit back to the main Keypad Configuration menu
111 +* To assign the template to a keypad, click the Keypad Template field and select the desired template
112 +* Once a template is selected, click the map icon that appears next to the gear icon to open the Template Global Map menu
113 +* Use the Template Global Map menu to assign specific objects to each custom keypad
114 +** The Type column indicates what type of object the template is expecting
115 +*** By default, Host Global IDs are mapped to whatever object has a matching Global ID. These objects may or may note be the correct type of object for the template (e.g., a Host Global ID of 1 usually corresponds to a LoadController object)
116 +** Use the Object column to select the specific object to be mapped for this keypad
117 +* Once the first keypad has been assigned the template and remapped:
118 +** Select the next keypad to be edited
119 +** Change the Keypad Type to "X-Type"
120 +** Select the custom template
121 +** Remap the Host Global IDs
122 +** Repeat for all keypads using the custom template
123 +* Miscellaneous tips for configuring keypad templates:
124 +** Templates should be configured with the maximum number of loads/areas/etc. that any keypad will require, as excess generic objects can be skipped when mapping the template to specific keypads
125 +*** E.g., if some keypads will have a button toggle 5 loads while others will have the same button toggle 7 loads, then the template should be defined to have 7 loads. Keypads which make use of all 7 loads will have all loads mapped, while the keypads that only require 5 loads should be mapped with "[Skip this Entry]" for the two extra loads
126 +** In certain situations, keypad templates can be used even if the actual keypad layout does not match the template
127 +*** 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
128 +
85 85  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##
86 86  
87 87  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.