Wiki source code of Zūm Net Device Setup

Version 48.1 by Alexander Mott on 2023/12/13 19:15

version	line-number	content
23.1	1	(% class="box warningmessage" %)
19.1	2	(((
36.1	3	This article is for configuring Zūm Net devices using Crestron Toolbox. For instructions on configuring Zūm Wired rooms using the Crestron Zūm App, see [[this page>>SHOWRUNNER™ Setup Guide.Wiring Guide.Zūm Wired System Overview.Crestron Zūm App Overview.WebHome]].
48.1	4	For details on using the Zūm Discovery feature to automatically build a ShowRunnerCLC™ configuration based on the Zūm App settings, see [[this page>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Program Configuration.Zūm Discovery.WebHome]].
19.1	5	)))
	6
29.1	7	{{box cssClass="floatinginfobox" title="CONTENTS"}}
22.1	8	{{toc/}}
	9	{{/box}}
1.1	10
47.1	11	Zūm Net devices are part of Crestron's latest Zūm Wired system, acting as the main lighting controller for a Zūm Wired room. In networked applications of Zūm Wired, they also act as bridges connecting the local Zūm Link devices in each room to the overall lighting network throughout the building. Since Zūm Link and Cresnet are [[interchangeable>>https://wiki.chiefintegrations.com/SHOWRUNNER%E2%84%A2%20Setup%20Guide/Wiring%20Guide/Wiring%20Overview/Z%C5%ABm%20Net/#HZ16BmLink]], and Zūm Net is an Ethernet protocol, this means that Zūm Net devices can be thought of as single-net DIN-CENCN-2s. As of Summer 2022, there are only two Zūm Net devices that have been announced and are in production: the ZUMNET-JBOX-16A-LV 0-10V load controller and the ZUMNET-JBOX-DALI DALI load controller. Configuring these devices for use with ShowRunnerCLC™ is identical, so they will be referred to collectively as ZUMNET-JBOXs for the purposes of this article.
1.1	12
39.1	13	Much like DIN-CENCN-2s in ShowRunnerCLC™ installations, ZUMNET-JBOXs identify themselves to the processor via their IP-ID, so the specific IP address of any given ZUMNET-JBOX does not matter as long as it is in the same range as the processor and does not conflict with any other devices on the network. If hosted devices are moved between ZUMNET-JBOXs, or if the ZUMNET-JBOX needs to have a different IP-ID than it was initially assigned, the configuration will need to be updated (see below). Chief Integrations typically provides an SRTakeoff.xlsx spreadsheet which will list all the Zūm Net and Zūm Link devices and their associated IP-IDs. If no takeoff is provided, then the processor's IP table can be checked by running the ##ipt -t ##command from the processor after the configuration is loaded. ZUMNET-JBOX's will typically start with IP-IDs in the 30-5F range, but can potentially exceed this range.
1.1	14
22.1	15	= Identification and IP Configuration =
1.1	16
4.1	17	Configuring ZUMNET-JBOXs must be done over Ethernet, and is easiest to do once all ZUMNET-JBOXs have been installed, powered up, and connected to the lighting network. (It is not necessary for all Zūm Link devices to be installed in order to configure ZUMNET-JBOXs.)
1.1	18
4.1	19	Since there is no option to configure ZUMNET-JBOXs via USB, a DHCP server is required. There are three options for DHCP servers:
1.1	20
4.1	21	* Using a processor with a Control Subnet (only available on certain processors)
39.1	22	* Using the built-in [[ShowRunnerCLC™ DHCP Server>>doc:SHOWRUNNER™ Setup Guide.Troubleshooting Guide.Advanced Tools.DHCP Server.WebHome]] (available on all processors running ShowRunnerCLC™ v3.009 or newer)
4.1	23	* Using third party DHCP server software on your computer
	24
	25	Most devices (DIN-CENCN-2, TSW, ZUMNET-JBOXs) rely only on IP-ID to identify themselves to the processor, but some devices (such as GLPACs, DMX controllers, and other processors) have IP addresses that are explicitly defined in the configuration file. The DHCP server should be configured to assign IP addresses that are visible to the processor, but excluded from assigning these explicitly defined IP addresses if possible.
	26
	27	Configuring ZUMNET-JBOXs can be broken up into two separate processes:
	28
	29	1. Identifying which DHCP assigned IP address corresponds to each ZUMNET-JBOX
