Skip to Content

Changes for page Processor Setup

Last modified by Alexander Mott on 2024/12/02 19:04
From version 12.1
edited by Alexander Mott
on 2022/06/13 15:11
Change comment: There is no comment for this version
To version 27.1
edited by Alexander Mott
on 2022/09/16 20:45
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.WebHome
1 +SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.WebHome
Content
... ... @@ -1,6 +1,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 +
1 1  (% class="box warningmessage" %)
2 2  (((
3 -showrunner is tested against current Crestron firmware releases.  Please use at least the recommended firmware builds.
8 +SHOWRUNNER™ is tested against current Crestron firmware releases.  Please use at least the recommended firmware builds.
4 4  3-Series: PUF 1.8001.0146
5 5  4-Series: PUF 2.7000.00052.01
6 6  VC-4: 2.7000.00047
... ... @@ -13,6 +13,12 @@
13 13  Auto-Assigned/Link-Local IP address range of 169.254.x.x not supported (Crestron xPanel issue)
14 14  )))
15 15  
21 +{{box title="**Contents**"}}
22 +{{toc/}}
23 +{{/box}}
24 +
25 +(% class="row" %)
26 +(((
16 16  **ShowRunner Installation Tutorial:**
17 17  
18 18  [[https:~~/~~/www.youtube.com/watch?v=xuJ94cMCCa8>>url:https://www.youtube.com/watch?v=xuJ94cMCCa8]]
... ... @@ -33,7 +33,7 @@
33 33  **** Once logged into Text Console, run the following commands, replacing the "username" and "password" with your desired credentials
34 34  ***** ##adduser -N:username -P:password##
35 35  ***** ##addusertogroup -N:username -G:Administrators##
36 -** 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*(%%))
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**(%%))
37 37  *** Disable DHCP: ##dhcp 0 off##
38 38  *** Set IP address: ##ipa 0 (% style="color:blue" %)**10.0.0.10**(%%)##
39 39  *** Set IP subnet mask: ##ipm 0 (% style="color:darkgoldenrod" %)**255.255.255.0**(%%)##
... ... @@ -49,10 +49,13 @@
49 49  *** 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.
50 50  ** 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.
51 51  ** 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.
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 using Text Console command: ##csrouterprefix **10.0.0.0/24**##
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##
56 56  * If the job has multiple processors, then these steps must be repeated for all processors on the job
57 57  ** For jobs with Central Control, the IP addresses of the processors matters
58 58  ** 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
... ... @@ -60,8 +60,8 @@
60 60  
61 61  === Program Load ===
62 62  
63 -* Download the latest build of SHOWRUNNER™ [[https:~~/~~/files.chiefintegrations.com/s/WHNzXrrZbB5jC3E>>url:https://files.chiefintegrations.com/s/WHNzXrrZbB5jC3E]]
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.
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
65 65  ** 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
66 66  * Double click the PUF to open the Package Update Tool and install SHOWRUNNER™ (works best with Toolbox closed)
67 67  ** The Package Update Tool will automatically open your Address Book and prompt you to select a device
... ... @@ -76,17 +76,18 @@
76 76  ** Run the command ##sr ver##
77 77  ** If the console returns with the newly installed version of SHOWRUNNER™, then the installation was successful
78 78  ** If the console returns with "Bad or Incomplete Command (sr)" then the installation was not successful
79 -*** Rename the .puf file to be a .zip file and open the archive
93 +*** Rename the downloaded .puf file to be a .zip file and open the archive
80 80  **** Some file archivers (such as 7-Zip) allow you to right click on the PUF file and open the archive without changing the filetype
81 81  *** Extract the "CI.Lighting.ShowRunner.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 +*** 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
84 84  *** Click the "Send" button and click "Yes" to upload the program
85 85  *** Once it is done loading, you should be able to run the ##sr ver## command and see the currently installed version of SHOWRUNNER™
86 86  * 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.  
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 +** **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
90 90  
91 91  === License and Configuration Deployment ===
92 92  
... ... @@ -111,7 +111,7 @@
111 111  ***** ##sradmin username "name" administrators password##
112 112  ***** The username and password should be one word each and are the credentials used to log in to the showrunnerHUB™
113 113  ***** The name can be multiple words as long as it is in quotes, and is simply a friendly name used to identify each user.
114 -*** Once logged in to the showrunnerHUB™ UI, you should be automatically redirected to the File Management page.
129 +*** Once logged in to the showrunnerHUB™ UI, you should be automatically redirected to the File Management page
115 115  **** 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
116 116  **** [[image:1654807593390-193.png]]
117 117  **** Under “Upload New License File”
... ... @@ -131,3 +131,27 @@
131 131  **** Wait for the processor to finish restarting and then reload the page.
132 132  ***** 3-Series processors will take 45 to 90 restart
133 133  ***** 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 +)))