Skip to Content

Wiki source code of Processor Setup

Version 30.1 by Alexander Mott on 2022/09/16 20:47
Show last authors
1 (% class="box errormessage" %)
2 (((
3 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]].
4 )))
5
6 (% class="box warningmessage" %)
7 (((
8 SHOWRUNNER™ is tested against current Crestron firmware releases.  Please use at least the recommended firmware builds.
9 3-Series: PUF 1.8001.0146
10 4-Series: PUF 2.7000.00052.01
11 VC-4: 2.7000.00047
12 )))
13
14 (% class="box infomessage" id="HNotes" %)
15 (((
16 Notes
17 Static IP or properly setup DHCP/DNS implementation required.
18 Auto-Assigned/Link-Local IP address range of 169.254.x.x not supported (Crestron xPanel issue)
19 )))
20
21 {{box title="**Contents**"}}
22 {{toc/}}
23 {{/box}}
24
25 (% class="row" %)
26 (((
27 **ShowRunner Installation Tutorial:**
28
29 [[https:~~/~~/www.youtube.com/watch?v=xuJ94cMCCa8>>url:https://www.youtube.com/watch?v=xuJ94cMCCa8]]
30
31 **Licensing tutorial:**
32
33 //Note: Please use Chrome or Firefox to download the License from [[https:~~/~~/portal.chiefintegrations.com>>https://portal.chiefintegrations.com]].  Edge and Internet Explorer do not work properly.//
34
35 [[https:~~/~~/www.youtube.com/watch?v=H8CLZ7bp0eI>>url:https://www.youtube.com/watch?v=H8CLZ7bp0eI]]
36
37 = IP Configuration =
38
39 * Connect to the processor via USB and set the processor’s IP Address per your network requirements
40 ** When connecting to a 4-Series processor or a 3-Series processor with authentication enabled for the first time, it will prompt for the creation of an admin-level CWS user
41 *** Input the desired username and password into the dialog box. Save this login information, as it is not possible to recover if it is lost or forgotten
42 *** In the event that the processor does not allow you to log in with the chosen credentials (i.e. it repeatedly prompts for credentials)
43 **** Attempt to log in with username "crestron" and no password
44 **** Once logged into Text Console, run the following commands, replacing the "username" and "password" with your desired credentials
45 ***** ##adduser -N:username -P:password##
46 ***** ##addusertogroup -N:username -G:Administrators##
47 ** Once connected, open Text Console and run the following commands to configure the processor's IP settings (example is for a **10.0.0.0(% style="color:darkgoldenrod" %)/24(%%)** subnet, with a processor IP address of (% style="color:blue" %)**10.0.0.10**(%%))
48 *** Disable DHCP: ##dhcp 0 off##
49 *** Set IP address: ##ipa 0 (% style="color:blue" %)**10.0.0.10**(%%)##
50 *** Set IP subnet mask: ##ipm 0 (% style="color:darkgoldenrod" %)**255.255.255.0**(%%)##
51 *** Set default gateway: ##defr 0 **10.0.0.1**##
52 *** Set hostname: ##host AP3-CPP##
53 *** Reboot the processor: ##reboot##
54 ** It is also possible to configure a processor over Ethernet by using a DHCP server software on your laptop to assign an IP address
55 *** Configure your DHCP server software to assign IP addresses in the desired range
56 *** Once the processor is assigned an IP address, connect to it via Text Console at the assigned IP address
57 *** Run the above commands to disable DHCP and assign a static IP address to the processor
58 * For processors with a Control Subnet (CP3N/AV3/PRO3/CP4N/AV4/PRO4/ZUM-HUB4), additional setup is required
59 ** Connect to the processor via Text Console and run the command: ##startprogafterrouter on##
60 *** 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.
61 ** 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.
62 ** 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.
63 ** The Control Subnet will automatically configure itself based on the LAN configuration, but it can optionally be configured manually:
64 *** Using the "Functions>Ethernet Addressing...>Control Subnet" menu of Toolbox:
65 **** Set routing to "Manual" with the start address and subnet size
66 **** 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
67 *** Using Text Console commands (example for a **100.64.0.0/20** subnet, with a processor IP address of **100.64.0.1**)
68 **** Set CS IP: ##csrouterprefix **100.64.0.0/20**##
69 **** Reboot the processor: ##reboot##
70 * If the job has multiple processors, then these steps must be repeated for all processors on the job
71 ** For jobs with Central Control, the IP addresses of the processors matters
72 ** 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
73 ** 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
74
75 = Program Load =
76
77 * Download the latest build of SHOWRUNNER™ from the[[ Chief Integrations Portal>>https://files.chiefintegrations.com/index.php/s/WHNzXrrZbB5jC3E]]
78 * 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
79 ** 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
80 * Double click the PUF to open the Package Update Tool and install SHOWRUNNER™ (works best with Toolbox closed)
81 ** The Package Update Tool will automatically open your Address Book and prompt you to select a device
82 *** If you have not created an Address Book for this job, close the Address Book window and press the pencil icon
83 *** Type in the IP address of your processor and click "OK"
84 ** Double check that the correct PUF file is listed under the "Package Info" section and that the correct IP address is listed under "Target"
85 ** Press the "Recheck" button
86 ** Make sure that all three tasks are selected ("Load ShowRunner Program", "Update Crestron App", and "Update XPanel")
87 ** Press the "Update" button to begin loading SHOWRUNNER™
88 * Sometimes the PUF tool will falsely report a failure to load the program
89 ** Connect to the processor via Text Console
90 ** Run the command ##sr ver##
91 ** If the console returns with the newly installed version of SHOWRUNNER™, then the installation was successful
92 ** If the console returns with "Bad or Incomplete Command (sr)" then the installation was not successful
93 *** Rename the downloaded .puf file to be a .zip file and open the archive
94 **** Some file archivers (such as 7-Zip) allow you to right click on the PUF file and open the archive without changing the filetype
95 *** Extract the "CI.Lighting.ShowRunner.cpz" file
96 *** In Toolbox, connect to the processor via Text Console, click the lightning bolt icon, and select "SIMPL Program..."
97 **** Alternatively, navigate to Functions>SIMPL Program...>SIMPL Program (Program01)...
98 *** Under the "Send Program" section, browse your PC and select the extracted .cpz file
99 *** Click the "Send" button and click "Yes" to upload the program
100 *** Once it is done loading, you should be able to run the ##sr ver## command and see the currently installed version of SHOWRUNNER™
101 * 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.  
102 ** **3-Series processors require authentication enabled** (SSL self can be used but steps will need to be repeated)
103 ** If stuck on "Connecting to Processor" you will need to accept the certificate
104 * For jobs with multiple processors, SHOWRUNNER™ will need to be loaded to each processor
105
106 = License and Configuration Deployment =
107
108 * Download the SrConfig.json or CiLightingConfig.json configuration file from the link provided by Chief Integrations
109 * Obtain and download the license from [[https:~~/~~/portal.chiefintegrations.com>>url:https://portal.chiefintegrations.com]]
110 ** Processors with a Control Subnet should use the LAN MAC address, **not** the Control Subnet MAC address
111 * The license and configuration can be loaded with Toolbox using Text Console and File Management, or through the showrunnerHUB™ web interface
112 ** Using Toolbox:
113 *** Connect to the processor via Text Console and via File Management
114 *** In File management, navigate to the "NVRAM>sr" folder from the left-hand menu
115 *** Right-click on the right-hand side and select "Copy File(s) From..." and select the downloaded License.lic file
116 **** Alternatively, drag and drop the file from your computer to the File Management tool
117 *** Using the left-hand menu, navigate to the "NVRAM>sr>default" folder
118 *** Right-click on the right-hand side and select "Copy File(s) From..." and select the downloaded SrConfig.json file
119 **** Alternatively, drag and drop the file from your computer to the File Management tool
120 **** If you downloaded a CiLightingConfig.json file, it must be renamed to "SrConfig.json"
121 ** Using the showrunnerHUB™ UI:
122 *** Using Chrome or Firefox, navigate to the processor's IP address
123 *** When prompted, input your credentials and log in
124 **** 4-Series processor or 3-Series processor with authentication enabled: Log in using the same admin credentials used to connect to the processor
125 **** 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.
126 ***** ##sradmin username "name" administrators password##
127 ***** The username and password should be one word each and are the credentials used to log in to the showrunnerHUB™
128 ***** The name can be multiple words as long as it is in quotes, and is simply a friendly name used to identify each user.
129 *** Once logged in to the showrunnerHUB™ UI, you should be automatically redirected to the File Management page
130 **** 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
131 **** [[image:1654807593390-193.png]]
132 **** Under “Upload New License File”
133 ***** Leave "Restart after transfer" unchecked
134 ***** Select “Choose File” and browse for the license file you downloaded from the portal
135 ***** Select “Upload”
136 **** Load the configuration file either directly (if you have an SrConfig.json file) or from a backup (if you have an SRBackup.zip)
137 ***** Direct upload:
138 ****** Under “Upload New Config File”
139 ****** Select “Choose File” and find the provided CiLightingConfig.json or SrConfig.json file for this processor from the project link that was sent at project delivery.
140 ****** Select “Upload”
141 ***** From a Backup:
142 ****** Select "Restore"
143 ****** Select "Choose Backup" and find the SRBackup.zip of the backup you wish to restore
144 ****** Enter the secret used to create the backup. ShowRunner will upload the file and verify the secret.
145 **** Once both the license and either a configuration file or backup have been loaded, click "Restart"
146 **** Wait for the processor to finish restarting and then reload the page.
147 ***** 3-Series processors will take 45 to 90 restart
148 ***** 4-Series processors should restart considerably faster
149
150 = Set System Time =
151
152 It is important for the device clock to be accurate in order for scheduled events to trigger at the appropriate time. If Toolbox is still open, this can be done easily:
153
154 * Connect to the processor via Text Console
155 * At the top of the Toolbox window, navigate to Functions>System Clock...
156 * If your computer is in the correct timezone, click Synchronize Device Time with PC
157 ** The Timezone and Device Time should synchronize automatically
158 ** If your PC is in the incorrect Timezone or the time did not synchronize properly, then manually adjust the Time, Date, and Timezone
159 * Press the Apply button
160
161 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
162
163 * SHOWRUNNER™ XPanel UI:
164 ** Navigate to Settings>Location and System Clock
165 ** Press the Lock icon to enable editing
166 ** Adjust the time, timezone, and location as necessary
167 ** Press Set System Clock to save the changes
168 * showrunnerHUB™ Web UI:
169 ** Navigate to Setup>System Settings>Location and System Clock
170 ** Adjust the time, timezone, and location as necessary
171 ** Click Apply to save the changes
172 )))