Wiki source code of ZUM-HUB4 Processor Setup

Last modified by Craig Lewis on 2025/03/13 15:50

version	line-number	content
38.1	1	{{info}}
1.2	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]].
38.1	3	{{/info}}
1.1	4
38.1	5	{{error}}
	6	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 the device, which may require redoing the start-up from scratch if the latest configuration was not saved and backed up.
	7	{{/error}}
	8
	9	{{error}}
37.1	10	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.
41.1	11	{{/error}}
33.1	12
41.1	13	{{error}}
42.1	14	Per Crestron's ZUM-HUB4 firmware v3.009.0039 release notes, updating to firmware versions 3.009.0039 or newer require first updating to 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.
38.1	15	{{/error}}
37.1	16
38.1	17	{{warning}}
27.1	18	ZUM-HUB4 requires firmware version 2.006.0034 or greater for third party software to be loaded.
	19	(Once installed, running the "##ver##" command should report a FW version of 2.8000.00009 or greater.)
38.1	20	{{/warning}}
1.1	21
20.1	22	{{box cssClass="floatinginfobox" title="CONTENTS"}}
12.1	23	{{toc/}}
	24	{{/box}}
	25
1.1	26	Licensing tutorial:
	27
	28	//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.//
	29
	30	[[https:~~/~~/www.youtube.com/watch?v=H8CLZ7bp0eI>>url:https://www.youtube.com/watch?v=H8CLZ7bp0eI]]
	31
29.1	32	{{display excludeFirstHeading="false" reference="SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Processor Setup.WebHome" section="HErrorBroadcasting"/}}
	33
12.1	34	= IP Configuration and Console Commands =
1.1	35
1.2	36	* Connect to the ZUM-HUB4 via USB and create an admin-level CWS user
	37	** 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
	38	** In the event that the processor does not allow you to log in with the chosen credentials (i.e. it repeatedly prompts for credentials)
	39	*** Attempt to log in with username "crestron" and no password
	40	*** Once logged into Text Console, run the following commands, replacing the "username" and "password" with your desired credentials
	41	**** ##adduser -N:username -P:password##
	42	**** ##addusertogroup -N:username -G:Administrators##
32.1	43	* Run commands to enable connecting to the ShowRunnerHUB™ interface and prevent issues with license loading on processor reboot:
	44	** Disable CWS Anti-CSRF feature (case sensitive): ##cwsanticsrf OFF##
	45	** Force waiting to start program: ##startprogafterrouter on##
	46	** 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
36.1	47	** ShowRunnerCLC™ .puf versions 3.042 and newer automatically run this command when the "Configure ZUM-HUB4" option is selected.
1.2	48	* Determine whether the lighting control hardware will be connected to the ZUM-HUB4's LAN port or the Control Subnet port:
31.1	49	** 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 router built-in that will assign IP addresses:
1.2	50	* 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**(%%)):
	51	**** Disable DHCP: ##dhcp 0 off##
	52	** Set IP address: ##ipa 0 (% style="color:blue" %)10.0.0.10**(%%)##
	53	** Set IP subnet mask: ##ipm 0 (% style="color:darkgoldenrod" %)255.255.255.0**(%%)##
	54	** Set default gateway: ##defr 0 10.0.0.1**##
	55	**** Set hostname: ##host HUB4-CPP##
30.1	56	**** Optionally, set secure gateway: ##securegateway default ##
	57	***** 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
1.2	58	**** Reboot the processor: ##reboot##
31.1	59	*** 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:
1.2	60	**** Using the "Functions>Ethernet Addressing...>Control Subnet" menu of Toolbox:
	61	***** Set routing to "Manual" with the start address and subnet size
4.1	62	***** 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
	63	** 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**(%%))
	64	*** Set CS IP: ##csrouterprefix 100.64.0.0/20**##
