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 1.2
edited by Alexander Mott
on 2022/06/30 16:14
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,13 +1,12 @@
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 13  **ShowRunner Installation Tutorial:**
... ... @@ -22,41 +22,47 @@
22 22  
23 23  === IP Configuration ===
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 +**** Set secure gateway: ##securegateway default##
40 +**** Reboot the processor: ##reboot##
41 +*** If connecting lighting hardware to the Control Subnet port, then you must configure the Control Subnet:
42 +**** Using the "Functions>Ethernet Addressing...>Control Subnet" menu of Toolbox:
43 +***** Set routing to "Manual" with the start address and subnet size
44 +***** 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
45 +**** Using Text Console commands (example for a **10.0.0.0(% style="color:darkgoldenrod" %)/24(%%)** subnet, with a processor IP address of (% style="color:blue" %)**10.0.0.1**(%%))
46 +***** Set CS IP: ##csrouterprefix **10.0.0.0/24**##
47 +***** Reboot the processor: ##reboot##
48 +** If the system is intended to connect to the building LAN:
49 +*** The building LAN must be connected to ZUM-HUB4's LAN port
50 +*** The ZUM-HUB4's LAN IP settings should be configured per the building requirements
51 +*** Any connected lighting hardware must either:
52 +***1. Be on the building LAN
53 +***1*. The ZUM-HUB4 LAN should be configured with a static IP
54 +***1*. Building network must be configured to allow communication between ZUM-HUB4 and all lighting devices
55 +***1. Be connected to the ZUM-HUB4's Control Subnet port, and the Control Subnet must be configured correctly (see above)
56 +* Once IP settings are configured, there are additional commands that must be run:
57 +** Force waiting to start program: ##startprografterrouter on##
58 +** Disable CWS Anticsrf feature: ##cwsanticsrf off##
59 +** Reboot the processor: ##reboot##
57 57  
58 -=== Program Load ===
61 +=== Crestron License and Program Load ===
59 59  
63 +* Verify that the installed firmware is new enough to allow for third party software to be installed on the processor:
64 +** The ##ver## command should report firmware version 2.7100.00016 or greater
60 60  * Download the latest build of SHOWRUNNER™ from the[[ Chief Integrations Portal>>https://files.chiefintegrations.com/index.php/s/WHNzXrrZbB5jC3E]]
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 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
... ... @@ -80,16 +80,14 @@
80 80  *** Under the "Send" section, browse your PC and select the extracted .cpz file
81 81  *** Click the "Send" button and click "Yes" to upload the program
82 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
88 +* 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. 
87 87  
88 88  === License and Configuration Deployment ===
89 89  
90 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 +* Obtain and download the SHOWRUNNER™ license from [[https:~~/~~/portal.chiefintegrations.com>>url:https://portal.chiefintegrations.com]]
94 +** When generating the license, use the LAN MAC address, **not** the Control Subnet MAC address
95 +** If taking the MAC from the sticker on the ZUM-HUB4, the correct MAC is the one on the sticker that just says "MAC", not the sticker that says "MAC1"
93 93  * The license and configuration can be loaded with Toolbox using Text Console and File Management, or through the showrunnerHUB™ web interface
94 94  ** Using Toolbox:
95 95  *** Connect to the processor via Text Console and via File Management