5.2	30	1. Connecting to each ZUMNET-JBOX and assigning a permanent static IP address and IP-ID
4.1	31
22.1	32	== Identifying ZUMNET-JBOXs ==
4.1	33
5.2	34	Once all ZUMNET-JBOXs have been assigned temporary IP addresses from the DHCP server, they must each be identified so that the correct IP-ID can be assigned. The goal is to associate each assigned IP address with the room that each ZUMNET-JBOX is meant to control. Then we can connect to each ZUMNET-JBOX and set static IP addresses and update the IP table with the correct IP-ID.
4.1	35
10.2	36	There are three primary ways of identifying ZUMNET-JBOXs:
	37
	38	1. Identifying by hostname
	39	1. Identifying by serial number or MAC address
10.7	40	1. Identifying through Device Tree View
10.2	41
10.3	42	Each of these methods involves generating a Device Summary using the Device Discovery Tool in Toolbox. The Device Summary is a file which lists all devices that are discoverable on the network along with useful information such as their hostname, IP address, and MAC address.
	43
	44	To generate a Device Summary in Toolbox:
	45
	46	* Connect to the lighting network and open Device Discovery Tool in Toolbox
	47	* The Device Discovery tool will automatically report how many Ethernet devices have been discovered
	48	* Verify that the expected number of Ethernet devices have been discovered, including any TSWs, GLPACs, DIN-CENCN-2s, etc.
	49	** Note that only Crestron devices will appear in Device Discovery; non-Crestron devices (such as Pharos or Enttec DMX controllers) will not appear in Device Discovery Tool
	50	** If no devices are discovered, verify that your computer is connected to the network and your IP address is compatible with the network
	51	** If some devices are missing, there may be an issue with your DHCP server settings or the network wiring
	52	* Click the "Export..." button below the list of discovered devices
	53	** If this button says "Address Book", then Toolbox needs to be updated
10.4	54	* Click the Write Device Summary button and save the Device Summary to your computer
	55	** Though saved as a text file, the Device Summary is actually a table of comma separated values
	56	** Renaming DeviceSummary.txt to DeviceSummary.csv will allow it to be opened and manipulated in common spreadsheet software such as Microsoft Excel or LibreOffice Calc
10.3	57
38.1	58	See the [[Export to Device Summary>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Preparation.Toolbox Basics.WebHome\|\|anchor="HExporttoDeviceSummary"]] section of the Toolbox Basics page for more detail.
10.10	59
10.7	60	Once the Device Summary has been generated, proceed to identifying each ZUMNET-JBOX using the hostname, SN/MAC, or Device Tree View methods described below.
	61
22.1	62	=== Identifying by Hostname ===
10.2	63
39.1	64	The Crestron Zūm App is used to configure the internal logic of Zūm Wired rooms. This internal logic determines the room behavior when ZUMNET-JBOXs are used in standalone applications or if communication to the processor is lost. Even on ShowRunnerCLC™ jobs with a central program running the lighting controls, it is best practice to configure the internal logic to match as closely as possible the ShowRunnerCLC™ logic in order to minimize disruption to end-users in the event of a processor or network failure.
10.2	65
10.8	66	In addition to configuring default room logic, the Crestron Zūm App can be used to change the hostname of the ZUMNET-JBOX for each room. By default, the hostname for a ZUMNET-JBOX is the model followed by the last six digits of the MAC address, e.g. "ZUMNET-JBOX-16A-LV-F2DA94". If you or the electrical contractor already intend to configure the internal logic each ZUMNET-JBOX, it would be a good idea to also change the hostname to something more identifiable.
	67
	68	To change the hostname using the Crestron Zūm App:
	69
	70	* Connect to the ZUMNET-JBOX in the App
	71	* Tap "Room Settings"
	72	* Tap "Network"
	73	* Tap the Hostname field and edit the Hostname
	74	* Scroll to the bottom of the page and tap "Save settings"
	75	* Tap "OK" to apply the changes and reboot the ZUMNET-JBOX
	76	** Note that rebooting the JBOX will cause the lights to briefly cut out
	77
	78	If all hostnames have been set, then it becomes very easy to know which DHCP assigned IP address is associated with each room using the Device Summary. Generate a Device Summary with the new hostnames and proceed to IP configuration.
	79
