Skip to Content

Changes for page Zūm Discovery

Last modified by Alexander Mott on 2025/04/03 17:35
From version 1.2
edited by Alexander Mott
on 2022/09/22 21:31
Change comment: There is no comment for this version
To version 6.3
edited by Alexander Mott
on 2022/09/22 23:37
Change comment: (Autosaved)

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Zūm Autodiscovery
1 +Zūm Discovery
Content
... ... @@ -1,6 +1,6 @@
1 1  (% class="box warningmessage" %)
2 2  (((
3 -This article is about automatically building a SHOWRUNNER™ configuration using the Zūm Autodiscovery 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]].
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 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 5  )))
6 6  
... ... @@ -10,29 +10,265 @@
10 10  
11 11  (% class="row" %)
12 12  (((
13 -Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
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 14  
15 -= Para 1 =
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 16  
17 -Lorem
17 += Zūm Wired Discovery =
18 18  
19 -== Sub 1 ==
19 +== Notes and Limitations ==
20 20  
21 -Lorem
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
22 22  
23 -== Sub 2 ==
27 +== Steps ==
24 24  
25 -Lorem
29 +1.
26 26  
27 -= Para 2 =
31 += Zūm Wireless Discovery =
28 28  
29 -Lorem
33 +== Notes and Limitations ==
30 30  
31 -== Sub 1 ==
35 +* Processor with SHOWRUNNER™ version 2.190 or newer must be running on the same network as the gateway(s) to be acquired
36 +** For SHOWRUNNER™ versions 3.014 and newer, replace ##sr discover zum## commands with ##sr discover zummesh##
37 +* ZUM-NETBRIDGES must already be acquired to their respective gateway
38 +* SHOWRUNNER™ will automatically address any ZUM-NETBRIDGES that do not need have addresses assigned, but will still honor any already addressed devices
39 +* Disconnect from any RF gateways you may be connected to in Toolbox prior to running the discovery command
40 +* Plug loads will not appear in the SHOWRUNNER™ UI
41 +)))
32 32  
33 -Lorem
43 +(% class="box warningmessage" id="HCaution:" %)
44 +(((
45 +**Note:** SHOWRUNNER™ has two different approaches for Zūm Wireless Discovery
34 34  
35 -== Sub 2 ==
47 +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.
48 +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.
49 +)))
36 36  
37 -Lorem
51 +(% class="row" %)
52 +(((
53 +== Manual RF Gateway Assignment Instructions ==
54 +
55 +Use this method if you have multiple SHOWRUNNER™ instances on the same network or have gateways used by other Crestron systems.
56 +
57 +* Connect to the processor's console with Toolbox or your favorite SSH client.
58 +* Type "//sr devmgr ethernet query//" and press enter. This queries the local network for RF Gateways.
59 +* Type "//sr devmgr ethernet show devices//" and press enter. This displays all found Crestron ethernet devices.
60 +* 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.
61 +* Type "//sr discover zum false//" and press enter.
62 +* Status messages and the results will be displayed on the console. The process should take about 3 minutes.
63 +* 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.
64 +* Type "//progreset//" and press enter to restart SHOWRUNNER™
65 +* 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.
66 +* Once completed SHOWRUNNER™ is now ready for full Zūm control
67 +
68 +== Claim All RF Gateways Instructions ==
69 +
70 +Use this method when you have a single SHOWRUNNER™ instance on a local network with all gateways being used for SHOWRUNNER™.
71 +
72 +* Connect to the processor's console with Toolbox or your favorite SSH client.
73 +* Type "//sr discover zum true//" and press enter.
74 +* Status messages and the results will be displayed on the console. The process should take about 3 minutes.
75 +* 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.
76 +* Type "//progreset//" and press enter to restart SHOWRUNNER™
77 +* 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.
78 +* Once completed SHOWRUNNER™ is now ready for full Zūm control
79 +
80 +== Examples ==
81 +
82 +=== Manual Example ===
83 +
84 +{{{MC4>sr devmgr ethernet query
85 +Ethrenet AutoDiscovery Result: AutoDiscoveryOperationSuccess
86 +MC4>sr devmgr ethernet show devices
87 +
88 ++--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
89 +| Adapter | Hostname | IP Address | IP-ID | ID |
90 ++--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
91 +| EthernetLANAdapter | CI-SJC-CEN-CI3-1-COM3 | 10.44.5.20 | 00 | CEN-CI3-1-C3COM-3 [v1.1620.00000, #008436E2] type:1 |
92 ++--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
93 +| EthernetLANAdapter | SB-DIN-CENCN-2 | 10.44.5.81 | 00 | DIN-CENCN-2-POE [v1.3544.00006, #8AB25AA3] |
94 ++--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
95 +| EthernetLANAdapter | CEN-GWEXER-9E6ADA | 10.44.5.120 | 00 | CEN-GWEXER [v1.4230.00015, #848210AD] |
96 ++--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
97 +
98 +MC4>sr ethernet device claim CEN-GWEXER-9E6ADA
99 +Claimed ethernet device: CEN-GWEXER-9E6ADA
100 +MC4>Update request from IP-ID-30 in Program 01
101 +MC4>sr discover zum false
102 +Starting Zum Discovery without gateway claiming
103 +MC4>Performing Discovery on 1 Gateways.
104 +Evaluating 3 Devices on Gateway 30
105 +Claiming ZUM-NETBRIDGE SN: 1726NEJ01096 from IP-ID: 30
106 +Dev: ZUM-NETBRIDGE addrssing to RF ID: 03
107 +Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 03
108 +Claiming ZUM-NETBRIDGE SN: 1914NEJ03096 from IP-ID: 30
109 +Dev: ZUM-NETBRIDGE addrssing to RF ID: 04
110 +Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 04
111 +Claiming ZUM-NETBRIDGE SN: 1914NEJ03098 from IP-ID: 30
112 +Dev: ZUM-NETBRIDGE addrssing to RF ID: 05
113 +Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 05
114 +Querying cresnet
115 +Discovering Zum Loads on 1 Gateways.
116 +Discovering Zum Loads on 3 Devices.
117 +NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0
118 +Device: ZUM Netbridge 30:03 at 30:03 discovery result: .
119 +NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0
120 +Device: ZUM Netbridge 30:04 at 30:04 discovery result: .
121 +NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0
122 +Device: ZUM Netbridge 30:05 at 30:05 discovery result: .
123 +RF Gateways: 0
124 +RF Devices: 3
125 +New Loads: 0
126 +Modified Loads: 0
127 +Removed Loads: 0
128 +Zum Discovery Finished
129 +MC4>sr save
130 +Saved config
131 +MC4>progreset
132 +...
133 +CI ShowRunner startup completed successfully in 8072ms
134 +MC4>sr discover zum false
135 +Starting Zum Discovery without gateway claiming
136 +MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
137 +Performing Discovery on 1 Gateways.
138 +Evaluating 3 Devices on Gateway 30
139 +Claiming ZUM-NETBRIDGE SN: 1726NEJ01096 from IP-ID: 30
140 +Dev: ZUMMESH-NETBRIDGE already claimed at RF ID: 03
141 +Claiming ZUM-NETBRIDGE SN: 1914NEJ03096 from IP-ID: 30
142 +Dev: ZUMMESH-NETBRIDGE already claimed at RF ID: 04
143 +Claiming ZUM-NETBRIDGE SN: 1914NEJ03098 from IP-ID: 30
144 +Dev: ZUMMESH-NETBRIDGE already claimed at RF ID: 05
145 +Discovering Zum Loads on 1 Gateways.
146 +Discovering Zum Loads on 3 Devices.
147 +Evaluating Device: ZUM-BLE ShortAddress: FFFA Type: BLERadio
148 +Evaluating Device: ZUM-JBOX-20A-PLUG ShortAddress: 0000 Type: PlugLoad
149 +Evaluating Device: ZUM-KP10C-BATT ShortAddress: 52E5 Type: Keypad
150 +Evaluating Device: ZUM-PIR-OCC-BATT ShortAddress: DAF1 Type: OccupancySensor
151 +Evaluating Device: ZUM-JBOX-5A-LV ShortAddress: 92EF Type: DimmableLoad
152 +Load: Load37615 Added
153 +NETBIRDGE: NewLoads: 1 ModifiedLoads: 0 RemovedLoads: 0
154 +Device: ZUM Netbridge 30:03 at 30:03 discovery result: .
155 +Evaluating Device: ZUM-BLE ShortAddress: FFFA Type: BLERadio
156 +Evaluating Device: ZUM-DALI ShortAddress: 740D Type: Unknown
157 +Evaluating Device: ZUM-5A-LV ShortAddress: 0482 Type: DimmableLoad
158 +Load: Load1154 Added
159 +Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: 0000 Type: DimmableLoad
160 +Load: Load0 Added
161 +Evaluating Device: ZUM-KP10C-BATT ShortAddress: D766 Type: Keypad
162 +Evaluating Device: ZUM-OL-PHO-BATT ShortAddress: 95ED Type: Photocell
163 +Evaluating Device: ZUM-PIR-OCC-BATT ShortAddress: 44C2 Type: OccupancySensor
164 +Evaluating Device: ZUM-DALI-GROUP ShortAddress: 740D Type: Unknown
165 +Evaluating Device: ZUM-DALI-GROUP ShortAddress: 740D Type: Unknown
166 +NETBIRDGE: NewLoads: 2 ModifiedLoads: 0 RemovedLoads: 0
167 +Device: ZUM Netbridge 30:04 at 30:04 discovery result: .
168 +Evaluating Device: ZUM-BLE ShortAddress: FFFA Type: BLERadio
169 +Evaluating Device: ZUM-SIM ShortAddress: 0000 Type: OccupancySensor, PartitionSensor
170 +Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: EBCF Type: DimmableLoad
171 +Load: Load60367 Added
172 +Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: 3CC1 Type: DimmableLoad
173 +Load: Load15553 Added
174 +Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: F94A Type: DimmableLoad
175 +Load: Load63818 Added
176 +NETBIRDGE: NewLoads: 3 ModifiedLoads: 0 RemovedLoads: 0
177 +Device: ZUM Netbridge 30:05 at 30:05 discovery result: .
178 +RF Gateways: 0
179 +RF Devices: 3
180 +New Loads: 6
181 +Modified Loads: 0
182 +Removed Loads: 0
183 +Zum Discovery Finished}}}
184 +
185 +=== Claim All Example ===
186 +
187 +{{{MC4>sr discover zum true
188 +Starting Zum Discovery with gateway claiming
189 +MC4>Found 1 Gateways to check.
190 +Claimed Gateway SN: 1720JBH04269 at IP-ID: 30
191 +Update request from IP-ID-30 in Program 01
192 +Claimed 1 Gateways. Waiting for queries to finish.
193 +Performing Discovery on 1 Gateways.
194 +Evaluating 3 Devices on Gateway 30
195 +Claiming ZUM-NETBRIDGE SN: 1726NEJ01096 from IP-ID: 30
196 +Dev: ZUM-NETBRIDGE addrssing to RF ID: 03
197 +Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 03
198 +Claiming ZUM-NETBRIDGE SN: 1914NEJ03096 from IP-ID: 30
199 +Dev: ZUM-NETBRIDGE addrssing to RF ID: 04
200 +Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 04
201 +Claiming ZUM-NETBRIDGE SN: 1914NEJ03098 from IP-ID: 30
202 +Dev: ZUM-NETBRIDGE addrssing to RF ID: 05
203 +Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 05
204 +Discovering Zum Loads on 1 Gateways.
205 +Discovering Zum Loads on 3 Devices.
206 +NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0
207 +Device: ZUM Netbridge 30:03 at 30:03 discovery result: .
208 +NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0
209 +Device: ZUM Netbridge 30:04 at 30:04 discovery result: .
210 +NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0
211 +Device: ZUM Netbridge 30:05 at 30:05 discovery result: .
212 +RF Gateways: 0
213 +RF Devices: 3
214 +New Loads: 0
215 +Modified Loads: 0
216 +Removed Loads: 0
217 +Zum Discovery Finished
218 +MC4>sr save
219 +Saved config
220 +MC4>progreset
221 +...
222 +CI ShowRunner startup completed successfully in 8072ms
223 +MC4>sr discover zum false
224 +Starting Zum Discovery without gateway claiming
225 +MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
226 +Performing Discovery on 1 Gateways.
227 +Evaluating 3 Devices on Gateway 30
228 +Claiming ZUM-NETBRIDGE SN: 1726NEJ01096 from IP-ID: 30
229 +Dev: ZUMMESH-NETBRIDGE already claimed at RF ID: 03
230 +Claiming ZUM-NETBRIDGE SN: 1914NEJ03096 from IP-ID: 30
231 +Dev: ZUMMESH-NETBRIDGE already claimed at RF ID: 04
232 +Claiming ZUM-NETBRIDGE SN: 1914NEJ03098 from IP-ID: 30
233 +Dev: ZUMMESH-NETBRIDGE already claimed at RF ID: 05
234 +Discovering Zum Loads on 1 Gateways.
235 +Discovering Zum Loads on 3 Devices.
236 +Evaluating Device: ZUM-BLE ShortAddress: FFFA Type: BLERadio
237 +Evaluating Device: ZUM-JBOX-20A-PLUG ShortAddress: 0000 Type: PlugLoad
238 +Evaluating Device: ZUM-KP10C-BATT ShortAddress: 52E5 Type: Keypad
239 +Evaluating Device: ZUM-PIR-OCC-BATT ShortAddress: DAF1 Type: OccupancySensor
240 +Evaluating Device: ZUM-JBOX-5A-LV ShortAddress: 92EF Type: DimmableLoad
241 +Load: Load37615 Added
242 +NETBIRDGE: NewLoads: 1 ModifiedLoads: 0 RemovedLoads: 0
243 +Device: ZUM Netbridge 30:03 at 30:03 discovery result: .
244 +Evaluating Device: ZUM-BLE ShortAddress: FFFA Type: BLERadio
245 +Evaluating Device: ZUM-DALI ShortAddress: 740D Type: Unknown
246 +Evaluating Device: ZUM-5A-LV ShortAddress: 0482 Type: DimmableLoad
247 +Load: Load1154 Added
248 +Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: 0000 Type: DimmableLoad
249 +Load: Load0 Added
250 +Evaluating Device: ZUM-KP10C-BATT ShortAddress: D766 Type: Keypad
251 +Evaluating Device: ZUM-OL-PHO-BATT ShortAddress: 95ED Type: Photocell
252 +Evaluating Device: ZUM-PIR-OCC-BATT ShortAddress: 44C2 Type: OccupancySensor
253 +Evaluating Device: ZUM-DALI-GROUP ShortAddress: 740D Type: Unknown
254 +Evaluating Device: ZUM-DALI-GROUP ShortAddress: 740D Type: Unknown
255 +NETBIRDGE: NewLoads: 2 ModifiedLoads: 0 RemovedLoads: 0
256 +Device: ZUM Netbridge 30:04 at 30:04 discovery result: .
257 +Evaluating Device: ZUM-BLE ShortAddress: FFFA Type: BLERadio
258 +Evaluating Device: ZUM-SIM ShortAddress: 0000 Type: OccupancySensor, PartitionSensor
259 +Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: EBCF Type: DimmableLoad
260 +Load: Load60367 Added
261 +Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: 3CC1 Type: DimmableLoad
262 +Load: Load15553 Added
263 +Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: F94A Type: DimmableLoad
264 +Load: Load63818 Added
265 +NETBIRDGE: NewLoads: 3 ModifiedLoads: 0 RemovedLoads: 0
266 +Device: ZUM Netbridge 30:05 at 30:05 discovery result: .
267 +RF Gateways: 0
268 +RF Devices: 3
269 +New Loads: 6
270 +Modified Loads: 0
271 +Removed Loads: 0
272 +Zum Discovery Finished
273 +}}}
38 38  )))