Skip to Content

Changes for page Processor Setup

Last modified by Alexander Mott on 2024/12/02 19:04
From version 6.1
edited by Alexander Mott
on 2022/06/09 20:46
Change comment: Uploaded new attachment "1654807593390-193.png", version {1}
To version 23.1
edited by Alexander Mott
on 2022/06/30 16:52
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 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]].
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
... ... @@ -23,11 +23,10 @@
23 23  
24 24  [[https:~~/~~/www.youtube.com/watch?v=H8CLZ7bp0eI>>url:https://www.youtube.com/watch?v=H8CLZ7bp0eI]]
25 25  
26 -=== IP Configuration and Program Load (Per Processor) ===
31 +=== IP Configuration ===
27 27  
28 -* Obtain the latest build of SHOWRUNNER™ [[https:~~/~~/files.chiefintegrations.com/s/WHNzXrrZbB5jC3E>>url:https://files.chiefintegrations.com/s/WHNzXrrZbB5jC3E]]
29 29  * Connect to the processor via USB and set the processor’s IP Address per your network requirements
30 -** 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
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
31 31  *** 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
32 32  *** In the event that the processor does not allow you to log in with the chosen credentials (i.e. it repeatedly prompts for credentials)
33 33  **** Attempt to log in with username "crestron" and no password
... ... @@ -34,12 +34,13 @@
34 34  **** Once logged into Text Console, run the following commands, replacing the "username" and "password" with your desired credentials
35 35  ***** ##adduser -N:username -P:password##
36 36  ***** ##addusertogroup -N:username -G:Administrators##
37 -** 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/24 subnet, with a processor IP address of 10.0.0.10)
41 +** 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**(%%))
38 38  *** Disable DHCP: ##dhcp 0 off##
39 -*** Set IP address: ##ipa 0 10.0.0.10##
40 -*** Set IP subnet mask: ##ipm 0 255.255.255.0##
41 -*** Set default gateway: ##defr 0 10.0.0.1##
43 +*** Set IP address: ##ipa 0 (% style="color:blue" %)**10.0.0.10**(%%)##
44 +*** Set IP subnet mask: ##ipm 0 (% style="color:darkgoldenrod" %)**255.255.255.0**(%%)##
45 +*** Set default gateway: ##defr 0 **10.0.0.1**##
42 42  *** Set hostname: ##host AP3-CPP##
47 +*** Reboot the processor: ##reboot##
43 43  ** It is also possible to configure a processor over Ethernet by using a DHCP server software on your laptop to assign an IP address
44 44  *** Configure your DHCP server software to assign IP addresses in the desired range
45 45  *** Once the processor is assigned an IP address, connect to it via Text Console at the assigned IP address
... ... @@ -52,44 +52,106 @@
52 52  ** The Control Subnet can be configured manually in the "Functions>Ethernet Addressing...>Control Subnet" menu of Toolbox
53 53  *** Set routing to "Manual" with the start address and subnet size
54 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##
56 -* 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.
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 +* If the job has multiple processors, then these steps must be repeated for all processors on the job
62 +** For jobs with Central Control, the IP addresses of the processors matters
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 +** 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 +
66 +=== Program Load ===
67 +
68 +* Download the latest build of SHOWRUNNER™ from the[[ Chief Integrations Portal>>https://files.chiefintegrations.com/index.php/s/WHNzXrrZbB5jC3E]]
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 +** 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
57 57  * Double click the PUF to open the Package Update Tool and install SHOWRUNNER™ (works best with Toolbox closed)
58 -** The Package Update Tool will automatically open your Address Book
59 -* Select the PUF file again if needed, connect to the processor using the pencil, and select Recheck (This verifies the need to install the program, the XPanel UI, and the Crestron App UI)
60 -* Click Update when prompted to install ShowRunner
61 -* After loading, you can connect to the UI by navigating to the processor’s IP.  
62 -** **3-Series processors require authentication enabled** (SSL self can be used but steps will need to be repeated).
63 -** If stuck on "Connecting to Processor" you will need to accept the certificate.
64 -* Showrunner™ will be loaded but a configuration and license are still needed.  Please proceed with the next section.
72 +** The Package Update Tool will automatically open your Address Book and prompt you to select a device
73 +*** If you have not created an Address Book for this job, close the Address Book window and press the pencil icon
74 +*** Type in the IP address of your processor and click "OK"
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 +** Press the "Recheck" button
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™
79 +* Sometimes the PUF tool will falsely report a failure to load the program
80 +** Connect to the processor via Text Console
81 +** Run the command ##sr ver##
82 +** If the console returns with the newly installed version of SHOWRUNNER™, then the installation was successful
83 +** If the console returns with "Bad or Incomplete Command (sr)" then the installation was not successful
84 +*** Rename the downloaded .puf file to be a .zip file and open the archive
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 +*** 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 +**** Alternatively, navigate to Functions>SIMPL Program...>SIMPL Program (Program01)...
89 +*** Under the "Send Program" section, browse your PC and select the extracted .cpz file
90 +*** Click the "Send" button and click "Yes" to upload the program
91 +*** Once it is done loading, you should be able to run the ##sr ver## command and see the currently installed version of SHOWRUNNER™
92 +* 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.  
93 +** **3-Series processors require authentication enabled** (SSL self can be used but steps will need to be repeated)
94 +** If stuck on "Connecting to Processor" you will need to accept the certificate
95 +* For jobs with multiple processors, SHOWRUNNER™ will need to be loaded to each processor
65 65  
66 66  === License and Configuration Deployment ===
67 67  
68 -* Download the configuration file from the link provided by Chief Integrations
99 +* Download the SrConfig.json or CiLightingConfig.json configuration file from the link provided by Chief Integrations
69 69  * Obtain and download the license from [[https:~~/~~/portal.chiefintegrations.com>>url:https://portal.chiefintegrations.com]]
70 70  ** Processors with a Control Subnet should use the LAN MAC address, **not** the Control Subnet MAC address
71 -* Navigate to the showrunner™ management page
72 -* Login to the showrunnerHUB™
73 -** 4-Series processor: The login created by the processor will work
74 -** 3-Series processor: Using Toolbox Text Console - type "sradmin [username] [name] administrators [password]"  (not needed if processor authentication is setup)
75 -* Click Setup then File Management
76 -** [[image:MicrosoftTeams-image7c355557d0a3ae410e72498ee667de2df50226f3e3940c2df4b51bb7137e176b.png||height="240" width="250"]]
77 -** Under “Upload New License File”
78 -*** Leave restart unchecked after transfer
79 -*** Select “Choose File” find the license file you downloaded from the portal
80 -*** Select “Upload”
81 -** Loading Configuration
82 -*** From Configuration File
83 -**** Under “Upload New Config File”
84 -***** Select “Choose File” and find the provided SrConfig.json for this processor from the project link that was sent at project delivery.
102 +* The license and configuration can be loaded with Toolbox using Text Console and File Management, or through the showrunnerHUB™ web interface
103 +** Using Toolbox:
104 +*** Connect to the processor via Text Console and via File Management
105 +*** In File management, navigate to the "NVRAM>sr" folder from the left-hand menu
106 +*** Right-click on the right-hand side and select "Copy File(s) From..." and select the downloaded License.lic file
107 +**** Alternatively, drag and drop the file from your computer to the File Management tool
108 +*** Using the left-hand menu, navigate to the "NVRAM>sr>default" folder
109 +*** Right-click on the right-hand side and select "Copy File(s) From..." and select the downloaded SrConfig.json file
110 +**** Alternatively, drag and drop the file from your computer to the File Management tool
111 +**** If you downloaded a CiLightingConfig.json file, it must be renamed to "SrConfig.json"
112 +** Using the showrunnerHUB™ UI:
113 +*** Using Chrome or Firefox, navigate to the processor's IP address
114 +*** When prompted, input your credentials and log in
115 +**** 4-Series processor or 3-Series processor with authentication enabled: Log in using the same admin credentials used to connect to the processor
116 +**** 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.
117 +***** ##sradmin username "name" administrators password##
118 +***** The username and password should be one word each and are the credentials used to log in to the showrunnerHUB™
119 +***** The name can be multiple words as long as it is in quotes, and is simply a friendly name used to identify each user.
120 +*** Once logged in to the showrunnerHUB™ UI, you should be automatically redirected to the File Management page
121 +**** 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
122 +**** [[image:1654807593390-193.png]]
123 +**** Under “Upload New License File”
124 +***** Leave "Restart after transfer" unchecked
125 +***** Select “Choose File” and browse for the license file you downloaded from the portal
85 85  ***** Select “Upload”
86 -***** Alternatively, you can drop the License.lic using Toolbox’s File Manager or your SFTP client into the NVRAM/sr folder of the processor, the SrConfig.json into NVRAM/sr/default and perform “progreset” from the processor’s console
87 -***** The program will restart
88 -*** From Backup
89 -**** Select "Restore"
90 -**** Select "Choose Backup" and find the "SRBackup.zip" of the backup you wish to restore
91 -**** Enter the secret used to create the backup.  Showrunner will upload the file and verify the secret.
92 -**** Select "Restart" to load the new configuration
93 -** Wait about 45 seconds after loading the configuration for the program to restart completely(((
94 -
95 -)))
127 +**** Load the configuration file either directly (if you have an SrConfig.json file) or from a backup (if you have an SRBackup.zip)
128 +***** Direct upload:
129 +****** Under “Upload New Config File”
130 +****** 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.
131 +****** Select “Upload”
132 +***** From a Backup:
133 +****** Select "Restore"
134 +****** Select "Choose Backup" and find the SRBackup.zip of the backup you wish to restore
135 +****** Enter the secret used to create the backup. ShowRunner will upload the file and verify the secret.
136 +**** Once both the license and either a configuration file or backup have been loaded, click "Restart"
137 +**** Wait for the processor to finish restarting and then reload the page.
138 +***** 3-Series processors will take 45 to 90 restart
139 +***** 4-Series processors should restart considerably faster
140 +
141 +=== Set System Time ===
142 +
143 +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:
144 +
145 +* Connect to the processor via Text Console
146 +* At the top of the Toolbox window, navigate to Functions>System Clock...
147 +* If your computer is in the correct timezone, click Synchronize Device Time with PC
148 +** The Timezone and Device Time should synchronize automatically
149 +** If your PC is in the incorrect Timezone or the time did not synchronize properly, then manually adjust the Time, Date, and Timezone
150 +* Press the Apply button
151 +
152 +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
153 +
154 +* SHOWRUNNER™ XPanel UI:
155 +** Navigate to Settings>Location and System Clock
156 +** Press the Lock icon to enable editing
157 +** Adjust the time, timezone, and location as necessary
158 +** Press Set System Clock to save the changes
159 +* showrunnerHUB™ Web UI:
160 +** Navigate to Setup>System Settings>Location and System Clock
161 +** Adjust the time, timezone, and location as necessary
162 +** Click Apply to save the changes