1.2	65	***** Reboot the processor: ##reboot##
36.1	66	**** ShowRunnerCLC™ .puf versions 3.042 and newer automatically run this command when the "Configure ZUM-HUB4 Control Subnet" option is selected.
1.2	67	** If the system is intended to connect to the building LAN:
	68	*** The building LAN must be connected to ZUM-HUB4's LAN port
	69	*** The ZUM-HUB4's LAN IP settings should be configured per the building requirements
	70	*** Any connected lighting hardware must either:
	71	***1. Be on the building LAN
4.1	72	**1. The ZUM-HUB4 LAN should be configured with a static IP or DHCP reservation
	73	**1. Building network must be configured to allow communication between ZUM-HUB4 and all lighting devices
24.1	74	**1. Run the command: ##securegateway default##
35.1	75	**1. ShowRunnerCLC™ .puf versions 3.042 and newer automatically run this command when the "Configure ZUM-HUB4 SecureGateway" option is selected.
1.3	76	***1. Be connected to the Control Subnet port
	77	**1. Control Subnet must be configured correctly (see above)
	78	**1. If lighting devices must be able to communicate with the building LAN, run the command: ##isolatenetworks off##
34.1	79	* 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]]
1.1	80
12.1	81	= Update NVRAM Folder Permissions =
1.1	82
2.1	83	* Ensure that the NVRAM folder permissions are set correctly using a third party SFTP program:
7.1	84	** FileZilla instructions ([[video example>>attach:FileZilla HUB4 NVRAM Permissions Change.mp4]]):
2.1	85	*** Connect to the processor at port 22
	86	*** Locate the "nvram" folder
	87	*** Right click the folder and select "Change File Attributes"
	88	*** Change "Numeric Value" to 777
23.1	89	*** Disconnect from the processor in FileZilla
2.1	90	** WinSCP instructions:
	91	*** Connect to the processor at port 22
	92	*** Locate the "nvram" folder
	93	*** Right click the folder and select "Properties"
	94	*** Change "Octal Value" to 2777
23.1	95	*** Disconnect from the processor WinSCP
2.1	96
12.1	97	= Crestron License Generation =
2.1	98
1.1	99	* 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
2.1	100	* Connect to the ZUM-HUB4 in Crestron Toolbox
26.1	101	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)
23.1	102	** Open the Functions>License Management... window
	103	*** If "ZumHubProgramming" license is listed with "Expiration: Never", then the license has already been activated and this step is not necessary
	104	** Navigate to the Functions>License Management...>Add License tab
2.1	105	** Open [[Crestron's SW-HUB4-PROG licensing form>>https://app.smartsheet.com/b/form/e06b27d442ba4e668e31ffdf5f6e6322]] in a web browser and generate the license key
	106	*** The Customer Number and PO# must be provided by the Crestron Agent for the job
	107	*** The Hostname and System Key can be viewed in Toolbox by navigating to Functions>License Management...>Add License
	108	** In Toolbox, paste the generated license key into the "License Key:" field of the Add License menu
	109	** Click the "Apply" button
5.1	110	* Continue [[SHOWRUNNER™ deployment>>SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Processor Setup.WebHome\|\|anchor="HProgramLoad"]] as normal
1.1	111
22.1	112	{{display excludeFirstHeading="false" reference="SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Processor Setup.WebHome" section="HProgramLoad"/}}
14.1	113
22.1	114	{{display excludeFirstHeading="false" reference="SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Processor Setup.WebHome" section="HLicenseandConfigurationDeployment"/}}
16.1	115
22.1	116	{{display excludeFirstHeading="false" reference="SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Processor Setup.WebHome" section="HSetSystemTime"/}}
16.1	117
12.1	118	= Accessing the showrunnerHUB™ Web UI =
1.1	119
5.1	120	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.
	121
11.1	122	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 "/"
8.1	123
	124	ZUM-HUB4 Currently does NOT support XPANEL:
	125	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.
40.1	126	~{~{/error}}
43.1	127
	128	= Connecting ShowRunnerCLC™ to SSL Connects Devices =
	129
	130	Due to SSL Management, Processors and Secondary network hardware with SSL enabled will require CS Authentication to be enabled and setup.
	131
49.1	132	Follow these steps to setup [[SSL User Configuration>>doc:SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Appendix.SSL User Configuration.WebHome]]