Skip to Content

Changes for page Processor Setup

Last modified by Alexander Mott on 2024/12/02 19:04
From version 37.1
edited by Alexander Mott
on 2022/10/19 18:04
Change comment: There is no comment for this version
To version 51.1
edited by Alexander Mott
on 2024/03/27 15:23
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -5,11 +5,11 @@
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.**
8 +ShowRunnerCLC™™ is tested against current Crestron firmware releases. **Please use at least the recommended firmware builds.**
9 9  
10 -* 3-Series: PUF 1.8001.0146
11 -* 4-Series: PUF 2.7000.00052.01
12 -* VC-4: 2.7000.00047
10 +* 3-Series: PUF 1.8001.0214
11 +* 4-Series: PUF 2.8003.00037.01
12 +* VC-4: 4.0003.00016
13 13  
14 14  **Notes:**
15 15  
... ... @@ -21,9 +21,7 @@
21 21  {{toc/}}
22 22  {{/box}}
23 23  
24 -(% class="row" %)
25 -(((
26 -**ShowRunner Installation Tutorial:**
24 +**ShowRunnerCLC™ Installation Tutorial:**
27 27  
28 28  [[https:~~/~~/www.youtube.com/watch?v=xuJ94cMCCa8>>url:https://www.youtube.com/watch?v=xuJ94cMCCa8]]
29 29  
... ... @@ -33,6 +33,20 @@
33 33  
34 34  [[https:~~/~~/www.youtube.com/watch?v=H8CLZ7bp0eI>>url:https://www.youtube.com/watch?v=H8CLZ7bp0eI]]
35 35  
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 +
36 36  = IP Configuration =
37 37  
38 38  * Connect to the processor via USB and set the processor’s IP Address per your network requirements
... ... @@ -54,13 +54,17 @@
54 54  *** Configure your DHCP server software to assign IP addresses in the desired range
55 55  *** Once the processor is assigned an IP address, connect to it via Text Console at the assigned IP address
56 56  *** Run the above commands to disable DHCP and assign a static IP address to the processor
57 -* For processors with a Control Subnet (CP3N/AV3/PRO3/CP4N/AV4/PRO4), additional setup is required
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.
58 58  ** Connect to the processor via Text Console and run the command: ##startprogafterrouter on##
59 -*** 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.
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 include this command in the "Configure Processor with Router" option.**
60 60  ** 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.
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:
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:
64 64  *** Using the "Functions>Ethernet Addressing...>Control Subnet" menu of Toolbox:
65 65  **** Set routing to "Manual" with the start address and subnet size
66 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
... ... @@ -71,13 +71,14 @@
71 71  ** For jobs with Central Control, the IP addresses of the processors matters
72 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 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
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]]
74 74  
75 75  = Program Load =
76 76  
77 -* Download the latest build of SHOWRUNNER™ from the[[ Chief Integrations Portal>>https://files.chiefintegrations.com/index.php/s/WHNzXrrZbB5jC3E]]
94 +* Download the latest build of ShowRunnerCLC™ from the[[ Chief Integrations Portal>>https://files.chiefintegrations.com/index.php/s/WHNzXrrZbB5jC3E]]
78 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 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)
97 +* Double click the PUF to open the Package Update Tool and install ShowRunnerCLC™ (works best with Toolbox closed)
81 81  ** The Package Update Tool will automatically open your Address Book and prompt you to select a device
82 82  *** If you have not created an Address Book for this job, close the Address Book window and press the pencil icon
83 83  *** Type in the IP address of your processor and click "OK"
... ... @@ -84,11 +84,11 @@
84 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 85  ** Press the "Recheck" button
86 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™
104 +** Press the "Update" button to begin loading ShowRunnerCLC™
88 88  * Sometimes the PUF tool will falsely report a failure to load the program
89 89  ** Connect to the processor via Text Console
90 90  ** Run the command ##sr ver##
91 -** If the console returns with the newly installed version of SHOWRUNNER™, then the installation was successful
108 +** If the console returns with the newly installed version of ShowRunnerCLC™, then the installation was successful
92 92  ** If the console returns with "Bad or Incomplete Command (sr)" then the installation was not successful
93 93  *** Rename the downloaded .puf file to be a .zip file and open the archive
94 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
... ... @@ -97,11 +97,11 @@
97 97  **** Alternatively, navigate to Functions>SIMPL Program...>SIMPL Program (Program01)...
98 98  *** Under the "Send Program" section, browse your PC and select the extracted .cpz file
99 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.  
117 +*** Once it is done loading, you should be able to run the ##sr ver## command and see the currently installed version of ShowRunnerCLC™
118 +* 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 102  ** **3-Series processors require authentication enabled** ("##ssl self##" command followed by a reboot can be used but steps will need to be repeated)
103 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
121 +* For jobs with multiple processors, ShowRunnerCLC™ will need to be loaded to each processor
105 105  
106 106  = License and Configuration Deployment =
107 107  
... ... @@ -108,7 +108,7 @@
108 108  * Download the SrConfig.json or CiLightingConfig.json configuration file from the link provided by Chief Integrations
109 109  * Obtain and download the license from [[https:~~/~~/portal.chiefintegrations.com>>url:https://portal.chiefintegrations.com]]
110 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
128 +* The license and configuration can be loaded with Toolbox using Text Console and File Management, or through the ShowRunnerHUB™ web interface
112 112  ** Using Toolbox:
113 113  *** Connect to the processor via Text Console and via File Management
114 114  *** In File management, navigate to the "NVRAM>sr" folder from the left-hand menu
... ... @@ -118,15 +118,17 @@
118 118  *** Right-click on the right-hand side and select "Copy File(s) From..." and select the downloaded SrConfig.json file
119 119  **** Alternatively, drag and drop the file from your computer to the File Management tool
120 120  **** If you downloaded a CiLightingConfig.json file, it must be renamed to "SrConfig.json"
121 -** Using the showrunnerHUB™ UI:
138 +*** Note: when loading the license and configuration through Toolbox, the "License.lic" file and "SrConfig.json" file must have exact filenames
139 +**** 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
140 +** Using the ShowRunnerHUB™ UI:
122 122  *** Using Chrome or Firefox, navigate to the processor's IP address
123 123  *** When prompted, input your credentials and log in
124 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 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
145 +***** ##sradmin add user **username **"**name**" Administrators **password**##
146 +***** The username and password should be one word each and are the credentials used to log in to the ShowRunnerHUB™
147 +***** The name can be multiple words as long as it is in quotes, and is simply a friendly name used to identify each user
148 +*** Once logged in to the ShowRunnerHUB™ UI, you should be automatically redirected to the File Management page
130 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 131  **** [[image:1654807593390-193.png]]
132 132  **** Under “Upload New License File”
... ... @@ -144,8 +144,10 @@
144 144  ****** Enter the secret used to create the backup. ShowRunner will upload the file and verify the secret.
145 145  **** Once both the license and either a configuration file or backup have been loaded, click "Restart"
146 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
166 +***** 3-Series processors will take 45 to 90 seconds to restart, possibly longer depending on the size and complexity of the configuration
167 +***** 4-Series processors will restart considerably faster
168 +**** 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]]
169 +**** 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]]
149 149  
150 150  = Set System Time =
151 151  
... ... @@ -158,15 +158,14 @@
158 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 159  * Press the Apply button
160 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
182 +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
162 162  
163 -* SHOWRUNNER™ XPanel UI:
184 +* ShowRunnerCLC™ XPanel UI:
164 164  ** Navigate to Settings>Location and System Clock
165 165  ** Press the Lock icon to enable editing
166 166  ** Adjust the time, timezone, and location as necessary
167 167  ** Press Set System Clock to save the changes
168 -* showrunnerHUB™ Web UI:
189 +* ShowRunnerHUB™ Web UI:
169 169  ** Navigate to Setup>System Settings>Location and System Clock
170 170  ** Adjust the time, timezone, and location as necessary
171 171  ** Click Apply to save the changes
172 -)))