Skip to Content

Changes for page Processor Setup

Last modified by Alexander Mott on 2024/12/02 19:04
From version 29.1
edited by Alexander Mott
on 2022/09/16 20:47
Change comment: There is no comment for this version
To version 16.1
edited by Alexander Mott
on 2022/06/13 17:29
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,1 +1,1 @@
1 -SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.WebHome
1 +SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.WebHome
Content
... ... @@ -1,14 +5,11 @@
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 5  (% class="box warningmessage" %)
6 6  (((
7 -SHOWRUNNER™ is tested against current Crestron firmware releases.  Please use at least the recommended firmware builds.
3 +showrunner is tested against current Crestron firmware releases.  Please use at least the recommended firmware builds.
8 8  3-Series: PUF 1.8001.0146
9 9  4-Series: PUF 2.7000.00052.01
10 10  VC-4: 2.7000.00047
11 11  )))
8 +
12 12  (% class="box infomessage" id="HNotes" %)
13 13  (((
14 14  Notes
... ... @@ -15,12 +15,7 @@
15 15  Static IP or properly setup DHCP/DNS implementation required.
16 16  Auto-Assigned/Link-Local IP address range of 169.254.x.x not supported (Crestron xPanel issue)
17 17  )))
18 -{{box title="**Contents**"}}
19 -{{toc/}}
20 -{{/box}}
21 21  
22 -(% class="row" %)
23 -(((
24 24  **ShowRunner Installation Tutorial:**
25 25  
26 26  [[https:~~/~~/www.youtube.com/watch?v=xuJ94cMCCa8>>url:https://www.youtube.com/watch?v=xuJ94cMCCa8]]
... ... @@ -31,7 +31,7 @@
31 31  
32 32  [[https:~~/~~/www.youtube.com/watch?v=H8CLZ7bp0eI>>url:https://www.youtube.com/watch?v=H8CLZ7bp0eI]]
33 33  
34 -= IP Configuration =
26 +=== IP Configuration ===
35 35  
36 36  * Connect to the processor via USB and set the processor’s IP Address per your network requirements
37 37  ** 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
... ... @@ -57,22 +57,19 @@
57 57  *** 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.
58 58  ** 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.
59 59  ** 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.
60 -** The Control Subnet will automatically configure itself based on the LAN configuration, but it can optionally be configured manually:
61 -*** Using the "Functions>Ethernet Addressing...>Control Subnet" menu of Toolbox:
62 -**** Set routing to "Manual" with the start address and subnet size
63 -**** 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
64 -*** Using Text Console commands (example for a **100.64.0.0/20** subnet, with a processor IP address of **100.64.0.1**)
65 -**** Set CS IP: ##csrouterprefix **100.64.0.0/20**##
66 -**** Reboot the processor: ##reboot##
52 +** The Control Subnet can be configured manually in the "Functions>Ethernet Addressing...>Control Subnet" menu of Toolbox
53 +*** Set routing to "Manual" with the start address and subnet size
54 +*** E.g., a setting of "10.0.0.0/24" will have the processor at 10.0.0.1 with an IP mask of 255.255.255.0 and a default gateway and DNS server at 10.0.0.2
55 +** The Control Subnet can also be configured to e.g. **10.0.0.0/24** using Text Console command: ##csrouterprefix **10.0.0.0/24**##
67 67  * If the job has multiple processors, then these steps must be repeated for all processors on the job
68 68  ** For jobs with Central Control, the IP addresses of the processors matters
69 69  ** 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
70 70  ** 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
71 71  
72 -= Program Load =
61 +=== Program Load ===
73 73  
74 74  * Download the latest build of SHOWRUNNER™ from the[[ Chief Integrations Portal>>https://files.chiefintegrations.com/index.php/s/WHNzXrrZbB5jC3E]]
75 -* 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
64 +* 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.
76 76  ** 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
77 77  * Double click the PUF to open the Package Update Tool and install SHOWRUNNER™ (works best with Toolbox closed)
78 78  ** The Package Update Tool will automatically open your Address Book and prompt you to select a device
... ... @@ -87,20 +87,19 @@
87 87  ** Run the command ##sr ver##
88 88  ** If the console returns with the newly installed version of SHOWRUNNER™, then the installation was successful
89 89  ** If the console returns with "Bad or Incomplete Command (sr)" then the installation was not successful
90 -*** Rename the downloaded .puf file to be a .zip file and open the archive
79 +*** Rename the .puf file to be a .zip file and open the archive
91 91  **** Some file archivers (such as 7-Zip) allow you to right click on the PUF file and open the archive without changing the filetype
92 92  *** Extract the "CI.Lighting.ShowRunner.cpz" file
93 -*** In Toolbox, connect to the processor via Text Console, click the lightning bolt icon, and select "SIMPL Program..."
94 -**** Alternatively, navigate to Functions>SIMPL Program...>SIMPL Program (Program01)...
95 -*** Under the "Send Program" section, browse your PC and select the extracted .cpz file
82 +*** In Toolbox, connect to the processor via Text Console and click the lightning bolt icon and select "SIMPL Program..."
83 +*** Under the "Send" section, browse your PC and select the extracted .cpz file
96 96  *** Click the "Send" button and click "Yes" to upload the program
97 97  *** Once it is done loading, you should be able to run the ##sr ver## command and see the currently installed version of SHOWRUNNER™
98 98  * 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.  
99 -** **3-Series processors require authentication enabled** (SSL self can be used but steps will need to be repeated)
100 -** If stuck on "Connecting to Processor" you will need to accept the certificate
101 -* For jobs with multiple processors, SHOWRUNNER™ will need to be loaded to each processor
87 +** **3-Series processors require authentication enabled** (SSL self can be used but steps will need to be repeated).
88 +** If stuck on "Connecting to Processor" you will need to accept the certificate.
89 +* For jobs with multiple processors, SHOWRUNNER™ will need to be loaded to each processor.
102 102  
103 -= License and Configuration Deployment =
91 +=== License and Configuration Deployment ===
104 104  
105 105  * Download the SrConfig.json or CiLightingConfig.json configuration file from the link provided by Chief Integrations
106 106  * Obtain and download the license from [[https:~~/~~/portal.chiefintegrations.com>>url:https://portal.chiefintegrations.com]]
... ... @@ -123,7 +123,7 @@
123 123  ***** ##sradmin username "name" administrators password##
124 124  ***** The username and password should be one word each and are the credentials used to log in to the showrunnerHUB™
125 125  ***** The name can be multiple words as long as it is in quotes, and is simply a friendly name used to identify each user.
126 -*** Once logged in to the showrunnerHUB™ UI, you should be automatically redirected to the File Management page
114 +*** Once logged in to the showrunnerHUB™ UI, you should be automatically redirected to the File Management page.
127 127  **** 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
128 128  **** [[image:1654807593390-193.png]]
129 129  **** Under “Upload New License File”
... ... @@ -143,27 +143,3 @@
143 143  **** Wait for the processor to finish restarting and then reload the page.
144 144  ***** 3-Series processors will take 45 to 90 restart
145 145  ***** 4-Series processors should restart considerably faster
146 -
147 -= Set System Time =
148 -
149 -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:
150 -
151 -* Connect to the processor via Text Console
152 -* At the top of the Toolbox window, navigate to Functions>System Clock...
153 -* If your computer is in the correct timezone, click Synchronize Device Time with PC
154 -** The Timezone and Device Time should synchronize automatically
155 -** If your PC is in the incorrect Timezone or the time did not synchronize properly, then manually adjust the Time, Date, and Timezone
156 -* Press the Apply button
157 -
158 -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
159 -
160 -* SHOWRUNNER™ XPanel UI:
161 -** Navigate to Settings>Location and System Clock
162 -** Press the Lock icon to enable editing
163 -** Adjust the time, timezone, and location as necessary
164 -** Press Set System Clock to save the changes
165 -* showrunnerHUB™ Web UI:
166 -** Navigate to Setup>System Settings>Location and System Clock
167 -** Adjust the time, timezone, and location as necessary
168 -** Click Apply to save the changes
169 -)))