Wiki source code of Zūm Net Device Setup
Version 10.3 by Alexander Mott on 2022/06/17 16:47
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | === Zūm Net Devices in SHOWRUNNER™ === | ||
| 2 | |||
| 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 | |||
| 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 | |||
| 7 | === Identification and IP Configuration === | ||
| 8 | |||
| 9 | 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.) | ||
| 10 | |||
| 11 | Since there is no option to configure ZUMNET-JBOXs via USB, a DHCP server is required. There are three options for DHCP servers: | ||
| 12 | |||
| 13 | * Using a processor with a Control Subnet (only available on certain processors) | ||
| 14 | * 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) | ||
| 15 | * Using third party DHCP server software on your computer | ||
| 16 | |||
| 17 | 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. | ||
| 18 | |||
| 19 | Configuring ZUMNET-JBOXs can be broken up into two separate processes: | ||
| 20 | |||
| 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 address and IP-ID | ||
| 23 | |||
| 24 | ==== Identifying ZUMNET-JBOXs ==== | ||
| 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. | ||
| 27 | |||
| 28 | There are three primary ways of identifying ZUMNET-JBOXs: | ||
| 29 | |||
| 30 | 1. Identifying by hostname | ||
| 31 | 1. Identifying by serial number or MAC address | ||
| 32 | 1. Identifying through Toolbox | ||
| 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 | |||
| 38 | * Connect to the lighting network and open Device Discovery Tool in Toolbox | ||
| 39 | * The Device Discovery tool will automatically report how many Ethernet devices have been discovered | ||
| 40 | * Verify that the expected number of Ethernet devices have been discovered, including any TSWs, GLPACs, DIN-CENCN-2s, etc. | ||
| 41 | ** 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 | ||
| 44 | * Click the "Export..." button below the list of discovered devices | ||
| 45 | ** If this button says "Address Book", then Toolbox needs to be updated | ||
| 46 | * Click the Write Device Summary button and save the DeviceSummary.txt to your computer | ||
| 47 | * The DeviceSummary.txt provides the IP address, MAC address, and serial number for each device on the network | ||
| 48 | * 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 | ||
| 49 | * Update the SRTakeoff.xlsx with the device serial number, MAC address, and automatically assigned IP address for all ZUMNET-JBOXs | ||
| 50 | |||
| 51 | ===== Identifying by Hostname ===== | ||
| 52 | |||
| 53 | Oftentimes, | ||
| 54 | |||
| 55 | 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: | ||
| 56 | |||
| 57 | * Connect to the lighting network and open Device Discovery Tool in Toolbox | ||
| 58 | * The Device Discovery tool will automatically report how many Ethernet devices have been discovered | ||
| 59 | ** Verify that the correct number of Ethernet devices have been discovered, including any TSWs, GLPACs, DIN-CENCN-2s, etc. | ||
| 60 | ** 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 | ||
| 61 | * Click the "Export..." button below the list of discovered devices | ||
| 62 | ** If this button says "Address Book", then Toolbox needs to be updated | ||
| 63 | * Click the Write Device Summary button and save the DeviceSummary.txt to your computer | ||
| 64 | * The DeviceSummary.txt provides the IP address, MAC address, and serial number for each device on the network | ||
| 65 | * 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 | ||
| 66 | * Update the SRTakeoff.xlsx with the device serial number, MAC address, and automatically assigned IP address for all ZUMNET-JBOXs | ||
| 67 | |||
| 68 | 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 through Toolbox. Putting a device into identify 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 run 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. | ||
| 69 | |||
| 70 | * Connect to the lighting network and open Device Discovery Tool in Toolbox | ||
| 71 | * Note the IP addresses for all of the installed ZUMNET-JBOXs | ||
| 72 | * Connect to the first ZUMNET-JBOX using Network Device Tree View | ||
| 73 | * Locate the "ZUMNET-JBOX-xx-xx-LOCAL" device in the list of connected devices | ||
| 74 | ** The model will vary between 0-10V and DALI JBOXs | ||
| 75 | ** The ID should be "03" regardless of model | ||
| 76 | * Right click the device and press "Identify This Device..." from the context menu | ||
| 77 | * The device will blink any attached fixtures and make an alarm sound | ||
| 78 | * Walk around the jobsite until the room/controlled fixtures are located | ||
| 79 | * Update the SRTakeoff.xlsx with the device serial number, MAC address, and automatically assigned IP address | ||
| 80 | * Repeat all steps for each ZUMNET-JBOXs until all of the ZUMNET-JBOXs have been identified | ||
| 81 | |||
| 82 | ==== Assigning Permanent Static IP Addresses and IP-IDs ==== | ||
| 83 | |||
| 84 | 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: | ||
| 85 | |||
| 86 | * Open Text Console in Toolbox and connect to the first ZUMNET-JBOX | ||
| 87 | * 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**(%%)) | ||
| 88 | ** Disable DHCP: ##dhcp off## | ||
| 89 | ** Set IP address: ##ipa 0 (% style="color:blue" %)**10.0.0.80**(%%)## | ||
| 90 | ** Set IP subnet mask: ##ipm 0 (% style="color:darkgoldenrod" %)**255.255.255.0**(%%)## | ||
| 91 | ** Set default gateway: ##defr 0 **10.0.0.1**## | ||
| 92 | ** Update IP table: ##addm (% style="color:olive" %)**30**(%%) (% style="color:orange" %)**10.0.0.10**(%%)## | ||
| 93 | ** Set hostname: ##host (% style="color:purple" %)**ZNET-JBOX-RM-201**(%%)## | ||
| 94 | ** Reboot the ZUMNET-JBOX: ##reboot## | ||
| 95 | * Repeat for all ZUMNET-JBOXs on the job | ||
| 96 | |||
| 97 | === Zūm Net Specific Configuration === | ||
| 98 | |||
| 99 | Zūm Net devices have a two additional settings not present for other devices: Zūm/Cresnet mode and Master/Slave mode. | ||
| 100 | |||
| 101 | ==== Zūm/Cresnet Mode ==== | ||
| 102 | |||
| 103 | ZUMNET-JBOXs should ship in "Zūm Mode" by default, also known as "App Mode" because this is the setting required to be able to configure Zūm Wired rooms using the Crestron Zūm Mobile App. | ||
| 104 | |||
| 105 | If a ZUMNET-JBOX is put into Cresnet mode, it will no longer be able to be configured using the 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). | ||
| 106 | |||
| 107 | The commands to view or change the Zūm/Cresnet mode are: | ||
| 108 | |||
| 109 | * View current mode: ##zwmode## | ||
| 110 | * Make Zūm/App mode: ##zwmode zum## | ||
| 111 | * Make Cresnet mode: ##zwmode cnet## | ||
| 112 | |||
| 113 | 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. | ||
| 114 | |||
| 115 | ==== Master/Slave Mode ==== | ||
| 116 | |||
| 117 | ZUMNET-JBOXs should ship in "Master" mode by default, and generally this is how they should be configured. | ||
| 118 | |||
| 119 | "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: | ||
| 120 | |||
| 121 | 1. It is connected to another ZUMNET-JBOX via the Zūm Link bus | ||
| 122 | 1. It is being used as a Cresnet device, connected to a processor or DIN-CENCN-2 using a Cresnet/Zūm Link adapter | ||
| 123 | |||
| 124 | The commands to view or change the Master/Slave mode are: | ||
| 125 | |||
| 126 | * View current mode: ##zwms## | ||
| 127 | * Make "master": ##zwms master## | ||
| 128 | * Make "slave": ##zwms slave## | ||
| 129 | |||
| 130 | A reboot is required if the mode is to be changed. | ||
| 131 | |||
| 132 | === Changing IP-IDs === | ||
| 133 | |||
| 134 | 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. | ||
| 135 | |||
| 136 | 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. | ||
| 137 | |||
| 138 | 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## | ||
| 139 | |||
| 140 | Below are two snippets from a configuration file comparing a ZUMNET-JBOX-16A-LV lighting controller and it's associated entry in ##"IpDevices"##: | ||
| 141 | |||
| 142 | [[image:1655247008527-737.png]] | ||
| 143 | |||
| 144 | [[image:1655246948921-246.png]] |