Skip to Content

Keypad Configuration

Version 40.4 by Alexander Mott on 2023/02/08 20:09
Warning: For security reasons, the document is displayed in restricted mode as it is not the current version. There may be differences and errors due to this.
CONTENTS

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 page lists all the available built-in keypad types for the most common keypad models:

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.

Keypad Configuration Options

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.

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 unless t

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.

showrunnerHUB™

To 

Downloadable instructions for configuring X-Type keypads from the showrunnerHUB™ UI are available here.

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 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

Note that actions with "None" listed under "Triggers" are read-only and are only able to be used for keypad or keyswitch feedback.

XPanel

Standard sh

Custom (X-Type) Keypad Configuration

The showrunner™ X-Type keypad is a customizable keypad type available for Cameo, Horizon, GLPPA-KP, and Zūm Wired keypads. See this document 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.

X-Type Templates

Below is a table of possible actions for X-Type keypads (taken from the SHOWRUNNER™ Keypad Types page.

Failed to execute the [display] macro. Cause: [Cannot find section [HX-TypeActionsTable] in document [xwiki:SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Keypad Types.WebHome]]. Click on this message for details.