Skip to Content

Wiki source code of ZUM-HUB4 Processor Setup

Version 55.1 by Alexander Mott on 2026/03/04 21:37
Show last authors
1 {{info}}
2 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]].
3 {{/info}}
4
5 {{warning}}
6 ZUM-HUB4 requires **firmware v2.8000.00009 or greater** for third party software to be loaded.
7 Text console "**##ver##**" command will give the current firmware version.
8 {{/warning}}
9
10 {{error}}
11 Per Crestron's ZUM-HUB4 firmware v3.009.0039 release notes, updating to PUF versions 3.009.0039 or newer require first updating to PUF version 3.008.054. Failure to do so will result in longer ##progreset## times (up to 10 minutes) as well as other potential issues such as keypads becoming unresponsive.
12
13 The PUF firmware version is can be viewed using the ##**ver -all**## command (PUF firmware version is different than the version displayed with just the ##**ver**## command)
14 {{/error}}
15
16 {{error}}
17 **IMPORTANT:** When using ShowRunnerCLC™ with a ZUM-HUB4, **DO NOT** discover Zūm Rooms using the Crestron HUB4 Web UI. During discovery, the HUB4 will claim ZUMNET-JBOXs and prevent ShowRunnerCLC™ from auto-discovering or registering the Zūm hardware for itself.
18 {{/error}}
19
20 {{error}}
21 All 4-Series processors require authentication to be configured when first connecting: **the Crestron Agent or Field Tech are responsible for recording these credentials. Chief Integrations cannot provide assistance unless the credentials are known. The only way to connect to a device for which the credentials have been lost is to [[factory reset>>https://docs.crestron.com/en-us/8559/Content/Topics/Reference/Restore-Factory-Defaults.htm]] the device, which may require redoing the start-up from scratch if the latest configuration was not saved and backed up. **
22 {{/error}}
23
24 {{box cssClass="floatinginfobox" title="**CONTENTS**"}}
25 {{toc/}}
26 {{/box}}
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 {{display excludeFirstHeading="false" reference="SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Processor Setup.WebHome" section="HErrorBroadcasting"/}}
35
36 = IP Configuration and Console Commands =
37
38 * Connect to the ZUM-HUB4 via USB and create an admin-level CWS user
39 ** 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
40 ** In the event that the processor does not allow you to log in with the chosen credentials (i.e. it repeatedly prompts for credentials)
41 *** Attempt to log in with username "crestron" and no password
42 *** Once logged into Text Console, run the following commands, replacing the "username" and "password" with your desired credentials
43 **** ##adduser -N:username -P:password##
44 **** ##addusertogroup -N:username -G:Administrators##
45 * Run commands to enable connecting to the ShowRunnerHUB™ interface and prevent issues with license loading on processor reboot:
46 ** Disable CWS Anti-CSRF feature (case sensitive): ##cwsanticsrf OFF##
47 ** Force waiting to start program: ##startprogafterrouter on##
48 ** Processor must be rebooted with "##reboot##" command before these take effect, but you can wait to reboot if there are other settings you must change that also require a reboot
49 ** ShowRunnerCLC™ .puf versions 3.042 and newer automatically run this command when the "Configure ZUM-HUB4" option is selected.
50 * Here are some things to consider before doing any network configuration on the ZUM-HUB4 processor:
51 ** **Never **connect an external router to the Control Subnet, as doing so will cause the internal DHCP server to shut down.
52 ** **Never **set the LAN IP address to an address that is in the range of the Control Subnet
53 *** e.g. for a processor with the default 172.22.0.0/20 Control Subnet configuration, the LAN IP address must be below 172.22.0.0 or above 172.22.15.255
54 ** **Always** set devices on the Control Subnet to DHCP so that their IP addresses are managed by the built-in DHCP server. Only set static IP addresses on the Control Subnet if you really know what you are doing.
55 *** If setting static IP addresses on the Control Subnet for any reason: **always** assign an address within the Control Subnet range, but **never** use the first two or the last address in the range
56 *** e.g. for a processor with the default 172.22.0.0/20 Control Subnet configuration, IP addresses must be in the range 172.22.0.3 through 172.22.15.254
57 **** 172.22.0.0 is not a valid address, 172.22.0.1 is taken by the processor, 172.22.0.2 is taken by the DHCP server (default gateway), and 172.22.15.255 is the broadcast address for the Control Subnet
58 * Determine whether the lighting control hardware will be connected to the ZUM-HUB4's LAN port or the Control Subnet port:
59 ** 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, but it is still recommended to use the Control Subnet for Crestron hardware as the ZUM-HUB4 has a built-in router that will assign IP addresses via DHCP:
60 *** 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**(%%)):
61 **** Disable DHCP: ##dhcp 0 off##
62 **** Set IP address: ##ipa 0 (% style="color:blue" %)**10.0.0.10**(%%)##
63 **** Set IP subnet mask: ##ipm 0 (% style="color:darkgoldenrod" %)**255.255.255.0**(%%)##
64 **** Set default gateway: ##defr 0 **10.0.0.1**##
65 **** Set hostname: ##host HUB4-CPP##
66 **** Optionally, set secure gateway: ##securegateway default ##
67 ***** 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
68 **** Reboot the processor: ##reboot##
69 *** If connecting lighting hardware to the Control Subnet port, then you may either use the default IP scheme of the processor, or you may optionally configure the Control Subnet. Do not connect an external router to the Control Subnet port, as doing so will cause the internal DHCP server to shut down. If manually configuring the control subnet, we recommend the following IP range as it won't conflict with corporate networks:
70 **** Using the "Functions>Ethernet Addressing...>Control Subnet" menu of Toolbox:
71 ***** Set routing to "Manual" with the start address and subnet size
72 ***** 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
73 **** 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**(%%))
74 ***** Set CS IP: ##csrouterprefix **100.64.0.0/20**##
75 ***** Reboot the processor: ##reboot##
76 **** ShowRunnerCLC™ .puf versions 3.042 and newer automatically run this command when the "Configure ZUM-HUB4 Control Subnet" option is selected.
77 ** If the system is intended to connect to the building LAN:
78 *** The building LAN must be connected to ZUM-HUB4's LAN port
79 *** The ZUM-HUB4's LAN IP settings should be configured per the building requirements
80 *** Any connected lighting hardware must either:
81 ***1. Be on the building LAN
82 ***1*. The ZUM-HUB4 LAN should be configured with a static IP or DHCP reservation
83 ***1*. Building network must be configured to allow communication between ZUM-HUB4 and all lighting devices
84 ***1*. Run the command: ##securegateway default##
85 ***1*. ShowRunnerCLC™ .puf versions 3.042 and newer automatically run this command when the "Configure ZUM-HUB4 SecureGateway" option is selected.
86 ***1. Be connected to the Control Subnet port
87 ***1*. Control Subnet must be configured correctly (see above)
88 ***1*. If lighting devices must be able to communicate with the building LAN, run the command: ##isolatenetworks off##
89
90 {{display excludeFirstHeading="false" reference="SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Processor Setup.WebHome" section="HFirmwareUpdate"/}}
91
92 = Update NVRAM Folder Permissions =
93
94 * Ensure that the NVRAM folder permissions are set correctly using a third party SFTP program:
95 ** FileZilla instructions ([[video example>>attach:FileZilla HUB4 NVRAM Permissions Change.mp4]]):
96 *** Connect to the processor at port 22
97 *** Locate the "nvram" folder
98 *** Right click the folder and select "Change File Attributes"
99 *** Change "Numeric Value" to 777
100 *** Disconnect from the processor in FileZilla
101 ** WinSCP instructions:
102 *** Connect to the processor at port 22
103 *** Locate the "nvram" folder
104 *** Right click the folder and select "Properties"
105 *** Change "Octal Value" to 2777
106 *** Disconnect from the processor WinSCP
107
108 = Crestron License Generation =
109
110 * 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
111 * Connect to the ZUM-HUB4 in Crestron Toolbox
112 ** Run the "##ver##" and verify that the reported firmware is v2.8000.00009 or greater (**NOTE**: older firmware will report the license as "Canvas Control" rather than "ZumHubProgramming" and will not work)
113 ** Open the Functions>License Management... window
114 *** If "ZumHubProgramming" license is listed with "Expiration: Never", then the license has already been activated and this step is not necessary
115 ** Navigate to the Functions>License Management...>Add License tab
116 ** Open [[Crestron's SW-HUB4-PROG licensing form>>https://app.smartsheet.com/b/form/e06b27d442ba4e668e31ffdf5f6e6322]] in a web browser and generate the license key
117 *** The Customer Number and PO# must be provided by the Crestron Agent for the job
118 *** The Hostname and System Key can be viewed in Toolbox by navigating to Functions>License Management...>Add License
119 ** In Toolbox, paste the generated license key into the "License Key:" field of the Add License menu
120 ** Click the "Apply" button
121 * Continue [[SHOWRUNNER™ deployment>>SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Processor Setup.WebHome||anchor="HProgramLoad"]] as normal
122
123 {{display excludeFirstHeading="false" reference="SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Processor Setup.WebHome" section="HProgramLoad"/}}
124
125 {{display excludeFirstHeading="false" reference="SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Processor Setup.WebHome" section="HLicenseandConfigurationDeployment"/}}
126
127 {{display excludeFirstHeading="false" reference="SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Processor Setup.WebHome" section="HSetSystemTime"/}}
128
129 = Accessing the showrunnerHUB™ Web UI =
130
131 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.
132
133 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 "/"**
134
135 ZUM-HUB4 Currently does NOT support XPANEL:
136 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.
137 ~{~{/error}}
138
139 = **Connecting ShowRunnerCLC™ to SSL Connects Devices** =
140
141 Due to SSL Management, Processors and Secondary network hardware with SSL enabled will require CS Authentication to be enabled and setup.
142
143 Follow these steps to setup [[SSL User Configuration>>doc:SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Appendix.SSL User Configuration.WebHome]]