Skip to Content

Changes for page Processor Setup

Last modified by Alexander Mott on 2026/03/04 22:06
From version 58.1
edited by Alexander Mott
on 2026/03/04 20:02
Change comment: There is no comment for this version
To version 32.1
edited by Alexander Mott
on 2022/09/16 21:01
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,29 +1,29 @@
1 -{{info}}
1 +(% class="box errormessage" %)
2 +(((
2 2  This page is for typical processor setup; for ZUM-HUB4 deployments, see our [[dedicated ZUM-HUB4 page>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.ZUM-HUB4 Processor Setup.WebHome]].
3 -{{/info}}
4 +)))
4 4  
5 -{{error}}
6 -All 4-Series processors require authentication to be configured when first connecting: **the Crestron Agent or Field Tech are responsible for recording these credentials. Chief Integrations cannot provide assistance unless the credentials are known. The only way to connect to a device for which the credentials have been lost is to factory reset the device, which may require redoing the start-up from scratch if the latest configuration was not saved and backed up. **
7 -{{/error}}
6 +(% class="box warningmessage" %)
7 +(((
8 +SHOWRUNNER™ is tested against current Crestron firmware releases. **Please use at least the recommended firmware builds.**
8 8  
9 -{{warning}}
10 -ShowRunnerCLC™™ is tested against current Crestron firmware releases. **Please use at least the recommended firmware builds.**
10 +* 3-Series: PUF 1.8001.0146
11 +* 4-Series: PUF 2.7000.00052.01
12 +* VC-4: 2.7000.00047
11 11  
12 -* 3-Series: PUF 1.8001.0214
13 -* 4-Series: PUF 2.8003.00037.01
14 -* VC-4: 4.0003.00016
15 -
16 16  **Notes:**
17 17  
18 18  * Static IP or properly setup DHCP/DNS implementation required.
19 19  * Auto-Assigned/Link-Local IP address range of 169.254.x.x not supported (Crestron xPanel issue)
20 -{{/warning}}
18 +)))
21 21  
22 -{{box cssClass="floatinginfobox" title="**CONTENTS**"}}
20 +{{box title="**Contents**"}}
23 23  {{toc/}}
24 24  {{/box}}
25 25  
26 -**ShowRunnerCLC™ Installation Tutorial:**
24 +(% class="row" %)
25 +(((
26 +**ShowRunner Installation Tutorial:**
27 27  
28 28  [[https:~~/~~/www.youtube.com/watch?v=xuJ94cMCCa8>>url:https://www.youtube.com/watch?v=xuJ94cMCCa8]]
29 29  
... ... @@ -33,20 +33,6 @@
33 33  
34 34  [[https:~~/~~/www.youtube.com/watch?v=H8CLZ7bp0eI>>url:https://www.youtube.com/watch?v=H8CLZ7bp0eI]]
35 35  
36 -= Error Broadcasting =
37 -
38 -The first thing that should be done after connecting to a processor is to open the Text Console and run the command: ##broadcast on##
39 -
40 -Running the ##broadcast on## command tells the processor to begin logging useful messages to the text console and error log. These messages typically begin with an indication of their severity:
41 -
42 -1. Error: Most errors indicate a major issue that should be investigated and remedied. Some errors will prevent the ShowRunner™ program from starting up or functioning as expected, and may be the result of a configuration issue (e.g. errors registering devices), a network issue (e.g. errors connecting to other devices), or authentication issues (e.g. errors related to connection attempts from clients not providing correct username/password information), among other possible causes.
43 -1. Warning: Warnings indicate issues that are less severe than errors and do not usually prevent the ShowRunner™ program from running, but may result in some unexpected behaviors.
44 -1. Notice: Notices are not a problem, and just give useful information during program startup (e.g. devices registered) and while the program is running (e.g. the times at which scheduled events are triggered)
45 -
46 -Running the ##err sys## command will print the most recent 500 messages to the console. Running the ##clear err## command will clear the log, which is sometimes useful to run  before doing a ##progreset## in order to troubleshoot configuration issues on startup.
47 -
48 -To view more than the last 500 messages, connect to the processor with the File Manager tool and navigate to the "Internal Storage > logs" folder. Logs since the last time the processor rebooted are stored in the "CurrentBoot" folder, with a new log started every time the current log reaches ~~1 MB in size. When the processor reboots, the logs in the "PreviousBoot" folder are zipped and moved to the "ZippedLogs" folder, logs in the "CurrentBoot" folder are moved to the "PreviousBoot" folder, and a new log is started in the "CurrentBoot" folder.
49 -
50 50  = IP Configuration =
51 51  
52 52  * Connect to the processor via USB and set the processor’s IP Address per your network requirements
... ... @@ -68,23 +68,12 @@
68 68  *** Configure your DHCP server software to assign IP addresses in the desired range
69 69  *** Once the processor is assigned an IP address, connect to it via Text Console at the assigned IP address
70 70  *** Run the above commands to disable DHCP and assign a static IP address to the processor
71 -* For processors with a Control Subnet (CP3N/AV3/PRO3/CP4N/AV4/PRO4), there are some additional considerations and setup that must be performed: 
72 -** **Never **connect an external router to the Control Subnet, as doing so will cause the internal DHCP server to shut down.
73 -** **Never **set the LAN IP address to an address that is in the range of the Control Subnet
74 -*** e.g. for a processor with the default 172.22.0.0/20 Control Subnet configuration, the LAN IP address must be below 172.22.0.0 or above 172.22.15.255
75 -** **Always** set devices on the Control Subnet to DHCP so that their IP addresses are managed by the built-in DHCP server. Only set static IP addresses on the Control Subnet if you really know what you are doing.
76 -*** If setting static IP addresses on the Control Subnet for any reason: **always** assign an address within the Control Subnet range, but **never** use the first two or the last address in the range
77 -*** e.g. for a processor with the default 172.22.0.0/20 Control Subnet configuration, IP addresses must be in the range 172.22.0.3 through 172.22.15.254
78 -**** 172.22.0.0 is not a valid address, 172.22.0.1 is taken by the processor, 172.22.0.2 is taken by the DHCP server (default gateway), and 172.22.15.255 is the broadcast address for the Control Subnet
57 +* For processors with a Control Subnet (CP3N/AV3/PRO3/CP4N/AV4/PRO4/ZUM-HUB4), additional setup is required
79 79  ** Connect to the processor via Text Console and run the command: ##startprogafterrouter on##
80 -*** This will force the processor to wait until the router has started before attempting to load the ShowRunnerCLC™ program, avoiding potential license validation issues if the processor boots up before the router.
81 -*** ShowRunnerCLC™ .puf versions 3.042 and newer automatically run this command when the "Configure Processor with Router" option is selected.
59 +*** This will force the processor to wait until the router has started before attempting to load the showrunner™ program, avoiding potential license validation issues if the processor boots up before the router.
82 82  ** The previously listed "ipa," "ipm," etc. commands will configure settings for the processor's LAN port, which should be connected to the building LAN or third party network.
83 -** Lighting control hardware (e.g. TSWs, DIN-CENCN-2s, etc.) should be left in DHCP mode and connected to the Control Subnet port.
84 -*** The processor acts as a DHCP server on the Control Subnet, with addresses that are determined automatically based on the LAN configuration.
85 -*** If lighting hardware is to be connected via the LAN anyway, then you must run the command: ##securegateway default##
86 -*** Note: this setting enables unsecure connections to the processor from the LAN. This is necessary if ZUMNET-JBOXs or other non-secure Crestron devices (such as 3-Series EISC) will be connected via the LAN port of the processor
87 -** The Control Subnet will automatically configure itself based on the LAN configuration, but it should be configured manually if the processor is to be connected to building LAN as the default scheme may cause networking issues:
61 +** Lighting control hardware (e.g. TSWs, DIN-CENCN-2s, etc.) should be connected to the Control Subnet port. The processor acts as a DHCP server on the Control Subnet, with addresses that are determined automatically based on the LAN configuration.
62 +** The Control Subnet will automatically configure itself based on the LAN configuration, but it can optionally be configured manually:
88 88  *** Using the "Functions>Ethernet Addressing...>Control Subnet" menu of Toolbox:
89 89  **** Set routing to "Manual" with the start address and subnet size
90 90  **** E.g., a setting of "100.64.0.0/20" will have the processor at 10.64.0.1 with an IP mask of 255.255.240.0 and a default gateway and DNS server at 100.64.0.2
... ... @@ -96,16 +96,12 @@
96 96  ** Chief Integrations will provide an SRTakeoff.xlsx spreadsheet with an IP Table tab that lists the IP address for each processor. If these IP addresses must be changed during startup, then it will be necessary to also change the IP addresses in the Remote System Definition in the configuration file
97 97  ** See the[[ CoAP Setup Guide>>doc:SHOWRUNNER™ Integrations Guide.Integration Options.CoAP with Crestron S# Library and Modules.CoAP ShowRunner to ShowRunner Setup Instructions.WebHome]] for details
98 98  
99 -= Firmware Update =
100 -
101 -At this point, it is a good idea to [[update the device firmware>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Updating Firmware.WebHome||anchor="HNetworkDevices"]]
102 -
103 103  = Program Load =
104 104  
105 -* Download the latest build of ShowRunnerCLC™ from the[[ Chief Integrations Portal>>https://files.chiefintegrations.com/index.php/s/WHNzXrrZbB5jC3E]]
76 +* Download the latest build of SHOWRUNNER™ from the[[ Chief Integrations Portal>>https://files.chiefintegrations.com/index.php/s/WHNzXrrZbB5jC3E]]
106 106  * Connect your computer to the same network as the processor. Make sure your computer’s IP settings are compatible with the lighting network and do not conflict with any devices already on the network
107 107  ** While it is possible to load the program via USB, it is not recommended because the transfer speed is significantly slower than loading via Ethernet
108 -* Double click the PUF to open the Package Update Tool and install ShowRunnerCLC™ (works best with Toolbox closed)
79 +* Double click the PUF to open the Package Update Tool and install SHOWRUNNER™ (works best with Toolbox closed)
109 109  ** The Package Update Tool will automatically open your Address Book and prompt you to select a device
110 110  *** If you have not created an Address Book for this job, close the Address Book window and press the pencil icon
111 111  *** Type in the IP address of your processor and click "OK"
... ... @@ -112,19 +112,11 @@
112 112  ** Double check that the correct PUF file is listed under the "Package Info" section and that the correct IP address is listed under "Target"
113 113  ** Press the "Recheck" button
114 114  ** Make sure that all three tasks are selected ("Load ShowRunner Program", "Update Crestron App", and "Update XPanel")
115 -** Additional tasks are available for certain processors:
116 -*** ZUM-HUB4:
117 -**** "Configure ZUM-HUB4" will automatically run commands: ##cwsanticsrf OFF## and ##startprogafterrouter on##
118 -**** "Configure ZUM-HUB4 Subnet" will automatically reconfigure the control subnet to a 100.64.0.0/20 configuration to avoid potential conflicts with corporate networks
119 -***** **NOTE: If you are connected to the Control Subnet and select this option, you will need to reconnect to the processor and run the .puf again in order to finish loading ShowRunnerCLC™ as this option will interrupt your connection to the processor.**
120 -**** "Configure ZUM-HUB4 SecureGateway" will automatically run command: ##securegateway default##
121 -*** Processors with Routers (AV3, CP3N, PRO3, AV4, CP4N, and PRO4)
122 -**** "Configure Processor with Router" will automatically run command: ##startprogafterrouter on##
123 -** Press the "Update" button to begin loading ShowRunnerCLC™
86 +** Press the "Update" button to begin loading SHOWRUNNER™
124 124  * Sometimes the PUF tool will falsely report a failure to load the program
125 125  ** Connect to the processor via Text Console
126 126  ** Run the command ##sr ver##
127 -** If the console returns with the newly installed version of ShowRunnerCLC™, then the installation was successful
90 +** If the console returns with the newly installed version of SHOWRUNNER™, then the installation was successful
128 128  ** If the console returns with "Bad or Incomplete Command (sr)" then the installation was not successful
129 129  *** Rename the downloaded .puf file to be a .zip file and open the archive
130 130  **** Some file archivers (such as 7-Zip) allow you to right click on the PUF file and open the archive without changing the filetype
... ... @@ -133,11 +133,11 @@
133 133  **** Alternatively, navigate to Functions>SIMPL Program...>SIMPL Program (Program01)...
134 134  *** Under the "Send Program" section, browse your PC and select the extracted .cpz file
135 135  *** Click the "Send" button and click "Yes" to upload the program
136 -*** Once it is done loading, you should be able to run the ##sr ver## command and see the currently installed version of ShowRunnerCLC™
137 -* Once ShowRunnerCLC™ is loaded, you can connect to the UI by navigating to the processor’s IP. A license and configuration file are still required.  
138 -** **3-Series processors require authentication enabled** ("##ssl self##" command followed by a reboot can be used but steps will need to be repeated)
99 +*** Once it is done loading, you should be able to run the ##sr ver## command and see the currently installed version of SHOWRUNNER™
100 +* Once SHOWRUNNER™ is loaded, you can connect to the UI by navigating to the processor’s IP. A license and configuration file are still required.  
101 +** **3-Series processors require authentication enabled** (SSL self can be used but steps will need to be repeated)
139 139  ** If stuck on "Connecting to Processor" you will need to accept the certificate
140 -* For jobs with multiple processors, ShowRunnerCLC™ will need to be loaded to each processor
103 +* For jobs with multiple processors, SHOWRUNNER™ will need to be loaded to each processor
141 141  
142 142  = License and Configuration Deployment =
143 143  
... ... @@ -144,7 +144,7 @@
144 144  * Download the SrConfig.json or CiLightingConfig.json configuration file from the link provided by Chief Integrations
145 145  * Obtain and download the license from [[https:~~/~~/portal.chiefintegrations.com>>url:https://portal.chiefintegrations.com]]
146 146  ** Processors with a Control Subnet should use the LAN MAC address, **not** the Control Subnet MAC address
147 -* The license and configuration can be loaded with Toolbox using Text Console and File Management, or through the ShowRunnerHUB™ web interface
110 +* The license and configuration can be loaded with Toolbox using Text Console and File Management, or through the showrunnerHUB™ web interface
148 148  ** Using Toolbox:
149 149  *** Connect to the processor via Text Console and via File Management
150 150  *** In File management, navigate to the "NVRAM>sr" folder from the left-hand menu
... ... @@ -154,17 +154,15 @@
154 154  *** Right-click on the right-hand side and select "Copy File(s) From..." and select the downloaded SrConfig.json file
155 155  **** Alternatively, drag and drop the file from your computer to the File Management tool
156 156  **** If you downloaded a CiLightingConfig.json file, it must be renamed to "SrConfig.json"
157 -*** Note: when loading the license and configuration through Toolbox, the "License.lic" file and "SrConfig.json" file must have exact filenames
158 -**** If the files were automatically numbered during download (e.g. by adding a "(1)" or "(2)" to the end of the filename), the files must be renamed before loading them to the processor
159 -** Using the ShowRunnerHUB™ UI:
120 +** Using the showrunnerHUB™ UI:
160 160  *** Using Chrome or Firefox, navigate to the processor's IP address
161 161  *** When prompted, input your credentials and log in
162 162  **** 4-Series processor or 3-Series processor with authentication enabled: Log in using the same admin credentials used to connect to the processor
163 163  **** 3-Series processor without authentication enabled: Connect to the processor via Text Console and run the following command, replacing the "username", "name" and "password" with your desired credentials.
164 -***** ##sradmin add user **username **"**name**" Administrators **password**##
165 -***** The username and password should be one word each and are the credentials used to log in to the ShowRunnerHUB™
166 -***** The name can be multiple words as long as it is in quotes, and is simply a friendly name used to identify each user
167 -*** Once logged in to the ShowRunnerHUB™ UI, you should be automatically redirected to the File Management page
125 +***** ##sradmin username "name" administrators password##
126 +***** The username and password should be one word each and are the credentials used to log in to the showrunnerHUB™
127 +***** The name can be multiple words as long as it is in quotes, and is simply a friendly name used to identify each user.
128 +*** Once logged in to the showrunnerHUB™ UI, you should be automatically redirected to the File Management page
168 168  **** If you are not automatically redirected, then you can navigate to this page by clicking "Setup" in the top right and then selecting "File Management" from the list on the left
169 169  **** [[image:1654807593390-193.png]]
170 170  **** Under “Upload New License File”
... ... @@ -182,10 +182,8 @@
182 182  ****** Enter the secret used to create the backup. ShowRunner will upload the file and verify the secret.
183 183  **** Once both the license and either a configuration file or backup have been loaded, click "Restart"
184 184  **** Wait for the processor to finish restarting and then reload the page.
185 -***** 3-Series processors will take 45 to 90 seconds to restart, possibly longer depending on the size and complexity of the configuration
186 -***** 4-Series processors will restart considerably faster
187 -**** If licensed for SR-BNI, you will need to generate a [[free Crestron BACnet License>>https://www.crestron.com/Support/Tools/Licensing-Registration/Bacnet-License-Registration]]
188 -**** If licensed for SR-BNI50, you will need to generate a [[paid Crestron 50+ BACnet Point License>>https://www.crestron.com/Support/Tools/Licensing-Registration/Bacnet-License-Registration]]
146 +***** 3-Series processors will take 45 to 90 restart
147 +***** 4-Series processors should restart considerably faster
189 189  
190 190  = Set System Time =
191 191  
... ... @@ -198,14 +198,15 @@
198 198  ** If your PC is in the incorrect Timezone or the time did not synchronize properly, then manually adjust the Time, Date, and Timezone
199 199  * Press the Apply button
200 200  
201 -Note that the Location given in the System Clock... menu of Toolbox is not used by ShowRunnerCLC™. Instead, the location used for sunrise/sunset calculations is stored in the configuration and will typically be set by Chief Integrations prior to delivery of the configuration. Both the location and time can be viewed and edited using the ShowRunnerCLC™ UI
160 +Note that the Location given in the System Clock... menu of Toolbox is not used by SHOWRUNNER™. Instead, the location used for sunrise/sunset calculations is stored in the configuration and will typically be set by Chief Integrations prior to delivery of the configuration. Both the location and time can be viewed and edited using the SHOWRUNNER™ UI
202 202  
203 -* ShowRunnerCLC™ XPanel UI:
162 +* SHOWRUNNER™ XPanel UI:
204 204  ** Navigate to Settings>Location and System Clock
205 205  ** Press the Lock icon to enable editing
206 206  ** Adjust the time, timezone, and location as necessary
207 207  ** Press Set System Clock to save the changes
208 -* ShowRunnerHUB™ Web UI:
167 +* showrunnerHUB™ Web UI:
209 209  ** Navigate to Setup>System Settings>Location and System Clock
210 210  ** Adjust the time, timezone, and location as necessary
211 211  ** Click Apply to save the changes
171 +)))