Skip to Content

Wiki source code of Keypad Configuration

Version 40.6 by Alexander Mott on 2023/02/08 20:19
Show last authors
1 {{box cssClass="floatinginfobox" title="**CONTENTS**"}}
2 {{toc/}}
3 {{/box}}
4
5 (% class="row" %)
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:
8
9 * [[Cameo Keypads>>SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome||anchor="HCameoKeypads"]]
10 * [[Horizon Keypads>>SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome||anchor="HHorizonKeypads"]]
11 * [[GLPPA-KP Keypads>>SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome||anchor="HGLPPA-KPKeypads"]]
12 * [[Zūm Wired Keypads>>SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome||anchor="HZūmWiredKeypads"]]
13 * [[Zūm Wireless Keypads>>SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome||anchor="HZūmWirelessKeypads"]]
14
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
18 (% class="row" %)
19 (((
20 = Keypad Configuration Options =
21
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
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.
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.
27
28 == XPanel ==
29
30 Standard sh
31
32 == showrunnerHUB™ ==
33
34 The showrunnerHUB™ Web Interface can be used to configure both To configure keypads using the showrunnerHUB™ UI:
35
36 * Log in to the web interface
37 * Click the "Setup" gear icon from the top right of the screen to navigate to the setup menu
38 * Click "Keypad Configuration" from the list on the left to bring up a list of keypads defined in the configuration
39 * Select the desired keypad from the list of keypads
40 * Edit the keypad name, contractor label, area assignment, and type as desired.
41 ** 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]]
42
43 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.
44
45 The next section contains 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##
46
47 Note that actions with "None" listed under "Triggers" are read-only and are only able to be used for keypad or keyswitch feedback.
48
49 = Custom (X-Type) Keypad Configuration =
50
51 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.
52
53 == ==
54
55 == X-Type Templates ==
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]].
58
59 {{display excludeFirstHeading="false" reference="SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome" section="HX-TypeActionsTable"/}}
60 )))