Wiki source code of Zūm Discovery

Version 13.1 by Alexander Mott on 2022/10/10 23:33

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