Skip to Content

Changes for page Processor Setup

Last modified by Alexander Mott on 2024/12/02 19:04
From version 22.1
edited by Alexander Mott
on 2022/06/30 15:32
Change comment: There is no comment for this version
To version 38.1
edited by Scott Kohlmann
on 2023/04/20 22:49
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
1 +XWiki.scott\.kohlmann@chiefintegrations\.com
Content
... ... @@ -1,25 +1,30 @@
1 1  (% class="box errormessage" %)
2 2  (((
3 -This page is for ordinary 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 +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 4  )))
5 5  
6 6  (% class="box warningmessage" %)
7 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 -)))
8 +ShowRunnerCLC™™ is tested against current Crestron firmware releases. **Please use at least the recommended firmware builds.**
13 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)
10 +* 3-Series: PUF 1.8001.0146
11 +* 4-Series: PUF 2.7000.00052.01
12 +* VC-4: 2.7000.00047
13 +
14 +**Notes:**
15 +
16 +* Static IP or properly setup DHCP/DNS implementation required.
17 +* Auto-Assigned/Link-Local IP address range of 169.254.x.x not supported (Crestron xPanel issue)
19 19  )))
20 20  
21 -**ShowRunner Installation Tutorial:**
20 +{{box cssClass="floatinginfobox" title="**CONTENTS**"}}
21 +{{toc/}}
22 +{{/box}}
22 22  
24 +(% class="row" %)
25 +(((
26 +**ShowRunnerCLC™ Installation Tutorial:**
27 +
23 23  [[https:~~/~~/www.youtube.com/watch?v=xuJ94cMCCa8>>url:https://www.youtube.com/watch?v=xuJ94cMCCa8]]
24 24  
25 25  **Licensing tutorial:**
... ... @@ -28,7 +28,7 @@
28 28  
29 29  [[https:~~/~~/www.youtube.com/watch?v=H8CLZ7bp0eI>>url:https://www.youtube.com/watch?v=H8CLZ7bp0eI]]
30 30  
31 -=== IP Configuration ===
36 += IP Configuration =
32 32  
33 33  * Connect to the processor via USB and set the processor’s IP Address per your network requirements
34 34  ** 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
... ... @@ -49,26 +49,30 @@
49 49  *** Configure your DHCP server software to assign IP addresses in the desired range
50 50  *** Once the processor is assigned an IP address, connect to it via Text Console at the assigned IP address
51 51  *** Run the above commands to disable DHCP and assign a static IP address to the processor
52 -* For processors with a Control Subnet (CP3N/AV3/PRO3/CP4N/AV4/PRO4/ZUM-HUB4), additional setup is required
57 +* For processors with a Control Subnet (CP3N/AV3/PRO3/CP4N/AV4/PRO4), additional setup is required
53 53  ** Connect to the processor via Text Console and run the command: ##startprogafterrouter on##
54 -*** 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.
59 +*** 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.
55 55  ** 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.
56 -** 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.
57 -** The Control Subnet can be configured manually in the "Functions>Ethernet Addressing...>Control Subnet" menu of Toolbox
58 -*** Set routing to "Manual" with the start address and subnet size
59 -*** 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
60 -** 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**##
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 +*** Lighting hardware can be connected via the LAN port, however for proper functionality you must run the command: ##securegateway default##
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##
61 61  * If the job has multiple processors, then these steps must be repeated for all processors on the job
62 62  ** For jobs with Central Control, the IP addresses of the processors matters
63 63  ** 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
64 64  ** 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
65 65  
66 -=== Program Load ===
75 += Program Load =
67 67  
68 -* Download the latest build of SHOWRUNNER™ from the[[ Chief Integrations Portal>>https://files.chiefintegrations.com/index.php/s/WHNzXrrZbB5jC3E]]
77 +* Download the latest build of ShowRunnerCLC™ from the[[ Chief Integrations Portal>>https://files.chiefintegrations.com/index.php/s/WHNzXrrZbB5jC3E]]
69 69  * 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
70 70  ** 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
71 -* Double click the PUF to open the Package Update Tool and install SHOWRUNNER™ (works best with Toolbox closed)
80 +* Double click the PUF to open the Package Update Tool and install ShowRunnerCLC™ (works best with Toolbox closed)
72 72  ** The Package Update Tool will automatically open your Address Book and prompt you to select a device
73 73  *** If you have not created an Address Book for this job, close the Address Book window and press the pencil icon
74 74  *** Type in the IP address of your processor and click "OK"
... ... @@ -75,30 +75,31 @@
75 75  ** Double check that the correct PUF file is listed under the "Package Info" section and that the correct IP address is listed under "Target"
76 76  ** Press the "Recheck" button
77 77  ** Make sure that all three tasks are selected ("Load ShowRunner Program", "Update Crestron App", and "Update XPanel")
78 -** Press the "Update" button to begin loading SHOWRUNNER™
87 +** Press the "Update" button to begin loading ShowRunnerCLC™
79 79  * Sometimes the PUF tool will falsely report a failure to load the program
80 80  ** Connect to the processor via Text Console
81 81  ** Run the command ##sr ver##
82 -** If the console returns with the newly installed version of SHOWRUNNER™, then the installation was successful
91 +** If the console returns with the newly installed version of ShowRunnerCLC™, then the installation was successful
83 83  ** If the console returns with "Bad or Incomplete Command (sr)" then the installation was not successful
84 -*** 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
85 85  **** Some file archivers (such as 7-Zip) allow you to right click on the PUF file and open the archive without changing the filetype
86 86  *** Extract the "CI.Lighting.ShowRunner.cpz" file
87 -*** In Toolbox, connect to the processor via Text Console and click the lightning bolt icon and select "SIMPL Program..."
88 -*** 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
89 89  *** Click the "Send" button and click "Yes" to upload the program
90 -*** Once it is done loading, you should be able to run the ##sr ver## command and see the currently installed version of SHOWRUNNER™
91 -* 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.  
92 -** **3-Series processors require authentication enabled** (SSL self can be used but steps will need to be repeated)
100 +*** Once it is done loading, you should be able to run the ##sr ver## command and see the currently installed version of ShowRunnerCLC™
101 +* 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.  
102 +** **3-Series processors require authentication enabled** ("##ssl self##" command followed by a reboot can be used but steps will need to be repeated)
93 93  ** If stuck on "Connecting to Processor" you will need to accept the certificate
94 -* For jobs with multiple processors, SHOWRUNNER™ will need to be loaded to each processor
104 +* For jobs with multiple processors, ShowRunnerCLC™ will need to be loaded to each processor
95 95  
96 -=== License and Configuration Deployment ===
106 += License and Configuration Deployment =
97 97  
98 98  * Download the SrConfig.json or CiLightingConfig.json configuration file from the link provided by Chief Integrations
99 99  * Obtain and download the license from [[https:~~/~~/portal.chiefintegrations.com>>url:https://portal.chiefintegrations.com]]
100 100  ** Processors with a Control Subnet should use the LAN MAC address, **not** the Control Subnet MAC address
101 -* The license and configuration can be loaded with Toolbox using Text Console and File Management, or through the showrunnerHUB™ web interface
111 +* The license and configuration can be loaded with Toolbox using Text Console and File Management, or through the ShowRunnerHUB™ web interface
102 102  ** Using Toolbox:
103 103  *** Connect to the processor via Text Console and via File Management
104 104  *** In File management, navigate to the "NVRAM>sr" folder from the left-hand menu
... ... @@ -108,15 +108,15 @@
108 108  *** Right-click on the right-hand side and select "Copy File(s) From..." and select the downloaded SrConfig.json file
109 109  **** Alternatively, drag and drop the file from your computer to the File Management tool
110 110  **** If you downloaded a CiLightingConfig.json file, it must be renamed to "SrConfig.json"
111 -** Using the showrunnerHUB™ UI:
121 +** Using the ShowRunnerHUB™ UI:
112 112  *** Using Chrome or Firefox, navigate to the processor's IP address
113 113  *** When prompted, input your credentials and log in
114 114  **** 4-Series processor or 3-Series processor with authentication enabled: Log in using the same admin credentials used to connect to the processor
115 115  **** 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.
116 116  ***** ##sradmin username "name" administrators password##
117 -***** The username and password should be one word each and are the credentials used to log in to the showrunnerHUB™
127 +***** The username and password should be one word each and are the credentials used to log in to the ShowRunnerHUB™
118 118  ***** The name can be multiple words as long as it is in quotes, and is simply a friendly name used to identify each user.
119 -*** 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
120 120  **** 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
121 121  **** [[image:1654807593390-193.png]]
122 122  **** Under “Upload New License File”
... ... @@ -137,7 +137,7 @@
137 137  ***** 3-Series processors will take 45 to 90 restart
138 138  ***** 4-Series processors should restart considerably faster
139 139  
140 -=== Set System Time ===
150 += Set System Time =
141 141  
142 142  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:
143 143  
... ... @@ -148,14 +148,15 @@
148 148  ** If your PC is in the incorrect Timezone or the time did not synchronize properly, then manually adjust the Time, Date, and Timezone
149 149  * Press the Apply button
150 150  
151 -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
161 +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
152 152  
153 -* SHOWRUNNER™ XPanel UI:
163 +* ShowRunnerCLC™ XPanel UI:
154 154  ** Navigate to Settings>Location and System Clock
155 155  ** Press the Lock icon to enable editing
156 156  ** Adjust the time, timezone, and location as necessary
157 157  ** Press Set System Clock to save the changes
158 -* showrunnerHUB™ Web UI:
168 +* ShowRunnerHUB™ Web UI:
159 159  ** Navigate to Setup>System Settings>Location and System Clock
160 160  ** Adjust the time, timezone, and location as necessary
161 161  ** Click Apply to save the changes
172 +)))