Changes for page Zūm Net Device Setup

Last modified by Alexander Mott on 2024/10/22 19:55
From version 5.1
edited by Alexander Mott
on 2022/06/14 23:04
Change comment: There is no comment for this version
To version 17.2
edited by Alexander Mott
on 2022/06/17 19:43
Change comment: Update document after refactoring.

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -ZUMNET-JBOX Setup
1 +Zūm Net Device Setup
Parent
... ... @@ -1,1 +1,1 @@
1 -SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.WebHome
1 +SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.WebHome
Content
... ... @@ -1,8 +1,8 @@
1 -=== ZUMNET-JBOXs in SHOWRUNNER™ ===
1 +=== Zūm Net Devices in SHOWRUNNER™ ===
2 2  
3 -ZUMNET-JBOXs 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 Zūm Link network in each room to the Zūm Net 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 ZUMNET-JBOXs can be thought of as single-net DIN-CENCN-2s.
3 +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.
4 4  
5 -Much like DIN-CENCN-2s in SHOWRUNNER™ installations, the IP address of the ZUMNET-JBOX also 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. Instead, ZUMNET-JBOXs are identified to the processor via their IP-ID. If devices are moved between ZUMNET-JBOXs, or if the ZUMNET-JBOX needs to have a different IP-ID than it was initially assigned, then the configuration will need to be updated (see below). Chief Integrations typically provides an SRTakeoff.xlsx spreadsheet with an IP Table tab that lists all the ZUMNET-JBOX IP-IDs in the program. 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.
5 +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.
6 6  
7 7  === Identification and IP Configuration ===
8 8  
... ... @@ -19,29 +19,74 @@
19 19  Configuring ZUMNET-JBOXs can be broken up into two separate processes:
20 20  
21 21  1. Identifying which DHCP assigned IP address corresponds to each ZUMNET-JBOX
22 -1. Connecting to each ZUMNET-JBOX and assigning a permanent static IP and the correct IP-ID
22 +1. Connecting to each ZUMNET-JBOX and assigning a permanent static IP address and IP-ID
23 23  
24 24  ==== Identifying ZUMNET-JBOXs ====
25 25  
26 -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.
26 +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.
27 27  
28 -If the electrical contractor has provided a list of which serial numbers/MAC addresses belong to each installed ZUMNET-JBOX, then it is relatively easy to identify which ZUMNET-JBOX should get which IP-ID:
28 +There are three primary ways of identifying ZUMNET-JBOXs:
29 29  
30 +1. Identifying by hostname
31 +1. Identifying by serial number or MAC address
32 +1. Identifying through Device Tree View
33 +
34 +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.
35 +
36 +To generate a Device Summary in Toolbox:
37 +
30 30  * Connect to the lighting network and open Device Discovery Tool in Toolbox
31 31  * The Device Discovery tool will automatically report how many Ethernet devices have been discovered
32 -** Verify that the correct number of Ethernet devices have been discovered, including any TSWs, GLPACs, DIN-CENCN-2s, etc.
40 +* Verify that the expected number of Ethernet devices have been discovered, including any TSWs, GLPACs, DIN-CENCN-2s, etc.
33 33  ** 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
42 +** If no devices are discovered, verify that your computer is connected to the network and your IP address is compatible with the network
43 +** If some devices are missing, there may be an issue with your DHCP server settings or the network wiring
34 34  * Click the "Export..." button below the list of discovered devices
35 35  ** If this button says "Address Book", then Toolbox needs to be updated
36 -* Click the Write Device Summary and save the DeviceSummary.txt to your computer
37 -* The DeviceSummary.txt provides the IP address, MAC address, and serial number for each device on the network
38 -* Cross reference the DeviceSummary.txt with the serial numbers/MAC addresses provided by the installer in order to determine which ZUMNET-JBOX has been assigned each IP address
39 -* Update the SRTakeoff.xlsx with the device serial number, MAC address, and automatically assigned IP address for all ZUMNET-JBOXs
46 +* Click the Write Device Summary button and save the Device Summary to your computer
47 +** Though saved as a text file, the Device Summary is actually a table of comma separated values
48 +** 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
40 40  
41 -If the electrical contractor has not provided a list of which serial numbers/MAC addresses belong to each installed ZUMNET-JBOX, then it is necessary to connect to each ZUMNET-JBOX individually and identify them individually:
50 +Below is an example of a Device Summary for a fully-configured job:
42 42  
43 -* Connect to the lighting network and open Device Discovery Tool in Toolbox
44 -* Note the IP addresses for all of the installed ZUMNET-JBOXs
52 +* DeviceSummary.txt:
53 +[[image:1655487020590-542.png]]
54 +* DeviceSummary.csv:
55 +[[image:1655487132138-904.png]]
56 +
57 +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.
58 +
59 +===== Identifying by Hostname =====
60 +
61 +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.
62 +
63 +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.
64 +
65 +To change the hostname using the Crestron Zūm App:
66 +
67 +* Connect to the ZUMNET-JBOX in the App
68 +* Tap "Room Settings"
69 +* Tap "Network"
70 +* Tap the Hostname field and edit the Hostname
71 +* Scroll to the bottom of the page and tap "Save settings"
72 +* Tap "OK" to apply the changes and reboot the ZUMNET-JBOX
73 +** Note that rebooting the JBOX will cause the lights to briefly cut out
74 +
75 +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.
76 +
77 +===== Identifying by Serial Number or MAC Address =====
78 +
79 +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.
80 +
81 +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.
82 +
83 +===== Identifying through Network Device Tree View =====
84 +
85 +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.
86 +
87 +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.
88 +
89 +* Generate a Device Summary and note the IP addresses for all installed ZUMNET-JBOXs
45 45  * Connect to the first ZUMNET-JBOX using Network Device Tree View
46 46  * Locate the "ZUMNET-JBOX-xx-xx-LOCAL" device in the list of connected devices
47 47  ** The model will vary between 0-10V and DALI JBOXs
... ... @@ -49,30 +49,58 @@
49 49  * Right click the device and press "Identify This Device..." from the context menu
50 50  * The device will blink any attached fixtures and make an alarm sound
51 51  * Walk around the jobsite until the room/controlled fixtures are located
52 -* Update the SRTakeoff.xlsx with the device serial number, MAC address, and automatically assigned IP address
53 -* Repeat all steps for each ZUMNET-JBOXs until all of the ZUMNET-JBOXs have been identified
97 +* Edit the Device Summary or SRTakeoff.xlsx so that you remember which JBOX is which
98 +* Repeat for each ZUMNET-JBOX until all of the ZUMNET-JBOXs have been identified
54 54  
100 +Once you have determined and recorded which ZUMNET-JBOX is which, you may proceed to IP configuration.
101 +
55 55  ==== Assigning Permanent Static IP Addresses and IP-IDs ====
56 56  
57 57  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:
58 58  
59 59  * Open Text Console in Toolbox and connect to the first ZUMNET-JBOX
60 -* 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.20**(%%), 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**(%%))
61 -** Disable DHCP: ##dhcp 0 off##
62 -** Set IP address: ##ipa 0 (% style="color:blue" %)**10.0.0.20**(%%)##
107 +* 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)
108 +** Disable DHCP: ##dhcp off##
109 +** Set IP address: ##ipa 0 (% style="color:blue" %)**10.0.0.80**(%%)##
63 63  ** Set IP subnet mask: ##ipm 0 (% style="color:darkgoldenrod" %)**255.255.255.0**(%%)##
64 64  ** Set default gateway: ##defr 0 **10.0.0.1**##
65 65  ** Update IP table: ##addm (% style="color:olive" %)**30**(%%) (% style="color:orange" %)**10.0.0.10**(%%)##
66 66  ** Set hostname: ##host (% style="color:purple" %)**ZNET-JBOX-RM-201**(%%)##
67 67  ** Reboot the ZUMNET-JBOX: ##reboot##
115 +*** Note that rebooting the JBOX will cause the lights to briefly cut out
68 68  * Repeat for all ZUMNET-JBOXs on the job
69 69  
70 -=== ZUMNET-JBOX Specific Configuration ===
118 +=== Zūm Net Specific Configuration ===
71 71  
72 -App vs Cresnet mode
120 +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.
73 73  
74 -Master vs Slave
122 +==== Zūm/Cresnet Mode ====
75 75  
124 +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).
125 +
126 +The commands to view or change the Zūm/Cresnet mode are:
127 +
128 +* View current mode: ##zwmode##
129 +* Make Zūm/App mode: ##zwmode zum##
130 +* Make Cresnet mode: ##zwmode cnet##
131 +
132 +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.
133 +
134 +==== Master/Slave Mode ====
135 +
136 +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:
137 +
138 +1. It is connected to another ZUMNET-JBOX via the Zūm Link bus
139 +1. It is being used as a Cresnet device, connected to a processor or DIN-CENCN-2 using a Cresnet/Zūm Link adapter
140 +
141 +The commands to view or change the Master/Slave mode are:
142 +
143 +* View current mode: ##zwms##
144 +* Make "master": ##zwms master##
145 +* Make "slave": ##zwms slave##
146 +
147 +A reboot is required if the mode is to be changed.
148 +
76 76  === Changing IP-IDs ===
77 77  
78 78  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.
1655410981707-782.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +5.6 KB
Content
1655410997733-287.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +2.6 KB
Content
1655411066727-374.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +3.2 KB
Content
1655487002500-174.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +51.5 KB
Content
1655487008788-390.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +51.5 KB
Content
1655487020590-542.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +51.5 KB
Content
1655487132138-904.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +53.0 KB
Content