Wiki source code of Zūm Discovery

Version 8.1 by Alexander Mott on 2022/09/23 00:00

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