Changes for page Zūm Net Device Setup

Last modified by Alexander Mott on 2024/10/22 19:55
From version 20.1
edited by Alexander Mott
on 2022/06/22 22:28
Change comment: There is no comment for this version
To version 48.1
edited by Alexander Mott
on 2023/12/13 19:15
Change comment: Renamed back-links.

Summary

Details

Page properties
Content
... ... @@ -1,15 +1,18 @@
1 -(% class="box" %)
1 +(% class="box warningmessage" %)
2 2  (((
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.Wiring Overview.Crestron Zūm App Overview.WebHome]].
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]].
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]].
4 4  )))
5 5  
6 -=== Zūm Net Devices in SHOWRUNNER™ ===
7 +{{box cssClass="floatinginfobox" title="**CONTENTS**"}}
8 +{{toc/}}
9 +{{/box}}
7 7  
8 -Zūm Net devices are part of Crestron's latest Zūm Wired system, acting as a 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 SHOWRUNNER™ is identical, so they will be referred to collectively as ZUMNET-JBOXs for the purposes of this article.
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.
9 9  
10 -Much like DIN-CENCN-2s in SHOWRUNNER™ 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.
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.
11 11  
12 -=== Identification and IP Configuration ===
15 += Identification and IP Configuration =
13 13  
14 14  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.)
15 15  
... ... @@ -16,7 +16,7 @@
16 16  Since there is no option to configure ZUMNET-JBOXs via USB, a DHCP server is required. There are three options for DHCP servers:
17 17  
18 18  * Using a processor with a Control Subnet (only available on certain processors)
19 -* Using the built-in [[SHOWRUNNER™ DHCP Server>>doc:SHOWRUNNER™ User Guide & Wiki.Troubleshooting.DHCP Server.WebHome]] (available on all processors running SHOWRUNNER™ v3.009 or newer)
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)
20 20  * Using third party DHCP server software on your computer
21 21  
22 22  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,7 +26,7 @@
26 26  1. Identifying which DHCP assigned IP address corresponds to each ZUMNET-JBOX
27 27  1. Connecting to each ZUMNET-JBOX and assigning a permanent static IP address and IP-ID
28 28  
29 -==== Identifying ZUMNET-JBOXs ====
32 +== Identifying ZUMNET-JBOXs ==
30 30  
31 31  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.
32 32  
... ... @@ -52,18 +52,13 @@
52 52  ** Though saved as a text file, the Device Summary is actually a table of comma separated values
53 53  ** 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
54 54  
55 -Below is an example of a Device Summary for a fully-configured job:
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.
56 56  
57 -* DeviceSummary.txt:
58 -[[image:1655487020590-542.png]]
59 -* DeviceSummary.csv:
60 -[[image:1655487132138-904.png]]
61 -
62 62  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.
63 63  
64 -===== Identifying by Hostname =====
62 +=== Identifying by Hostname ===
65 65  
66 -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 SHOWRUNNER™ 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 SHOWRUNNER™ logic in order to minimize disruption to end-users in the event of a processor or network failure.
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.
67 67  
68 68  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.
69 69  
... ... @@ -79,15 +79,15 @@
79 79  
80 80  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.
81 81  
82 -Full instructions on configuring Zūm Wired using the Crestron Zūm App, can be found [[here>>SHOWRUNNER™ Setup Guide.Wiring Guide.Wiring Overview.Crestron Zūm App Overview.WebHome]].
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]].
83 83  
84 -===== Identifying by Serial Number or MAC Address =====
82 +=== Identifying by Serial Number or MAC Address ===
85 85  
86 86  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.
87 87  
88 88  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.
89 89  
90 -===== Identifying through Network Device Tree View =====
88 +=== Identifying through Network Device Tree View ===
91 91  
92 92  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.
93 93  
... ... @@ -106,30 +106,59 @@
106 106  
107 107  Once you have determined and recorded which ZUMNET-JBOX is which, you may proceed to IP configuration.
108 108  
109 -==== Assigning Permanent Static IP Addresses and IP-IDs ====
107 +== Assigning Permanent Static IP Addresses and IP-IDs ==
110 110  
111 -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:
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.
112 112  
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 +
113 113  * Open Text Console in Toolbox and connect to the first ZUMNET-JBOX
114 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)
115 -** Disable DHCP: ##dhcp off##
116 116  ** Set IP address: ##ipa 0 (% style="color:blue" %)**10.0.0.80**(%%)##
117 117  ** Set IP subnet mask: ##ipm 0 (% style="color:darkgoldenrod" %)**255.255.255.0**(%%)##
118 118  ** Set default gateway: ##defr 0 **10.0.0.1**##
119 119  ** Update IP table: ##addm (% style="color:olive" %)**30**(%%) (% style="color:orange" %)**10.0.0.10**(%%)##
120 120  ** Set hostname: ##host (% style="color:purple" %)**ZNET-JBOX-RM-201**(%%)##
120 +** Disable DHCP: ##dhcp off##
121 121  ** Reboot the ZUMNET-JBOX: ##reboot##
122 122  *** Note that rebooting the JBOX will cause the lights to briefly cut out
123 123  * Repeat for all ZUMNET-JBOXs on the job
124 124  
125 -=== Zūm Net Specific Configuration ===
125 += Zūm Net Specific Configuration =
126 126  
127 -Zūm Net devices have a two additional settings not present for other devices: Zūm/Cresnet mode and Master/Slave mode. ZUMNET-JBOXs should ship as Master devices in Zūm Mode from the factory, and this is typically the desired setting.
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.
128 128  
129 -==== Zūm/Cresnet Mode ====
129 +== Primary/Secondary Mode ==
130 130  
131 -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 SHOWRUNNER™ features are required (such as changing the dimming response curve).
131 +(% class="box warningmessage" %)
132 +(((
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.
135 +)))
132 132  
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 +
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 +
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:
143 +
144 +* View current mode:
145 +** Current FW: ##zwps## or ##zwmode##
146 +** Old FW: ##zwms##
147 +* Make "Primary":
148 +** Current FW: ##zwps primary##
149 +** Old FW: ##zwms master##
150 +* Make "Secondary":
151 +** Current FW: ##zwps secondary##
152 +** Old FW: ##zwms slave##
153 +
154 +A reboot is required if the mode is changed.
155 +
156 +== Zūm/Cresnet Mode ==
157 +
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 +
133 133  The commands to view or change the Zūm/Cresnet mode are:
134 134  
135 135  * View current mode: ##zwmode##
... ... @@ -138,23 +138,29 @@
138 138  
139 139  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.
140 140  
141 -==== Master/Slave Mode ====
168 +=== DALI Group/Legacy Mode ===
142 142  
143 -ZUMNET-JBOXs ship in "Master" mode by default, and generally this is how they should be configured. "Slave" mode effectively turns a ZUMNET-JBOX into a ZUMLINK-JBOX. There are two scenarios in which a ZUMNET-JBOX will need to be configured in "Slave" mode:
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.
144 144  
145 -1. It is connected to another ZUMNET-JBOX via the Zūm Link bus
146 -1. It is being used as a Cresnet device, connected to a processor or DIN-CENCN-2 using a Cresnet/Zūm Link adapter
172 +To change modes, run the appropriate dalisetmode command, wait 5 seconds, and then reboot the ZUMNET-JBOX-DALI:
147 147  
148 -The commands to view or change the Master/Slave mode are:
174 +* Set Legacy mode: ##dalisetmode 1 1##
175 +* Set Groups mode: ##dalisetmode 1 2##
149 149  
150 -* View current mode: ##zwms##
151 -* Make "master": ##zwms master##
152 -* Make "slave": ##zwms slave##
177 +=== Zūm Mode Auto Switch ===
153 153  
154 -A reboot is required if the mode is to be changed.
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.
155 155  
156 -=== Changing IP-IDs ===
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)
157 157  
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 +
158 158  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.
159 159  
160 160  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.