21.1	80	Full instructions on configuring Zūm Wired using the Crestron Zūm App, can be found [[here>>SHOWRUNNER™ Setup Guide.Wiring Guide.Zūm Wired System Overview.Crestron Zūm App Overview.WebHome]].
19.1	81
22.1	82	=== Identifying by Serial Number or MAC Address ===
10.8	83
10.9	84	Both the serial number and MAC address are printed onto each ZUMNET-JBOX. Just like with Cresnet jobs, it is good practice for the electrical contractor to record serial numbers as they install devices. It is also good to collect the MAC addresses, but it is not necessary since Device Summary will have both the serial number and MAC address.
10.8	85
10.9	86	If the electrical contractor has provided a list of which serial numbers/MAC addresses belong to each installed ZUMNET-JBOX, then generate a Device Summary and proceed to IP configuration.
4.1	87
22.1	88	=== Identifying through Network Device Tree View ===
4.1	89
10.10	90	If the electrical contractor has not provided a list of which serial numbers/MAC addresses belong to each installed ZUMNET-JBOX and nobody intends to rename each ZUMNET-JBOX using the Crestron Zūm App, then the only way to identify which ZUMNET-JBOX is installed where is to use the Device Tree View tool in Toolbox. This is by far the slowest and most disruptive way to identify devices, so it is only recommended as a last resort.
4.1	91
10.10	92	Putting a ZUMNET-JBOX into identify mode will make it continuously produce an alarm-clock sound and flash any connected loads. Additionally, putting a device into identify mode will stop any programs running on a processor, and taking a device out of identify mode will restart the program. This starting/stopping of the program can be time consuming when a large number of devices are being identified, so it may be a good idea to suspend the program using the ##stopprog -p:01## command on the processor prior to identifying devices. Once all the devices are identified, run the ##progreset## command to resume the program.
	93
	94	* Generate a Device Summary and note the IP addresses for all installed ZUMNET-JBOXs
4.1	95	* Connect to the first ZUMNET-JBOX using Network Device Tree View
	96	* Locate the "ZUMNET-JBOX-xx-xx-LOCAL" device in the list of connected devices
	97	** The model will vary between 0-10V and DALI JBOXs
	98	** The ID should be "03" regardless of model
	99	* Right click the device and press "Identify This Device..." from the context menu
	100	* The device will blink any attached fixtures and make an alarm sound
	101	* Walk around the jobsite until the room/controlled fixtures are located
10.10	102	* Edit the Device Summary or SRTakeoff.xlsx so that you remember which JBOX is which
	103	* Repeat for each ZUMNET-JBOX until all of the ZUMNET-JBOXs have been identified
4.1	104
10.10	105	Once you have determined and recorded which ZUMNET-JBOX is which, you may proceed to IP configuration.
	106
22.1	107	== Assigning Permanent Static IP Addresses and IP-IDs ==
4.1	108
45.1	109	Once you have identified which IP address has been assigned to each ZUMNET-JBOX, you can begin configuring them with permanent static IP addresses and the correct IP-ID.
4.1	110
45.1	111	Note that static IP addresses are only required on jobs where there is no permanent DHCP server. Manual IP-ID assignment is not required for jobs intended to be used with Zūm Auto Discovery, though it may still be recommended in order to keep track and document which IP-ID is associated with each area (Auto Discovery will auto-assign IP-IDs to ZUMNET-JBOXs without IP-IDs, but if a ZUMNET-JBOX already has an IP table entry it will be imported to the configuration with that pre-existing IP-ID).
	112
