Wiki source code of Zūm Discovery

Version 10.1 by Alexander Mott on 2022/10/05 16:18

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