Skip to Content

Changes for page ZUM-HUB4 Processor Setup

Last modified by Craig Lewis on 2025/03/13 15:50
From version 1.1
edited by Alexander Mott
on 2022/06/30 15:30
Change comment: There is no comment for this version
To version 18.1
edited by Alexander Mott
on 2022/09/17 00:25
Change comment: There is no comment for this version

Summary

Details

Page properties
Hidden
... ... @@ -1,1 +1,1 @@
1 -true
1 +false
Content
... ... @@ -1,19 +1,18 @@
1 -(% class="box warningmessage" %)
1 +(% class="box errormessage" %)
2 2  (((
3 -ZUM-HUB4 requires firmware version 2.005.0056 or greater for third party software to be loaded.
3 +This page is for ZUM-HUB4 deployments. For other processors, see our [[normal processor setup page>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Processor Setup.WebHome]].
4 4  )))
5 5  
6 -(% class="box infomessage" id="HNotes" %)
6 +(% class="box warningmessage" %)
7 7  (((
8 -Notes
9 -Static IP or properly setup DHCP/DNS implementation required.
10 -Auto-Assigned/Link-Local IP address range of 169.254.x.x not supported (Crestron xPanel issue)
8 +ZUM-HUB4 requires firmware version 2.005.0056 or greater for third party software to be loaded.
9 +(Once installed, running the "##ver##" command should report a FW version of 2.7100.00016 or greater.)
11 11  )))
12 12  
13 -**ShowRunner Installation Tutorial:**
12 +{{box title="**CONTENTS**"}}
13 +{{toc/}}
14 +{{/box}}
14 14  
15 -[[https:~~/~~/www.youtube.com/watch?v=xuJ94cMCCa8>>url:https://www.youtube.com/watch?v=xuJ94cMCCa8]]
16 -
17 17  **Licensing tutorial:**
18 18  
19 19  //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.//
... ... @@ -20,134 +20,95 @@
20 20  
21 21  [[https:~~/~~/www.youtube.com/watch?v=H8CLZ7bp0eI>>url:https://www.youtube.com/watch?v=H8CLZ7bp0eI]]
22 22  
23 -=== IP Configuration ===
22 += IP Configuration and Console Commands =
24 24  
25 -* Connect to the processor via USB and set the processor’s IP Address per your network requirements
26 -** 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
27 -*** 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
28 -*** In the event that the processor does not allow you to log in with the chosen credentials (i.e. it repeatedly prompts for credentials)
29 -**** Attempt to log in with username "crestron" and no password
30 -**** Once logged into Text Console, run the following commands, replacing the "username" and "password" with your desired credentials
31 -***** ##adduser -N:username -P:password##
32 -***** ##addusertogroup -N:username -G:Administrators##
33 -** 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**(%%))
34 -*** Disable DHCP: ##dhcp 0 off##
35 -*** Set IP address: ##ipa 0 (% style="color:blue" %)**10.0.0.10**(%%)##
36 -*** Set IP subnet mask: ##ipm 0 (% style="color:darkgoldenrod" %)**255.255.255.0**(%%)##
37 -*** Set default gateway: ##defr 0 **10.0.0.1**##
38 -*** Set hostname: ##host AP3-CPP##
39 -*** Reboot the processor: ##reboot##
40 -** It is also possible to configure a processor over Ethernet by using a DHCP server software on your laptop to assign an IP address
41 -*** Configure your DHCP server software to assign IP addresses in the desired range
42 -*** Once the processor is assigned an IP address, connect to it via Text Console at the assigned IP address
43 -*** Run the above commands to disable DHCP and assign a static IP address to the processor
44 -* For processors with a Control Subnet (CP3N/AV3/PRO3/CP4N/AV4/PRO4/ZUM-HUB4), additional setup is required
45 -** Connect to the processor via Text Console and run the command: ##startprogafterrouter on##
46 -*** 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.
47 -** 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.
48 -** 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.
49 -** The Control Subnet can be configured manually in the "Functions>Ethernet Addressing...>Control Subnet" menu of Toolbox
50 -*** Set routing to "Manual" with the start address and subnet size
51 -*** 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
52 -** 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**##
53 -* If the job has multiple processors, then these steps must be repeated for all processors on the job
54 -** For jobs with Central Control, the IP addresses of the processors matters
55 -** 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
56 -** 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
24 +* Connect to the ZUM-HUB4 via USB and create an admin-level CWS user
25 +** 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
26 +** In the event that the processor does not allow you to log in with the chosen credentials (i.e. it repeatedly prompts for credentials)
27 +*** Attempt to log in with username "crestron" and no password
28 +*** Once logged into Text Console, run the following commands, replacing the "username" and "password" with your desired credentials
29 +**** ##adduser -N:username -P:password##
30 +**** ##addusertogroup -N:username -G:Administrators##
31 +* Determine whether the lighting control hardware will be connected to the ZUM-HUB4's LAN port or the Control Subnet port:
32 +** If the system is standalone (not integrated with building LAN), then lighting hardware can be connected to either the LAN port or the Control Subnet port:
33 +*** If connecting lighting hardware to the LAN port, then you must configure the LAN as a static IP (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**(%%)):
34 +**** Disable DHCP: ##dhcp 0 off##
35 +**** Set IP address: ##ipa 0 (% style="color:blue" %)**10.0.0.10**(%%)##
36 +**** Set IP subnet mask: ##ipm 0 (% style="color:darkgoldenrod" %)**255.255.255.0**(%%)##
37 +**** Set default gateway: ##defr 0 **10.0.0.1**##
38 +**** Set hostname: ##host HUB4-CPP##
39 +**** If ZUMNET-JBOXs will be connected via the LAN port, set secure gateway: ##securegateway default ##
40 +***** (Note: this setting defines whether or not a secure connection is required on the LAN side of the control processor for Crestron devices)
41 +**** Reboot the processor: ##reboot##
42 +*** If connecting lighting hardware to the Control Subnet port, then you may optionally configure the Control Subnet. If manually configuring the control subnet, we recommend the following IP range as it won't conflict with corporate networks:
43 +**** Using the "Functions>Ethernet Addressing...>Control Subnet" menu of Toolbox:
44 +***** Set routing to "Manual" with the start address and subnet size
45 +***** 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
46 +**** Using Text Console commands (example for a **100.64.0.0(% style="color:darkgoldenrod" %)/20(%%)** subnet, with a processor IP address of (% style="color:blue" %)**100.64.0.1**(%%))
47 +***** Set CS IP: ##csrouterprefix **100.64.0.0/20**##
48 +***** Reboot the processor: ##reboot##
49 +** If the system is intended to connect to the building LAN:
50 +*** The building LAN must be connected to ZUM-HUB4's LAN port
51 +*** The ZUM-HUB4's LAN IP settings should be configured per the building requirements
52 +*** Any connected lighting hardware must either:
53 +***1. Be on the building LAN
54 +***1*. The ZUM-HUB4 LAN should be configured with a static IP or DHCP reservation
55 +***1*. Building network must be configured to allow communication between ZUM-HUB4 and all lighting devices
56 +***1*. This requires: ##securegateway default##
57 +***1. Be connected to the Control Subnet port
58 +***1*. Control Subnet must be configured correctly (see above)
59 +***1*. If lighting devices must be able to communicate with the building LAN, run the command: ##isolatenetworks off##
60 +* Once IP settings are configured, there are additional commands that must be run:
61 +** Disable CWS Anticsrf feature (case sensitive): ##cwsanticsrf OFF##
62 +** Force waiting to start program: ##startprogafterrouter on##
63 +** Reboot the processor: ##reboot##
57 57  
58 -=== Program Load ===
65 += Update NVRAM Folder Permissions =
59 59  
60 -* Download the latest build of SHOWRUNNER™ from the[[ Chief Integrations Portal>>https://files.chiefintegrations.com/index.php/s/WHNzXrrZbB5jC3E]]
67 +* Ensure that the NVRAM folder permissions are set correctly using a third party SFTP program:
68 +** FileZilla instructions ([[video example>>attach:FileZilla HUB4 NVRAM Permissions Change.mp4]]):
69 +*** Connect to the processor at port 22
70 +*** Locate the "nvram" folder
71 +*** Right click the folder and select "Change File Attributes"
72 +*** Change "Numeric Value" to 777
73 +*** Disconnect from the processor
74 +** WinSCP instructions:
75 +*** Connect to the processor at port 22
76 +*** Locate the "nvram" folder
77 +*** Right click the folder and select "Properties"
78 +*** Change "Octal Value" to 2777
79 +*** Disconnect from the processor
80 +
81 += Crestron License Generation =
82 +
61 61  * 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
62 -** 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
63 -* Double click the PUF to open the Package Update Tool and install SHOWRUNNER™ (works best with Toolbox closed)
64 -** The Package Update Tool will automatically open your Address Book and prompt you to select a device
65 -*** If you have not created an Address Book for this job, close the Address Book window and press the pencil icon
66 -*** Type in the IP address of your processor and click "OK"
67 -** Double check that the correct PUF file is listed under the "Package Info" section and that the correct IP address is listed under "Target"
68 -** Press the "Recheck" button
69 -** Make sure that all three tasks are selected ("Load ShowRunner Program", "Update Crestron App", and "Update XPanel")
70 -** Press the "Update" button to begin loading SHOWRUNNER™
71 -* Sometimes the PUF tool will falsely report a failure to load the program
72 -** Connect to the processor via Text Console
73 -** Run the command ##sr ver##
74 -** If the console returns with the newly installed version of SHOWRUNNER™, then the installation was successful
75 -** If the console returns with "Bad or Incomplete Command (sr)" then the installation was not successful
76 -*** Rename the .puf file to be a .zip file and open the archive
77 -**** Some file archivers (such as 7-Zip) allow you to right click on the PUF file and open the archive without changing the filetype
78 -*** Extract the "CI.Lighting.ShowRunner.cpz" file
79 -*** In Toolbox, connect to the processor via Text Console and click the lightning bolt icon and select "SIMPL Program..."
80 -*** Under the "Send" section, browse your PC and select the extracted .cpz file
81 -*** Click the "Send" button and click "Yes" to upload the program
82 -*** Once it is done loading, you should be able to run the ##sr ver## command and see the currently installed version of SHOWRUNNER™
83 -* 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.  
84 -** **3-Series processors require authentication enabled** (SSL self can be used but steps will need to be repeated)
85 -** If stuck on "Connecting to Processor" you will need to accept the certificate
86 -* For jobs with multiple processors, SHOWRUNNER™ will need to be loaded to each processor
84 +* Connect to the ZUM-HUB4 in Crestron Toolbox
85 +** Run the "##ver##" and verify that the reported firmware is v2.7100.00016 or greater
86 +** Navigate to Functions>License Management...>Add License
87 +** Open [[Crestron's SW-HUB4-PROG licensing form>>https://app.smartsheet.com/b/form/e06b27d442ba4e668e31ffdf5f6e6322]] in a web browser and generate the license key
88 +*** The Customer Number and PO# must be provided by the Crestron Agent for the job
89 +*** The Hostname and System Key can be viewed in Toolbox by navigating to Functions>License Management...>Add License
90 +** In Toolbox, paste the generated license key into the "License Key:" field of the Add License menu
91 +** Click the "Apply" button
92 +* Continue [[SHOWRUNNER™ deployment>>SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Processor Setup.WebHome||anchor="HProgramLoad"]] as normal
87 87  
88 -=== License and Configuration Deployment ===
94 += Program Load =
89 89  
90 -* Download the SrConfig.json or CiLightingConfig.json configuration file from the link provided by Chief Integrations
91 -* Obtain and download the license from [[https:~~/~~/portal.chiefintegrations.com>>url:https://portal.chiefintegrations.com]]
92 -** Processors with a Control Subnet should use the LAN MAC address, **not** the Control Subnet MAC address
93 -* The license and configuration can be loaded with Toolbox using Text Console and File Management, or through the showrunnerHUB™ web interface
94 -** Using Toolbox:
95 -*** Connect to the processor via Text Console and via File Management
96 -*** In File management, navigate to the "NVRAM>sr" folder from the left-hand menu
97 -*** Right-click on the right-hand side and select "Copy File(s) From..." and select the downloaded License.lic file
98 -**** Alternatively, drag and drop the file from your computer to the File Management tool
99 -*** Using the left-hand menu, navigate to the "NVRAM>sr>default" folder
100 -*** Right-click on the right-hand side and select "Copy File(s) From..." and select the downloaded SrConfig.json file
101 -**** Alternatively, drag and drop the file from your computer to the File Management tool
102 -**** If you downloaded a CiLightingConfig.json file, it must be renamed to "SrConfig.json"
103 -** Using the showrunnerHUB™ UI:
104 -*** Using Chrome or Firefox, navigate to the processor's IP address
105 -*** When prompted, input your credentials and log in
106 -**** 4-Series processor or 3-Series processor with authentication enabled: Log in using the same admin credentials used to connect to the processor
107 -**** 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.
108 -***** ##sradmin username "name" administrators password##
109 -***** The username and password should be one word each and are the credentials used to log in to the showrunnerHUB™
110 -***** The name can be multiple words as long as it is in quotes, and is simply a friendly name used to identify each user.
111 -*** Once logged in to the showrunnerHUB™ UI, you should be automatically redirected to the File Management page
112 -**** 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
113 -**** [[image:1654807593390-193.png]]
114 -**** Under “Upload New License File”
115 -***** Leave "Restart after transfer" unchecked
116 -***** Select “Choose File” and browse for the license file you downloaded from the portal
117 -***** Select “Upload”
118 -**** Load the configuration file either directly (if you have an SrConfig.json file) or from a backup (if you have an SRBackup.zip)
119 -***** Direct upload:
120 -****** Under “Upload New Config File”
121 -****** 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.
122 -****** Select “Upload”
123 -***** From a Backup:
124 -****** Select "Restore"
125 -****** Select "Choose Backup" and find the SRBackup.zip of the backup you wish to restore
126 -****** Enter the secret used to create the backup. ShowRunner will upload the file and verify the secret.
127 -**** Once both the license and either a configuration file or backup have been loaded, click "Restart"
128 -**** Wait for the processor to finish restarting and then reload the page.
129 -***** 3-Series processors will take 45 to 90 restart
130 -***** 4-Series processors should restart considerably faster
96 +{{display excludeFirstHeading="true" reference="SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Processor Setup.WebHome" section="HProgramLoad"/}}
131 131  
132 -=== Set System Time ===
98 += License and Configuration Deployment =
133 133  
134 -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:
100 +{{display excludeFirstHeading="true" reference="SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Processor Setup.WebHome" section="HLicenseandConfigurationDeployment"/}}
135 135  
136 -* Connect to the processor via Text Console
137 -* At the top of the Toolbox window, navigate to Functions>System Clock...
138 -* If your computer is in the correct timezone, click Synchronize Device Time with PC
139 -** The Timezone and Device Time should synchronize automatically
140 -** If your PC is in the incorrect Timezone or the time did not synchronize properly, then manually adjust the Time, Date, and Timezone
141 -* Press the Apply button
102 += Set System Time =
142 142  
143 -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
104 +{{display excludeFirstHeading="true" reference="SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Processor Setup.WebHome" section="HSetSystemTime"/}}
144 144  
145 -* SHOWRUNNER™ XPanel UI:
146 -** Navigate to Settings>Location and System Clock
147 -** Press the Lock icon to enable editing
148 -** Adjust the time, timezone, and location as necessary
149 -** Press Set System Clock to save the changes
150 -* showrunnerHUB™ Web UI:
151 -** Navigate to Setup>System Settings>Location and System Clock
152 -** Adjust the time, timezone, and location as necessary
153 -** Click Apply to save the changes
106 += Accessing the showrunnerHUB™ Web UI =
107 +
108 +Due to Crestron's Zūm Program running in parallel with the SHOWRUNNER™ program, navigating to the processor's IP address in a web browser will no longer redirect you to the showrunnerHUB™ UI.
109 +
110 +Instead, you must add "/cws/showrunner/app/" after the IP address in order to access the Web UI (e.g. [[https:~~/~~/100.64.0.1/cws/showrunner/app/>>https://100.64.0.1/cws/showrunner/app]]) **DO NOT OMIT THE LAST "/"**
111 +
112 +ZUM-HUB4 Currently does NOT support XPANEL:
113 +The XPanel does not launch from the Showrunner HUB webpage. To access the XPanel, extract the VTZ file from the showrunner™ puf file and launch. Select Options>Host Settings and input the Host IP, IPID, Port 41794, check SSL, and Open. Type in the username and password and wait for the XPanel to connect.
FileZilla HUB4 NVRAM Permissions Change.mp4
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +4.5 MB
Content