Wiki source code of Keypad Configuration
Version 40.2 by Alexander Mott on 2023/02/08 19:59
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 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 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 | Using the keypad configuration menu to enable or disable keypads is only recommended for commissioning/testing purposes. If | ||
| 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. 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 | |||
| 28 | == showrunnerHUB™ == | ||
| 29 | |||
| 30 | To | ||
| 31 | |||
| 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 | |||
| 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 | |||
| 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 | |||
| 38 | Note that actions with "None" listed under "Triggers" are read-only and are only able to be used for keypad or keyswitch feedback. | ||
| 39 | |||
| 40 | == XPanel == | ||
| 41 | |||
| 42 | Standard sh | ||
| 43 | |||
| 44 | = Custom (X-Type) Keypad Configuration = | ||
| 45 | |||
| 46 | 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. | ||
| 47 | |||
| 48 | == == | ||
| 49 | |||
| 50 | == X-Type Templates == | ||
| 51 | |||
| 52 | 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]]. | ||
| 53 | |||
| 54 | {{display excludeFirstHeading="false" reference="SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome" section="HX-TypeActionsTable"/}} | ||
| 55 | ))) |