Wiki source code of Zūm Discovery

Version 7.1 by Alexander Mott on 2022/09/22 23:59

Hide last authors
Alexander Mott 1.1 1 (% class="box warningmessage" %)
2 (((
Alexander Mott 5.2 3 This article is about automatically building a SHOWRUNNER™ configuration using the Zūm Discovery feature of SHOWRUNNER™. 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]].
Alexander Mott 1.1 4 For instructions on configuring Zūm Net devices using Crestron Toolbox, see [[this page>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.ZUMNET-JBOX Setup.WebHome]].
5 )))
6
7 {{box cssClass="floatinginfobox" title="**CONTENTS**"}}
8 {{toc/}}
9 {{/box}}
10
11 (% class="row" %)
12 (((
Alexander Mott 6.1 13 If Zūm Wired or Wireless devices have been configured using Crestron's Zūm App, then it is possible to automatically build a SHOWRUNNER™ configuration file using the Zūm Discovery feature that is built into SHOWRUNNER™.
Alexander Mott 1.1 14
Alexander Mott 5.2 15 There are certain pre-requisites and limitations when building a SHOWRUNNER™ configuration this way, and it may sometimes be necessary make some adjustments to the final configuration, such as changing keypad types and moving loads between areas.
Alexander Mott 1.1 16
Alexander Mott 5.2 17 = Zūm Wired Discovery =
18
Alexander Mott 6.1 19 == Notes and Limitations ==
Alexander Mott 1.1 20
Alexander Mott 6.1 21 * SHOWRUNNER™ version 3.014 or newer required
Alexander Mott 6.2 22 * Zūm Wired firmware version 1.02.10 or greater required
23 * Disconnect from any ZUMNET devices you may be connected to in Toolbox prior to running the discovery commands
24 * Cresnet devices landed on Zūm Link will not be discovered (Crestron bug expected to be corrected in a future firmware release)
25 * One area will be created per ZUMNET-JBOX; if there are more areas than ZUMNET-JBOXs, additional areas must be created manually
Alexander Mott 6.1 26
Alexander Mott 6.2 27 == Steps ==
28
Alexander Mott 7.1 29 1. [[Install SHOWRUNNER™>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.WebHome]] on the processor and configure the processor as necessary
30 1*. Note that while Zūm Wired discovery will build a configuration, if a configuration file was provided then it should still be loaded as it may contain location data or non-Zūm devices.
31 1. If the ZUMNET-JBOX firmware is too out-of-date to connect using the Crestron Zūm App, then there are some additional steps required: 
32 1*. Connect to the first ZUMNET-JBOX in Toolbox
33 1*. Configure a static IP address for the ZUMNET-JBOX if there is no DHCP server on the network 
34 1**. Note: The SHOWRUNNER™ built-in DHCP server is not meant to be used in production
35 1**. If the SHOWRUNNER™ built-in DHCP server was used to assign IP addresses to devices, it is still necessary to give those devices static IP addresses
36 1*. Set unique Connection IDs for each device hosted on the ZUMNET-JBOX so that their firmware can be updated
37 1*. Load the Zūm Wired firmware to the ZUMNET-JBOX
38 1*. Repeat the above steps for all ZUMNET-JBOXs
39 1*. Once all the ZUMNET-JBOXs have pushed the new firmware to their hosted devices, proceed to the next step
40 1. Connect to first ZUMNET-JBOX in the Crestron Zūm App
41 1. Unique Connection IDs should be automatically assigned to any Zūm Link and Cresnet devices on the ZUMNET-JBOX
42 1*. If firmware was out-of-date, then this step should have already been completed
43 1*. If unique CIDs are not automatically assigned, connect to the JBOX in Toolbox and give the devices unique CIDs
44 1. Configure a static IP address for the ZUMNET-JBOX if there is no DHCP server on the network 
45 1*. If firmware was out-of-date, then this step should have already been completed
46 1*. Note: The SHOWRUNNER™ built-in DHCP server is not meant to be used in production
47 1*. If the SHOWRUNNER™ built-in DHCP server was used to assign IP addresses to devices, it is still necessary to give those devices static IP addresses
48 1. Optionally, manually configure the ZUMNET-JBOX IP table to point at the processor if you want to keep track of which ZUMNET-JBOX is at each IP-ID
49 1*. If you do not manually configure the IP table, then SHOWRUNNER™ will automatically configure the IP-ID for each ZUMNET-JBOX during discovery
50 1. Repeat from step 3 until all ZUMNET-JBOXs that are to be controlled by SHOWRUNNER™ have static IP addresses and unique CIDs for any hosted devices
51 1. Connect to the processor in Toolbox and run the command: ##sr discover zumnet true false##
52 1*. This command tells SHOWRUNNER™ to discover all ZUMMNET-JBOXs on the network, configure their IP tables, and then add corresponding areas and loads to the configuration
53 1*. One area will be created per ZUMNET-JBOX
54 1. Run the command: ##sr discover zumnet true true##
55 1*. This command tells SHOWRUNNER™ to discover all Zūm Link hardware on the previously discovered Zūm Net devices
56 1*. This command **does not** bring in Cresnet devices: those must be added to the configuration manually until this issue is fixed in the Zūm Wired firmware
57 1. Put all ZUMNET-JBOXs into CNET mode in order to allow full control from SHOWRUNNER™
58 1*. Odd behavior may result from conflicts between SHOWRUNNER™ and internal logic if the ZUMNET-JBOXs are not put into CNET mode
Alexander Mott 6.2 59
Alexander Mott 5.2 60 = Zūm Wireless Discovery =
Alexander Mott 1.1 61
Alexander Mott 5.2 62 == Notes and Limitations ==
Alexander Mott 1.1 63
Alexander Mott 6.1 64 * Processor with SHOWRUNNER™ version 2.190 or newer must be running on the same network as the gateway(s) to be acquired
Alexander Mott 6.2 65 ** For SHOWRUNNER™ versions 3.014 and newer, replace ##sr discover zum## commands with ##sr discover zummesh##
Alexander Mott 6.1 66 * ZUM-NETBRIDGES must already be acquired to their respective gateway
67 * SHOWRUNNER™ will automatically address any ZUM-NETBRIDGES that do not need have addresses assigned, but will still honor any already addressed devices
68 * Disconnect from any RF gateways you may be connected to in Toolbox prior to running the discovery command
69 * Plug loads will not appear in the SHOWRUNNER™ UI
Alexander Mott 4.1 70 )))
Alexander Mott 1.1 71
Alexander Mott 3.1 72 (% class="box warningmessage" id="HCaution:" %)
73 (((
Alexander Mott 6.1 74 **Note:** SHOWRUNNER™ has two different approaches for Zūm Wireless Discovery
Alexander Mott 4.1 75
76 1. **Manual RF Gateway Assignment** - SHOWRUNNER™ can be told which gateways it should scan. Use this approach if you have gateways that are used by multiple systems on the same local network.
77 1. **Claim All RF Gateways** - SHOWRUNNER™ will find all CEN-GWEXERs [ZUMNET-GATEWAY] on the network and will claim them as its own. **DO NOT** use this method if there are gateways used by different SHOWRUNNER™ or other Crestron systems on the same local network.
Alexander Mott 3.1 78 )))
Alexander Mott 1.1 79
Alexander Mott 4.1 80 (% class="row" %)
81 (((
Alexander Mott 6.2 82 == Manual RF Gateway Assignment Instructions ==
Alexander Mott 1.1 83
Alexander Mott 5.1 84 Use this method if you have multiple SHOWRUNNER™ instances on the same network or have gateways used by other Crestron systems.
Alexander Mott 1.1 85
Alexander Mott 2.1 86 * Connect to the processor's console with Toolbox or your favorite SSH client.
Alexander Mott 4.1 87 * Type "//sr devmgr ethernet query//" and press enter. This queries the local network for RF Gateways.
88 * Type "//sr devmgr ethernet show devices//" and press enter. This displays all found Crestron ethernet devices.
Alexander Mott 5.1 89 * For each gateway that you'd like this instance of SHOWRUNNER™ to use, use the hostname from the table of found ethernet devices. For example if the gateway Hostname is CEN-GWEXER-9E6ADA type "//sr ethernet device claim CEN-GWEXER-9E6ADA//". SHOWRUNNER™ will auto-assign an IP-ID. After all gateways have been claimed by SHOWRUNNER™, proceed to the next step.
Alexander Mott 4.1 90 * Type "//sr discover zum false//" and press enter.
Alexander Mott 5.1 91 * Status messages and the results will be displayed on the console. The process should take about 3 minutes.
92 * When the discovery is finished type "//sr save//" and press enter to save the updated config. Due to an unknown quirk that we are looking into, SHOWRUNNER™ must be restarted to complete the acquire process.
93 * Type "//progreset//" and press enter to restart SHOWRUNNER™
94 * Once SHOWRUNNER™ has finished restarting type "//sr discover zum false//" and press enter. SHOWRUNNER™ will be able to acquire the loads attached to the Zūm rooms at this point.
95 * Once completed SHOWRUNNER™ is now ready for full Zūm control
Alexander Mott 2.1 96
Alexander Mott 6.2 97 == Claim All RF Gateways Instructions ==
Alexander Mott 2.1 98
Alexander Mott 5.1 99 Use this method when you have a single SHOWRUNNER™ instance on a local network with all gateways being used for SHOWRUNNER™.
Alexander Mott 2.1 100
101 * Connect to the processor's console with Toolbox or your favorite SSH client.
Alexander Mott 4.1 102 * Type "//sr discover zum true//" and press enter.
Alexander Mott 5.1 103 * Status messages and the results will be displayed on the console. The process should take about 3 minutes.
104 * When the discovery is finished type "//sr save//" and press enter to save the updated config. Due to an unknown quirk that we are looking into, SHOWRUNNER™ must be restarted to complete the acquire process.
105 * Type "//progreset//" and press enter to restart SHOWRUNNER™
106 * Once SHOWRUNNER™ has finished restarting type "//sr discover zum false//" and press enter. SHOWRUNNER™ will be able to acquire the loads attached to the Zūm rooms at this point.
107 * Once completed SHOWRUNNER™ is now ready for full Zūm control
Alexander Mott 2.1 108
109 == Examples ==
110
Alexander Mott 5.2 111 === Manual Example ===
Alexander Mott 4.1 112
113 {{{MC4>sr devmgr ethernet query
114 Ethrenet AutoDiscovery Result: AutoDiscoveryOperationSuccess
115 MC4>sr devmgr ethernet show devices
116
117 +--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
118 | Adapter | Hostname | IP Address | IP-ID | ID |
119 +--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
120 | EthernetLANAdapter | CI-SJC-CEN-CI3-1-COM3 | 10.44.5.20 | 00 | CEN-CI3-1-C3COM-3 [v1.1620.00000, #008436E2] type:1 |
121 +--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
122 | EthernetLANAdapter | SB-DIN-CENCN-2 | 10.44.5.81 | 00 | DIN-CENCN-2-POE [v1.3544.00006, #8AB25AA3] |
123 +--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
124 | EthernetLANAdapter | CEN-GWEXER-9E6ADA | 10.44.5.120 | 00 | CEN-GWEXER [v1.4230.00015, #848210AD] |
125 +--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
126
127 MC4>sr ethernet device claim CEN-GWEXER-9E6ADA
128 Claimed ethernet device: CEN-GWEXER-9E6ADA
129 MC4>Update request from IP-ID-30 in Program 01
130 MC4>sr discover zum false
131 Starting Zum Discovery without gateway claiming
132 MC4>Performing Discovery on 1 Gateways.
Alexander Mott 2.1 133 Evaluating 3 Devices on Gateway 30
134 Claiming ZUM-NETBRIDGE SN: 1726NEJ01096 from IP-ID: 30
135 Dev: ZUM-NETBRIDGE addrssing to RF ID: 03
136 Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 03
137 Claiming ZUM-NETBRIDGE SN: 1914NEJ03096 from IP-ID: 30
138 Dev: ZUM-NETBRIDGE addrssing to RF ID: 04
139 Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 04
140 Claiming ZUM-NETBRIDGE SN: 1914NEJ03098 from IP-ID: 30
141 Dev: ZUM-NETBRIDGE addrssing to RF ID: 05
142 Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 05
Alexander Mott 4.1 143 Querying cresnet
Alexander Mott 2.1 144 Discovering Zum Loads on 1 Gateways.
145 Discovering Zum Loads on 3 Devices.
146 NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0
147 Device: ZUM Netbridge 30:03 at 30:03 discovery result: .
148 NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0
149 Device: ZUM Netbridge 30:04 at 30:04 discovery result: .
150 NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0
151 Device: ZUM Netbridge 30:05 at 30:05 discovery result: .
152 RF Gateways: 0
153 RF Devices: 3
154 New Loads: 0
155 Modified Loads: 0
156 Removed Loads: 0
157 Zum Discovery Finished
158 MC4>sr save
159 Saved config
160 MC4>progreset
161 ...
162 CI ShowRunner startup completed successfully in 8072ms
163 MC4>sr discover zum false
164 Starting Zum Discovery without gateway claiming
165 MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
166 Performing Discovery on 1 Gateways.
167 Evaluating 3 Devices on Gateway 30
168 Claiming ZUM-NETBRIDGE SN: 1726NEJ01096 from IP-ID: 30
169 Dev: ZUMMESH-NETBRIDGE already claimed at RF ID: 03
170 Claiming ZUM-NETBRIDGE SN: 1914NEJ03096 from IP-ID: 30
171 Dev: ZUMMESH-NETBRIDGE already claimed at RF ID: 04
172 Claiming ZUM-NETBRIDGE SN: 1914NEJ03098 from IP-ID: 30
173 Dev: ZUMMESH-NETBRIDGE already claimed at RF ID: 05
174 Discovering Zum Loads on 1 Gateways.
175 Discovering Zum Loads on 3 Devices.
176 Evaluating Device: ZUM-BLE ShortAddress: FFFA Type: BLERadio
177 Evaluating Device: ZUM-JBOX-20A-PLUG ShortAddress: 0000 Type: PlugLoad
178 Evaluating Device: ZUM-KP10C-BATT ShortAddress: 52E5 Type: Keypad
179 Evaluating Device: ZUM-PIR-OCC-BATT ShortAddress: DAF1 Type: OccupancySensor
180 Evaluating Device: ZUM-JBOX-5A-LV ShortAddress: 92EF Type: DimmableLoad
181 Load: Load37615 Added
182 NETBIRDGE: NewLoads: 1 ModifiedLoads: 0 RemovedLoads: 0
183 Device: ZUM Netbridge 30:03 at 30:03 discovery result: .
184 Evaluating Device: ZUM-BLE ShortAddress: FFFA Type: BLERadio
185 Evaluating Device: ZUM-DALI ShortAddress: 740D Type: Unknown
186 Evaluating Device: ZUM-5A-LV ShortAddress: 0482 Type: DimmableLoad
187 Load: Load1154 Added
188 Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: 0000 Type: DimmableLoad
189 Load: Load0 Added
190 Evaluating Device: ZUM-KP10C-BATT ShortAddress: D766 Type: Keypad
191 Evaluating Device: ZUM-OL-PHO-BATT ShortAddress: 95ED Type: Photocell
192 Evaluating Device: ZUM-PIR-OCC-BATT ShortAddress: 44C2 Type: OccupancySensor
193 Evaluating Device: ZUM-DALI-GROUP ShortAddress: 740D Type: Unknown
194 Evaluating Device: ZUM-DALI-GROUP ShortAddress: 740D Type: Unknown
195 NETBIRDGE: NewLoads: 2 ModifiedLoads: 0 RemovedLoads: 0
196 Device: ZUM Netbridge 30:04 at 30:04 discovery result: .
197 Evaluating Device: ZUM-BLE ShortAddress: FFFA Type: BLERadio
198 Evaluating Device: ZUM-SIM ShortAddress: 0000 Type: OccupancySensor, PartitionSensor
199 Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: EBCF Type: DimmableLoad
200 Load: Load60367 Added
201 Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: 3CC1 Type: DimmableLoad
202 Load: Load15553 Added
203 Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: F94A Type: DimmableLoad
204 Load: Load63818 Added
205 NETBIRDGE: NewLoads: 3 ModifiedLoads: 0 RemovedLoads: 0
206 Device: ZUM Netbridge 30:05 at 30:05 discovery result: .
207 RF Gateways: 0
208 RF Devices: 3
209 New Loads: 6
210 Modified Loads: 0
211 Removed Loads: 0
Alexander Mott 4.1 212 Zum Discovery Finished}}}
Alexander Mott 2.1 213
Alexander Mott 5.1 214 === Claim All Example ===
Alexander Mott 2.1 215
Alexander Mott 4.1 216 {{{MC4>sr discover zum true
217 Starting Zum Discovery with gateway claiming
218 MC4>Found 1 Gateways to check.
219 Claimed Gateway SN: 1720JBH04269 at IP-ID: 30
220 Update request from IP-ID-30 in Program 01
221 Claimed 1 Gateways. Waiting for queries to finish.
222 Performing Discovery on 1 Gateways.
Alexander Mott 2.1 223 Evaluating 3 Devices on Gateway 30
224 Claiming ZUM-NETBRIDGE SN: 1726NEJ01096 from IP-ID: 30
225 Dev: ZUM-NETBRIDGE addrssing to RF ID: 03
226 Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 03
227 Claiming ZUM-NETBRIDGE SN: 1914NEJ03096 from IP-ID: 30
228 Dev: ZUM-NETBRIDGE addrssing to RF ID: 04
229 Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 04
230 Claiming ZUM-NETBRIDGE SN: 1914NEJ03098 from IP-ID: 30
231 Dev: ZUM-NETBRIDGE addrssing to RF ID: 05
232 Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 05
233 Discovering Zum Loads on 1 Gateways.
234 Discovering Zum Loads on 3 Devices.
235 NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0
236 Device: ZUM Netbridge 30:03 at 30:03 discovery result: .
237 NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0
238 Device: ZUM Netbridge 30:04 at 30:04 discovery result: .
239 NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0
240 Device: ZUM Netbridge 30:05 at 30:05 discovery result: .
241 RF Gateways: 0
242 RF Devices: 3
243 New Loads: 0
244 Modified Loads: 0
245 Removed Loads: 0
246 Zum Discovery Finished
247 MC4>sr save
248 Saved config
249 MC4>progreset
250 ...
251 CI ShowRunner startup completed successfully in 8072ms
252 MC4>sr discover zum false
253 Starting Zum Discovery without gateway claiming
254 MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
255 Performing Discovery on 1 Gateways.
256 Evaluating 3 Devices on Gateway 30
257 Claiming ZUM-NETBRIDGE SN: 1726NEJ01096 from IP-ID: 30
258 Dev: ZUMMESH-NETBRIDGE already claimed at RF ID: 03
259 Claiming ZUM-NETBRIDGE SN: 1914NEJ03096 from IP-ID: 30
260 Dev: ZUMMESH-NETBRIDGE already claimed at RF ID: 04
261 Claiming ZUM-NETBRIDGE SN: 1914NEJ03098 from IP-ID: 30
262 Dev: ZUMMESH-NETBRIDGE already claimed at RF ID: 05
263 Discovering Zum Loads on 1 Gateways.
264 Discovering Zum Loads on 3 Devices.
265 Evaluating Device: ZUM-BLE ShortAddress: FFFA Type: BLERadio
266 Evaluating Device: ZUM-JBOX-20A-PLUG ShortAddress: 0000 Type: PlugLoad
267 Evaluating Device: ZUM-KP10C-BATT ShortAddress: 52E5 Type: Keypad
268 Evaluating Device: ZUM-PIR-OCC-BATT ShortAddress: DAF1 Type: OccupancySensor
269 Evaluating Device: ZUM-JBOX-5A-LV ShortAddress: 92EF Type: DimmableLoad
270 Load: Load37615 Added
271 NETBIRDGE: NewLoads: 1 ModifiedLoads: 0 RemovedLoads: 0
272 Device: ZUM Netbridge 30:03 at 30:03 discovery result: .
273 Evaluating Device: ZUM-BLE ShortAddress: FFFA Type: BLERadio
274 Evaluating Device: ZUM-DALI ShortAddress: 740D Type: Unknown
275 Evaluating Device: ZUM-5A-LV ShortAddress: 0482 Type: DimmableLoad
276 Load: Load1154 Added
277 Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: 0000 Type: DimmableLoad
278 Load: Load0 Added
279 Evaluating Device: ZUM-KP10C-BATT ShortAddress: D766 Type: Keypad
280 Evaluating Device: ZUM-OL-PHO-BATT ShortAddress: 95ED Type: Photocell
281 Evaluating Device: ZUM-PIR-OCC-BATT ShortAddress: 44C2 Type: OccupancySensor
282 Evaluating Device: ZUM-DALI-GROUP ShortAddress: 740D Type: Unknown
283 Evaluating Device: ZUM-DALI-GROUP ShortAddress: 740D Type: Unknown
284 NETBIRDGE: NewLoads: 2 ModifiedLoads: 0 RemovedLoads: 0
285 Device: ZUM Netbridge 30:04 at 30:04 discovery result: .
286 Evaluating Device: ZUM-BLE ShortAddress: FFFA Type: BLERadio
287 Evaluating Device: ZUM-SIM ShortAddress: 0000 Type: OccupancySensor, PartitionSensor
288 Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: EBCF Type: DimmableLoad
289 Load: Load60367 Added
290 Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: 3CC1 Type: DimmableLoad
291 Load: Load15553 Added
292 Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: F94A Type: DimmableLoad
293 Load: Load63818 Added
294 NETBIRDGE: NewLoads: 3 ModifiedLoads: 0 RemovedLoads: 0
295 Device: ZUM Netbridge 30:05 at 30:05 discovery result: .
296 RF Gateways: 0
297 RF Devices: 3
298 New Loads: 6
299 Modified Loads: 0
300 Removed Loads: 0
301 Zum Discovery Finished
Alexander Mott 4.1 302 }}}
Alexander Mott 1.1 303 )))