4.1	113	* Open Text Console in Toolbox and connect to the first ZUMNET-JBOX
10.10	114	* Run the following commands to configure the ZUMNET-JBOXs IP settings (example is for a 10.0.0.0(% style="color:darkgoldenrod" %)/24(%%) subnet, with a permanent IP address of (% style="color:blue" %)10.0.0.80(%%), an IP-ID of (% style="color:olive" %)30(%%), a processor IP address of (% style="color:orange" %)10.0.0.10(%%), and a hostname of (% style="color:#800080" %)ZNET-JBOX-RM-201(%%); the hostname can be skipped if it has already been configured from the Crestron Zūm App)
10.3	115	Set IP address: ##ipa 0 (% style="color:blue" %)10.0.0.80**(%%)##
1.1	116	Set IP subnet mask: ##ipm 0 (% style="color:darkgoldenrod" %)255.255.255.0**(%%)##
	117	Set default gateway: ##defr 0 10.0.0.1**##
4.1	118	Update IP table: ##addm (% style="color:olive" %)30(%%) (% style="color:orange" %)10.0.0.10**(%%)##
	119	Set hostname: ##host (% style="color:purple" %)ZNET-JBOX-RM-201**(%%)##
40.1	120	** Disable DHCP: ##dhcp off##
4.1	121	** Reboot the ZUMNET-JBOX: ##reboot##
16.1	122	*** Note that rebooting the JBOX will cause the lights to briefly cut out
4.1	123	* Repeat for all ZUMNET-JBOXs on the job
1.1	124
22.1	125	= Zūm Net Specific Configuration =
1.1	126
44.1	127	Zūm Net devices have a two additional settings not present for other devices: Primary/Secondary mode and Zūm/Cresnet mode. ZUMNET-JBOX-DALI have a third setting for Group/Legacy DALI mode, and all ZUMNET-JBOX-* that are in CNET mode can optionally be configured to automatically switch back and forth between CNET and App mode depending on whether the control processor is reachable.
5.2	128
41.1	129	== Primary/Secondary Mode ==
9.1	130
41.1	131	(% class="box warningmessage" %)
	132	(((
43.1	133	Zūm Wired firmware v1.03.27 (device firmware v1.002.00026) updates the terminology from "master"/"slave" to "primary"/"secondary", and changes the ##zwms## command to ##zwps##
	134	Devices running this newer firmware will not accept commands using "master"/"slave" as arguments.
41.1	135	)))
9.1	136
41.1	137	ZUMNET-JBOXs can be in either "Primary" or "Secondary" mode. In most situations, "Primary" is the desired mode of operations, as "Secondary" mode effectively turns a ZUMNET-JBOX into a ZUMLINK-JBOX and prevents it from discovering devices on the Zūm Link bus or performing any logic. There are two scenarios in which a ZUMNET-JBOX should be configured in "Secondary" mode:
	138
9.1	139	1. It is connected to another ZUMNET-JBOX via the Zūm Link bus
	140	1. It is being used as a Cresnet device, connected to a processor or DIN-CENCN-2 using a Cresnet/Zūm Link adapter
	141
41.1	142	ZUMNET-JBOXs with firmware 1.006.00012 or newer will ship from the factory in "Primary" mode, but will go to "Secondary" mode if a hardware reset is performed. ZUMNET-JBOXs with older firmware will ship in "Secondary" mode. The commands to view or change the Primary/Secondary mode are:
9.1	143
41.1	144	* View current mode:
	145	** Current FW: ##zwps## or ##zwmode##
	146	** Old FW: ##zwms##
42.1	147	* Make "Primary":
41.1	148	** Current FW: ##zwps primary##
	149	** Old FW: ##zwms master##
42.1	150	* Make "Secondary":
	151	** Current FW: ##zwps secondary##
	152	** Old FW: ##zwms slave##
