Skip to Content

Changes for page Zūm Discovery

Last modified by Austin Weygandt on 2025/05/02 20:21
From version 1.1
edited by Alexander Mott
on 2022/09/22 21:31
Change comment: There is no comment for this version
To version 5.2
edited by Alexander Mott
on 2022/09/22 22:11
Change comment: There is no comment for this version

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