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.3
edited by Alexander Mott
on 2023/02/08 20:04
Change comment: (Autosaved)

Summary

Details

Page properties
Content
... ... @@ -21,37 +21,32 @@
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 +Using the kypad configuration menu to enable or disable keypads is only recommended for commissioning/testing purposes. Changes to a keypad's enabled/disabled status made through the K During normal operation, keypads should be enabled and disabled using Scheduled Events. Changes to a keypad's enabled or disabled status made through the UI will st
25 25  
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.
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. When a keypad is changed into an X-Type keypad using the XPanel UI, the keypad will perform any actions that are defined in the configuration. If no actions are defined, then it will not perform any functions.
27 27  
28 -== XPanel ==
28 +== showrunnerHUB™ ==
29 29  
30 -Standard sh
30 +To
31 31  
32 -== showrunnerHUB™ ==
32 +Downloadable instructions for configuring X-Type keypads from the showrunnerHUB™ UI are available [[here>>attach:SHOWRUNNER™ Setup Guide.showrunnerHUB™.Keypad Configuration.WebHome@CI Keypad Editor UI Guide.pdf]].
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.
34 +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.
35 35  
36 -To configure keypads using the showrunnerHUB™ UI:
36 +The table below is a 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##
37 37  
38 -* Log in to the web interface
39 -* Click the "Setup" gear icon from the top right of the screen to navigate to the setup menu
40 -* Click "Keypad Configuration" from the list on the left to bring up a list of keypads defined in the configuration
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]]
38 +Note that actions with "None" listed under "Triggers" are read-only and are only able to be used for keypad or keyswitch feedback.
44 44  
45 -The next section contains more detailed information regarding custom keypad functions.
40 +== XPanel ==
46 46  
42 +Standard sh
43 +
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##
48 +== ==
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.
54 -
55 55  == X-Type Templates ==
56 56  
57 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]].