Wiki source code of Zūm Discovery

Version 9.1 by Alexander Mott on 2022/10/05 16:17

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