Wiki source code of Processor Setup

Last modified by Alexander Mott on 2024/03/27 15:49
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 ShowRunnerCLC™™ is tested against current Crestron firmware releases. **Please use at least the recommended firmware builds.**
9
10 * 3-Series: PUF 1.8001.0214
11 * 4-Series: PUF 2.8003.00037.01
12 * VC-4: 4.0003.00016
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)
18 )))
19
20 {{box cssClass="floatinginfobox" title="**CONTENTS**"}}
21 {{toc/}}
22 {{/box}}
23
24 **ShowRunnerCLC™ Installation Tutorial:**
25
26 [[https:~~/~~/www.youtube.com/watch?v=xuJ94cMCCa8>>url:https://www.youtube.com/watch?v=xuJ94cMCCa8]]
27
28 **Licensing tutorial:**
29
30 //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.//
31
32 [[https:~~/~~/www.youtube.com/watch?v=H8CLZ7bp0eI>>url:https://www.youtube.com/watch?v=H8CLZ7bp0eI]]
33
34 = Error Broadcasting =
35
36 The first thing that should be done after connecting to a processor is to open the Text Console and run the command: ##broadcast on##
37
38 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:
39
40 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.
41 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.
42 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)
43
44 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.
45
46 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.
47
48 = IP Configuration =
49
50 * Connect to the processor via USB and set the processor’s IP Address per your network requirements
51 ** 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
52 *** 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
53 *** In the event that the processor does not allow you to log in with the chosen credentials (i.e. it repeatedly prompts for credentials)
54 **** Attempt to log in with username "crestron" and no password
55 **** Once logged into Text Console, run the following commands, replacing the "username" and "password" with your desired credentials
56 ***** ##adduser -N:username -P:password##
57 ***** ##addusertogroup -N:username -G:Administrators##
58 ** 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**(%%))
59 *** Disable DHCP: ##dhcp 0 off##
60 *** Set IP address: ##ipa 0 (% style="color:blue" %)**10.0.0.10**(%%)##
61 *** Set IP subnet mask: ##ipm 0 (% style="color:darkgoldenrod" %)**255.255.255.0**(%%)##
62 *** Set default gateway: ##defr 0 **10.0.0.1**##
63 *** Set hostname: ##host AP3-CPP##
64 *** Reboot the processor: ##reboot##
65 ** It is also possible to configure a processor over Ethernet by using a DHCP server software on your laptop to assign an IP address
66 *** Configure your DHCP server software to assign IP addresses in the desired range
67 *** Once the processor is assigned an IP address, connect to it via Text Console at the assigned IP address
68 *** Run the above commands to disable DHCP and assign a static IP address to the processor
69 * For processors with a Control Subnet (CP3N/AV3/PRO3/CP4N/AV4/PRO4), there are some additional considerations and setup that must be performed: 
70 ** Never connect an external router to the Control Subnet, as doing so will cause the internal DHCP server to shut down.
71 ** Connect to the processor via Text Console and run the command: ##startprogafterrouter on##
72 *** 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.
73 *** ShowRunnerCLC™ .puf versions 3.042 and newer automatically run this command when the "Configure Processor with Router" option is selected.
74 ** 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.
75 ** Lighting control hardware (e.g. TSWs, DIN-CENCN-2s, etc.) should be left in DHCP mode and connected to the Control Subnet port.
76 *** The processor acts as a DHCP server on the Control Subnet, with addresses that are determined automatically based on the LAN configuration.
77 *** If lighting hardware is to be connected via the LAN anyway, then you must run the command: ##securegateway default##
78 *** 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
79 ** 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:
80 *** Using the "Functions>Ethernet Addressing...>Control Subnet" menu of Toolbox:
81 **** Set routing to "Manual" with the start address and subnet size
82 **** 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
83 *** Using Text Console commands (example for a **100.64.0.0/20** subnet, with a processor IP address of **100.64.0.1**)
84 **** Set CS IP: ##csrouterprefix **100.64.0.0/20**##
85 **** Reboot the processor: ##reboot##
86 * If the job has multiple processors, then these steps must be repeated for all processors on the job
87 ** For jobs with Central Control, the IP addresses of the processors matters
88 ** 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
89 ** 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
90 * 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]]
91
92 = Program Load =
93
94 * Download the latest build of ShowRunnerCLC™ from the[[ Chief Integrations Portal>>https://files.chiefintegrations.com/index.php/s/WHNzXrrZbB5jC3E]]
95 * 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
96 ** 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
97 * Double click the PUF to open the Package Update Tool and install ShowRunnerCLC™ (works best with Toolbox closed)
98 ** The Package Update Tool will automatically open your Address Book and prompt you to select a device
99 *** If you have not created an Address Book for this job, close the Address Book window and press the pencil icon
100 *** Type in the IP address of your processor and click "OK"
101 ** Double check that the correct PUF file is listed under the "Package Info" section and that the correct IP address is listed under "Target"
102 ** Press the "Recheck" button
103 ** Make sure that all three tasks are selected ("Load ShowRunner Program", "Update Crestron App", and "Update XPanel")
104 ** Additional tasks are available for certain processors:
105 *** ZUM-HUB4:
106 **** "Configure ZUM-HUB4" will automatically run commands: ##cwsanticsrf OFF## and ##startprogafterrouter on##
107 **** "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
108 ***** **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.**
109 **** "Configure ZUM-HUB4 SecureGateway" will automatically run command: ##securegateway default##
110 *** Processors with Routers (AV3, CP3N, PRO3, AV4, CP4N, and PRO4)
111 **** "Configure Processor with Router" will automatically run command: ##startprogafterrouter on##
112 ** Press the "Update" button to begin loading ShowRunnerCLC™
113 * Sometimes the PUF tool will falsely report a failure to load the program
114 ** Connect to the processor via Text Console
115 ** Run the command ##sr ver##
116 ** If the console returns with the newly installed version of ShowRunnerCLC™, then the installation was successful
117 ** If the console returns with "Bad or Incomplete Command (sr)" then the installation was not successful
118 *** Rename the downloaded .puf file to be a .zip file and open the archive
119 **** Some file archivers (such as 7-Zip) allow you to right click on the PUF file and open the archive without changing the filetype
120 *** Extract the "CI.Lighting.ShowRunner.cpz" file
121 *** In Toolbox, connect to the processor via Text Console, click the lightning bolt icon, and select "SIMPL Program..."
122 **** Alternatively, navigate to Functions>SIMPL Program...>SIMPL Program (Program01)...
123 *** Under the "Send Program" section, browse your PC and select the extracted .cpz file
124 *** Click the "Send" button and click "Yes" to upload the program
125 *** Once it is done loading, you should be able to run the ##sr ver## command and see the currently installed version of ShowRunnerCLC™
126 * 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.  
127 ** **3-Series processors require authentication enabled** ("##ssl self##" command followed by a reboot can be used but steps will need to be repeated)
128 ** If stuck on "Connecting to Processor" you will need to accept the certificate
129 * For jobs with multiple processors, ShowRunnerCLC™ will need to be loaded to each processor
130
131 = License and Configuration Deployment =
132
133 * Download the SrConfig.json or CiLightingConfig.json configuration file from the link provided by Chief Integrations
134 * Obtain and download the license from [[https:~~/~~/portal.chiefintegrations.com>>url:https://portal.chiefintegrations.com]]
135 ** Processors with a Control Subnet should use the LAN MAC address, **not** the Control Subnet MAC address
136 * The license and configuration can be loaded with Toolbox using Text Console and File Management, or through the ShowRunnerHUB™ web interface
137 ** Using Toolbox:
138 *** Connect to the processor via Text Console and via File Management
139 *** In File management, navigate to the "NVRAM>sr" folder from the left-hand menu
140 *** Right-click on the right-hand side and select "Copy File(s) From..." and select the downloaded License.lic file
141 **** Alternatively, drag and drop the file from your computer to the File Management tool
142 *** Using the left-hand menu, navigate to the "NVRAM>sr>default" folder
143 *** Right-click on the right-hand side and select "Copy File(s) From..." and select the downloaded SrConfig.json file
144 **** Alternatively, drag and drop the file from your computer to the File Management tool
145 **** If you downloaded a CiLightingConfig.json file, it must be renamed to "SrConfig.json"
146 *** Note: when loading the license and configuration through Toolbox, the "License.lic" file and "SrConfig.json" file must have exact filenames
147 **** 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
148 ** Using the ShowRunnerHUB™ UI:
149 *** Using Chrome or Firefox, navigate to the processor's IP address
150 *** When prompted, input your credentials and log in
151 **** 4-Series processor or 3-Series processor with authentication enabled: Log in using the same admin credentials used to connect to the processor
152 **** 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.
153 ***** ##sradmin add user **username **"**name**" Administrators **password**##
154 ***** The username and password should be one word each and are the credentials used to log in to the ShowRunnerHUB™
155 ***** The name can be multiple words as long as it is in quotes, and is simply a friendly name used to identify each user
156 *** Once logged in to the ShowRunnerHUB™ UI, you should be automatically redirected to the File Management page
157 **** 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
158 **** [[image:1654807593390-193.png]]
159 **** Under “Upload New License File”
160 ***** Leave "Restart after transfer" unchecked
161 ***** Select “Choose File” and browse for the license file you downloaded from the portal
162 ***** Select “Upload”
163 **** Load the configuration file either directly (if you have an SrConfig.json file) or from a backup (if you have an SRBackup.zip)
164 ***** Direct upload:
165 ****** Under “Upload New Config File”
166 ****** 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.
167 ****** Select “Upload”
168 ***** From a Backup:
169 ****** Select "Restore"
170 ****** Select "Choose Backup" and find the SRBackup.zip of the backup you wish to restore
171 ****** Enter the secret used to create the backup. ShowRunner will upload the file and verify the secret.
172 **** Once both the license and either a configuration file or backup have been loaded, click "Restart"
173 **** Wait for the processor to finish restarting and then reload the page.
174 ***** 3-Series processors will take 45 to 90 seconds to restart, possibly longer depending on the size and complexity of the configuration
175 ***** 4-Series processors will restart considerably faster
176 **** 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]]
177 **** 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]]
178
179 = Set System Time =
180
181 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:
182
183 * Connect to the processor via Text Console
184 * At the top of the Toolbox window, navigate to Functions>System Clock...
185 * If your computer is in the correct timezone, click Synchronize Device Time with PC
186 ** The Timezone and Device Time should synchronize automatically
187 ** If your PC is in the incorrect Timezone or the time did not synchronize properly, then manually adjust the Time, Date, and Timezone
188 * Press the Apply button
189
190 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
191
192 * ShowRunnerCLC™ XPanel UI:
193 ** Navigate to Settings>Location and System Clock
194 ** Press the Lock icon to enable editing
195 ** Adjust the time, timezone, and location as necessary
196 ** Press Set System Clock to save the changes
197 * ShowRunnerHUB™ Web UI:
198 ** Navigate to Setup>System Settings>Location and System Clock
199 ** Adjust the time, timezone, and location as necessary
200 ** Click Apply to save the changes

Navigation