Changes for page Zūm Net Device Setup

Last modified by Alexander Mott on 2024/10/22 19:55
From version 37.1
edited by Alexander Mott
on 2022/09/22 23:09
Change comment: There is no comment for this version
To version 50.6
edited by Alexander Mott
on 2024/10/15 14:34
Change comment: (Autosaved)

Summary

Details

Page properties
Content
... ... @@ -1,7 +1,7 @@
1 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.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 SHOWRUNNER™ configuration based on the Zūm App settings, see [[this page>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Device Addressing.Zūm Discovery.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.SHOWRUNNER™ Installation Guide.Preparation.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]].
5 5  )))
6 6  
7 7  {{box cssClass="floatinginfobox" title="**CONTENTS**"}}
... ... @@ -8,11 +8,9 @@
8 8  {{toc/}}
9 9  {{/box}}
10 10  
11 -(% class="row" %)
12 -(((
13 -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.
14 14  
15 -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.
16 16  
17 17  = Identification and IP Configuration =
18 18  
... ... @@ -21,7 +21,7 @@
21 21  Since there is no option to configure ZUMNET-JBOXs via USB, a DHCP server is required. There are three options for DHCP servers:
22 22  
23 23  * Using a processor with a Control Subnet (only available on certain processors)
24 -* Using the built-in [[SHOWRUNNER™ DHCP Server>>doc:SHOWRUNNER™ Setup Guide.Troubleshooting Guide.Advanced Tools.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)
25 25  * Using third party DHCP server software on your computer
26 26  
27 27  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.
... ... @@ -57,18 +57,13 @@
57 57  ** Though saved as a text file, the Device Summary is actually a table of comma separated values
58 58  ** 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
59 59  
60 -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.
61 61  
62 -* DeviceSummary.txt:
63 -[[image:1655487020590-542.png]]
64 -* DeviceSummary.csv:
65 -[[image:1655487132138-904.png]]
66 -
67 67  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.
68 68  
69 69  === Identifying by Hostname ===
70 70  
71 -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.
72 72  
73 73  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.
74 74  
... ... @@ -84,7 +84,7 @@
84 84  
85 85  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.
86 86  
87 -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]].
80 +Full instructions on configuring Zūm Wired using the Crestron Zūm App, can be found [[here>>SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Preparation.Zūm App Overview.WebHome]].
88 88  
89 89  === Identifying by Serial Number or MAC Address ===
90 90  
... ... @@ -113,16 +113,18 @@
113 113  
114 114  == Assigning Permanent Static IP Addresses and IP-IDs ==
115 115  
116 -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.
117 117  
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 +
118 118  * Open Text Console in Toolbox and connect to the first ZUMNET-JBOX
119 119  * 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)
120 -** Disable DHCP: ##dhcp off##
121 121  ** Set IP address: ##ipa 0 (% style="color:blue" %)**10.0.0.80**(%%)##
122 122  ** Set IP subnet mask: ##ipm 0 (% style="color:darkgoldenrod" %)**255.255.255.0**(%%)##
123 123  ** Set default gateway: ##defr 0 **10.0.0.1**##
124 124  ** Update IP table: ##addm (% style="color:olive" %)**30**(%%) (% style="color:orange" %)**10.0.0.10**(%%)##
125 125  ** Set hostname: ##host (% style="color:purple" %)**ZNET-JBOX-RM-201**(%%)##
120 +** Disable DHCP: ##dhcp off##
126 126  ** Reboot the ZUMNET-JBOX: ##reboot##
127 127  *** Note that rebooting the JBOX will cause the lights to briefly cut out
128 128  * Repeat for all ZUMNET-JBOXs on the job
... ... @@ -129,12 +129,77 @@
129 129  
130 130  = Zūm Net Specific Configuration =
131 131  
132 -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.
133 133  
129 +== Updating Firmware ==
130 +
131 +(% class="box errormessage" %)
132 +(((
133 +Per Crestron's Zūm Wired firmware v4.01.06.02 release notes, devices running firmware v3.09.05 or earlier "are not supported for upgrade via the Zum App / Hub / or Toolbox" and users should contact Crestron True Blue Support for upgrade paths when required.
134 +)))
135 +
136 +It is best practice to upgrade all Zūm Wired devices to the latest version, or at the very least update all devices to the same firmware version across the job. The recommended process for updating Zūm Wired firmware is:
137 +
138 +1. Ensure that the ZUMNET-JBOX for the room is in Primary / Zūm Mode (see below) so that it will re-address all connected Zūm Link devices
139 +1. Connect to the ZUMNET-JBOX in Network Device Tree View and verify that all expected Zūm Link devices are online and that there are no conflicting/duplicate IDs
140 +1*. We have run into issues where devices will not always be uniquely addressed, typically as a result of cabling termination issues (incorrect pin-out or use of "EZ RJ45" passthrough connectors)
141 +1*. Occasionally, ZUMLINK-KP will be stuck at ID 03 after the ZUMNET-JBOX has been put into Primary/App Mode - in these cases, briefly disconnecting the keypad, reconnecting it, and waiting a few minutes will allow the keypad's address to be changed
142 +1. Use the Zūm Wired .puf file or the Firmware Updating Script tool built into ShowRunner™ to update all the ZUMNET-JBOXs
143 +1*. Note that as part of the update process, the ZUMNET-JBOX will reboot, which will cycle the connected load and briefly interrupt Ethernet connection to any downstream ZUMNET-JBOXs or other Ethernet devices, which in rare instances will cause the firmware update to fail
144 +1. Verify that all the ZUMNET-JBOXs have successfully updated by using the Device Discovery Tool device export and checking the reported firmware version
145 +1. If any ZUMNET-JBOXs failed to update, try to update it again in case the update failure was caused by an upstream device rebooting
146 +1. I
147 +1*. ZUMNET-JBOXs will update their firmware only after all connected Zūm Link devices have been successfully updated; verify
148 +
149 +Alternatively, rooms can be updated through the Crestron Zūm App as of firmware v1.03.54, however only one room can be upgraded at a time and your mobile device will become occupied for the duration of the firmware upgrade (15-45 minutes depending on firmware version and quantity of Zūm Wired devices in the room)
150 +
151 +== Primary/Secondary Mode ==
152 +
153 +(% class="box warningmessage" %)
154 +(((
155 +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##
156 +Devices running this newer firmware will not accept commands using "master"/"slave" as arguments.
157 +)))
158 +
159 +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:
160 +
161 +1. It is connected to another ZUMNET-JBOX via the Zūm Link bus
162 +1. It is being used as a Cresnet device, connected to a processor or DIN-CENCN-2 using a Cresnet/Zūm Link adapter
163 +
164 +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:
165 +
166 +* View current mode:
167 +** Current FW: ##zwps## or ##zwmode##
168 +** Old FW: ##zwms##
169 +* Make "Primary":
170 +** Current FW: ##zwps primary##
171 +** Old FW: ##zwms master##
172 +* Make "Secondary":
173 +** Current FW: ##zwps secondary##
174 +** Old FW: ##zwms slave##
175 +
176 +A reboot is required if the mode is changed.
177 +
134 134  == Zūm/Cresnet Mode ==
135 135  
136 -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).
180 +Zūm Mode (also known as App Mode) is the default setting for ZUMNET-JBOXs shipping on newer firmware, and allows them to be configured from the Crestron Zūm App as long as a ZUMLINK-KP is connected to the JBOX. 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.
137 137  
182 +Generally, ZUMNET-JBOXs do not need to be in Cresnet mode to work with ShowRunnerCLC™ except in specific cases:
183 +
184 +* ZUMNET-JBOX-DALI controllers are being used in legacy mode
185 +* Site-specific security requirements do not allow for wireless connectivity to the lighting controls
186 +* Certain ShowRunnerCLC™ features are required (such as changing the dimming response curve)
187 +* On older versions of firmware, Cresnet mode was required if non-Zūm Link devices were connected to the ZUMNET-JBOX (e.g. a GL-EXP-DIMU-CN phase dimmer or C2N-CBD-P Cameo keypads)
188 +** This is no longer the case on recent firmware, and ZUMNET-JBOXs with Cresnet hardware connected to them can be left in Zūm/App mode, though the Cresnet hardware will not be able to function without the control processor
189 +
190 +When a ZUMNET-JBOX is in Zūm Mode and configured to communicate with a processor running ShowRunnerCLC™ software, it is operating in a kind of "App Plus" mode, where any actions that are defined in ShowRunnerCLC™ are performed "on top of" the actions defined in the App:
191 +
192 +* A keypad with actions defined in the Zūm App will perform actions defined in ShowRunnerCLC™ in addition to those App-defined actions while the ZUMNET-JBOX is in Zūm Mode
193 +** This is useful when trying to add functionality to a keypad, such as allowing the keypad to control devices not available in the Zūm App (e.g. shades, loads that are controlled by other ZUMNET-JBOXs or Cresnet load controllers, etc.), but can cause confusion in other situations where there are conflicts between the App-defined actions and the ShowRunnerCLC™-defined actions (e.g. if a rocker keypad with the default All On and All Off actions defined in the App is programmed in ShowRunnerCLC™ to act as a single load toggle, it will not work correctly)
194 +** A ZUMLINK-KP that is disabled from ShowRunnerCLC™ (i.e. by using the Keypad Disable function) will not perform any actions
195 +** A ZUMLINK-KP that has null actions defined in the Zūm App will only perform those actions that are defined in ShowRunnerCLC™
196 +* If occupancy sensor load assignments in the App do not match ShowRunnerCLC™, then odd behavior may result
197 +
138 138  The commands to view or change the Zūm/Cresnet mode are:
139 139  
140 140  * View current mode: ##zwmode##
... ... @@ -143,23 +143,29 @@
143 143  
144 144  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.
145 145  
146 -== Master/Slave Mode ==
206 +=== DALI Group/Legacy Mode ===
147 147  
148 -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:
208 +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.
149 149  
150 -1. It is connected to another ZUMNET-JBOX via the Zūm Link bus
151 -1. It is being used as a Cresnet device, connected to a processor or DIN-CENCN-2 using a Cresnet/Zūm Link adapter
210 +To change modes, run the appropriate dalisetmode command, wait 5 seconds, and then reboot the ZUMNET-JBOX-DALI:
152 152  
153 -The commands to view or change the Master/Slave mode are:
212 +* Set Legacy mode: ##dalisetmode 1 1##
213 +* Set Groups mode: ##dalisetmode 1 2##
154 154  
155 -* View current mode: ##zwms##
156 -* Make "master": ##zwms master##
157 -* Make "slave": ##zwms slave##
215 +=== Zūm Mode Auto Switch ===
158 158  
159 -A reboot is required if the mode is to be changed.
217 +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.
160 160  
161 -= Changing IP-IDs =
219 +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)
162 162  
221 +Enable Zūm Mode Auto Switch using the command: ##autoswitch on##
222 +
223 +Rebooting after changing Auto Switch modes is not officially required, but is still recommended.
224 +
225 +//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.//
226 +
227 +== Changing IP-IDs ==
228 +
163 163  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.
164 164  
165 165  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.
... ... @@ -171,4 +171,3 @@
171 171  [[image:1655247008527-737.png]]
172 172  
173 173  [[image:1655246948921-246.png]]
174 -)))