Skip to Content

Changes for page Keypad Configuration

Last modified by Alexander Mott on 2024/05/31 19:33
From version 40.7
edited by Alexander Mott
on 2023/02/08 20:24
Change comment: (Autosaved)
To version 40.8
edited by Alexander Mott
on 2023/02/08 20:59
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -4,7 +4,7 @@
4 4  
5 5  (% class="row" %)
6 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 page>>SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome]] page lists all the available built-in keypad types for the most common keypad models:
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:
8 8  
9 9  * [[Cameo Keypads>>SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome||anchor="HCameoKeypads"]]
10 10  * [[Horizon Keypads>>SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome||anchor="HHorizonKeypads"]]
... ... @@ -21,18 +21,38 @@
21 21  
22 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.
23 23  
24 -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.
24 +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.
25 25  
26 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.
27 27  
28 28  == XPanel ==
29 29  
30 -Standard sh
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.
31 31  
32 +To configure keypads using the XPanel or touchscreen:
33 +
34 +* Enter the technician PIN code if required
35 +* Tap the "Settings" gear icon in the top right of the screen
36 +* Tap the "Keypad Configuration" button
37 +* Select the desired keypad from the list of keypads on the left
38 +* Edit the keypad attributes as desired
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
41 +** The Area Assignment determines what areas and loads are controlled by standard type keypads
42 +** The Area Assignment also determines whether a scheduled event will change the keypad's behavior
43 +*** 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
44 +*** 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
45 +** The Keypad Type determines the keypad functionality
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
49 +
32 32  == showrunnerHUB™ ==
33 33  
34 -The showrunnerHUB™ Web Interface can be used to configure both standard keypads as well as custom X-Type keypads. Note that 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.
35 35  
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.
55 +
36 36  To configure keypads using the showrunnerHUB™ UI:
37 37  
38 38  * Log in to the web interface
... ... @@ -39,22 +39,32 @@
39 39  * Click the "Setup" gear icon from the top right of the screen to navigate to the setup menu
40 40  * Click "Keypad Configuration" from the list on the left to bring up a list of keypads defined in the configuration
41 41  * Select the desired keypad from the list of keypads
42 -* Edit the keypad name, contractor label, area assignment, and type as desired
43 -** 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]]
62 +* Edit the keypad attributes as desired
63 +** The Keypad Name/Keypad Label is what is displayed in the XPanel and touchscreen UI, while the Contractor Label is only visible in the configuration file or in this configuration menu
64 +** The Area Assignment determines what areas and loads are controlled by standard type keypads
65 +** The Area Assignment also determines whether a scheduled event will change the keypad's behavior
66 +*** 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
67 +*** 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
68 +** The Keypad Type determines the keypad functionality
69 +*** See the [[SHOWRUNNER™ Keypad Types >>SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome]]page for a list of standard keypad types
70 +*** 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.
71 +*** Setting the keypad to "X-Type" brings up additional options for keypad customization and assigning custom keypad templates
72 +*** 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
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]]
44 44  
45 -The next section contains more detailed information regarding custom keypad functions.
75 +The next section contains more detailed information regarding specific custom keypad functions and X-Type templates.
46 46  
47 47  = Custom (X-Type) Keypad Configuration =
48 48  
49 49  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.
50 50  
51 -The table below contains comprehensive list of actions which can be used to manually configure X-Type keypads from the SrConfig.json file. The table was generated using showrunner™ v3.019, but can be viewed for any version of showrunner™ by connecting to a processor running the desired version of showrunner™ and running the command: ##sr sh ac##
81 +== X-Type Templates ==
52 52  
53 -Note that actions with "None" listed under "Triggers" are read-only and are only able to be used for keypad or keyswitch feedback.
83 +X-Type templates are a powerful tool available in showrunner™ that enable
54 54  
55 -== X-Type Templates ==
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##
56 56  
57 -Below is a table of possible actions for X-Type keypads (taken from the [[SHOWRUNNER™ Keypad Types page>>SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome]].
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.
58 58  
59 59  {{display excludeFirstHeading="false" reference="SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome" section="HX-TypeActionsTable"/}}
60 60  )))