9.1	153
41.1	154	A reboot is required if the mode is changed.
9.1	155
44.1	156	== Zūm/Cresnet Mode ==
4.1	157
44.1	158	Zūm Mode (also known as App Mode) is the default setting for new ZUMNET-JBOXs, and allows them to be configured from the Crestron Zūm App. If a ZUMNET-JBOX is put into Cresnet mode, it will no longer be able to be configured using the Crestron Zūm App and all internal logic will be disabled. Generally, Cresnet mode is only required if non-Zūm Link devices are connected to the ZUMNET-JBOX (e.g. a GL-EXP-DIMU-CN phase dimmer or C2N-CBD-P Cameo keypads) or if certain ShowRunnerCLC™ features are required (such as changing the dimming response curve).
	159
	160	The commands to view or change the Zūm/Cresnet mode are:
	161
	162	* View current mode: ##zwmode##
	163	* Make Zūm/App mode: ##zwmode zum##
	164	* Make Cresnet mode: ##zwmode cnet##
	165
	166	A reboot is required if the mode is to be changed. Note that this command will also display the current Master/Slave mode, but will not allow you to change it.
	167
	168	=== DALI Group/Legacy Mode ===
	169
	170	ZUMNET-JBOX-DALI that are operating in App mode should be kept in "Groups" DALI mode, and DALI loads must be configured through the Zūm App. ZUMNET-JBOX-DALI that are operating in CNET mode with ShowRunner™ must be changed to "Legacy" DALI mode, and the DALI ballasts must be addressed and grouped using the Crestron Toolbox DALI Commissioning 2.0 Tool.
	171
	172	To change modes, run the appropriate dalisetmode command, wait 5 seconds, and then reboot the ZUMNET-JBOX-DALI:
	173
	174	* Set Legacy mode: ##dalisetmode 1 1##
	175	* Set Groups mode: ##dalisetmode 1 2##
	176
	177	=== Zūm Mode Auto Switch ===
	178
	179	Zūm Mode Auto Switch is a feature introduced by Crestron in November of 2022 with .puf firmware v1.04.05 (device firmware 1.004.00005). This feature is intended to address concerns that arose from projects using custom programs with ZUMNET-JBOX-* devices in CNET Mode. Previously, if a device in CNET Mode lost connection to the processor, then it would be impossible to maintain any sort of control over the lighting. With Zūm Mode Auto Switch enabled, a ZUMNET-JBOX running in CNET Mode will automatically switch to App Mode and process local logic in the event that it loses connection to the processor.
	180
46.1	181	Note that on 0-10V and switched JBOXs, the connected loads will flash once when rebooting. On ZUMNET-DALI-JBOX models, the JBOX will reboot once when switching to App mode and twice when switching back to CNET mode (once to switch to CNET, and a second time to switch to Legacy DALI mode)
	182
44.1	183	Enable Zūm Mode Auto Switch using the command: ##autoswitch on##
	184
	185	Rebooting after changing Auto Switch modes is not officially required, but is still recommended.
	186
	187	//Any configuration changes made through the Zūm App should be made while the control processor is disconnected: the easiest ways to accomplish this are to either disconnect the Cat5e/Cat6 cable at the processor or use Text Console commands (//##stopprog -p:01##//)to temporarily suspend the custom program on the processor.//
	188
	189	== Changing IP-IDs ==
	190
4.1	191	If ZUMNET-JBOXs must be assigned different IP-IDs than indicated in the SRTakeoff.xlsx, or if Zūm Link devices are moved between ZUMNET-JBOXs, then the configuration file must be updated. Every Zūm Link device in the configuration has a ##"DeviceHostId"## associated with it, which corresponds to the IP-ID of the ZUMNET-JBOX hosting it.
	192
	193	If a Zūm Link device is moved from one ZUMNET-JBOX to another, then this ##"DeviceHostId"## must be updated with the IP-ID of the new device.
	194
	195	If a ZUMNET-JBOX is assigned a different IP-ID, then it's own ##"DeviceHostId"## as well as the ##"DeviceHostId"## for all hosted Zūm Link devices must be changed to the new IP-ID. In addition to changing these ##"DeviceHostId"##, the ##"IpId"## for the associated entry in ##"IpDevices"## must be updated. ##"IpDevices"## are located towards the beginning of the configuration file. Note that while the ##"DeviceHostId"## is in hexadecimal, the ##"IpId"## is a decimal integer. This means that a ZUMNET-JBOX with ##"DeviceHostId": "31"## would be associated with an entry in ##"IpDevices"## with ##"IpId": 49##
	196
	197	Below are two snippets from a configuration file comparing a ZUMNET-JBOX-16A-LV lighting controller and it's associated entry in ##"IpDevices"##:
	198
	199	[[image:1655247008527-737.png]]
	200
	201	[[image:1655246948921-246.png]]