Wiki source code of Zūm Discovery

Version 14.1 by Alexander Mott on 2022/10/10 23:35

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