Wiki source code of Zūm Discovery

Version 17.1 by Alexander Mott on 2023/03/29 21:28

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