Skip to Content

Changes for page Zūm Discovery

Last modified by Alexander Mott on 2025/04/03 17:35
From version 3.1
edited by Alexander Mott
on 2022/09/22 21:47
Change comment: There is no comment for this version
To version 6.5
edited by Alexander Mott
on 2022/09/22 23:47
Change comment: (Autosaved)

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,70 +10,97 @@
10 10  
11 11  (% class="row" %)
12 12  (((
13 -If Zūm Net devices have been configured using Crestron's Zūm App
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 14  
15 -= Zūm Wired =
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 -= Zūm Wireless =
19 +== Notes and Limitations ==
20 20  
21 +* SHOWRUNNER™ version 3.014 or newer required
22 +* Zūm Wired firmware version 1.02.10 or greater required
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
21 21  
22 -As of version 2.190 ShowRunner can discover RF Gateways and attached Zum NETBRIDGES. ShowRunner will find all devices, set them up, create areas and loads.
23 -*Disconnect from the gateway before discovery as they cannot support multiple connections*
24 -*Plug loads do not appear in the UI*
27 +== Steps ==
25 25  
26 -== Pre-Requisites: ==
29 +1.
27 27  
28 -* Zum NETBRIDGES acquired to their respective gateway (CEN-GWEXER/ZUMNET-GATEWAY)
29 -* ShowRunner installed and running on a 3-series processor on the same network as the gateway
30 -* NETBRIDGES do not need to have addresses assigned. ShowRunner will automatically address them. If devices all already addressed then their addresses will be honored.
31 += Zūm Wireless Discovery =
31 31  
33 +== Notes and Limitations ==
34 +
35 +* Processor with SHOWRUNNER™ version 2.190 or newer must be running on the same network as the gateway(s) to be acquired
36 +** For SHOWRUNNER™ versions 3.014 and newer, replace ##sr discover zum## commands with ##sr discover zummesh##
37 +* ZUM-NETBRIDGES must already be acquired to their respective gateway
38 +* SHOWRUNNER™ will automatically address any ZUM-NETBRIDGES that do not need have addresses assigned, but will still honor any already addressed devices
39 +* Disconnect from any RF gateways you may be connected to in Toolbox prior to running the discovery command
40 +* Plug loads will not appear in the SHOWRUNNER™ UI
41 +)))
42 +
32 32  (% class="box warningmessage" id="HCaution:" %)
33 33  (((
34 -**Note,** SHOWRUNNER has two different types of Zum Wireless autodiscovery:
35 -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.
36 -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.
45 +**Note:** SHOWRUNNER™ has two different approaches for Zūm Wireless Discovery
46 +
47 +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.
48 +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.
37 37  )))
38 38  
39 -== Option 1: Claim All Gateways: ==
51 +(% class="row" %)
52 +(((
53 +== Manual RF Gateway Assignment Instructions ==
40 40  
41 -Use this method when you have a single ShowRunner instance on a local network with all gateways being used for ShowRunner.
55 +Use this method if you have multiple SHOWRUNNER™ instances on the same network or have gateways used by other Crestron systems.
42 42  
43 43  * Connect to the processor's console with Toolbox or your favorite SSH client.
44 -* Type "//sr discover zum true//" and press enter.
45 -* Status messages and the results will be displayed on the console. The process should take about 3 minutes.
46 -* 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.
47 -* Type "//progreset//" and press enter to restart ShowRunner
48 -* Once ShowRunner has finished restarting type "//sr discover zum false//" and press enter. ShowRunner will be able to acquire the loads attached to the Zum rooms at this point.
49 -* Once completed ShowRunner is now ready for full Zum control
58 +* Type "//sr devmgr ethernet query//" and press enter. This queries the local network for RF Gateways.
59 +* Type "//sr devmgr ethernet show devices//" and press enter. This displays all found Crestron ethernet devices.
60 +* 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.
61 +* Type "//sr discover zum false//" and press enter.
62 +* Status messages and the results will be displayed on the console. The process should take about 3 minutes.
63 +* 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.
64 +* Type "//progreset//" and press enter to restart SHOWRUNNER™
65 +* 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.
66 +* Once completed SHOWRUNNER™ is now ready for full Zūm control
50 50  
51 -== Option 2: Manual RF Gateway Claiming: ==
68 +== Claim All RF Gateways Instructions ==
52 52  
53 -Use this method if you have multiple ShowRunner instances on the same network or have gateways used by other Crestron systems.
70 +Use this method when you have a single SHOWRUNNER™ instance on a local network with all gateways being used for SHOWRUNNER™.
54 54  
55 55  * Connect to the processor's console with Toolbox or your favorite SSH client.
56 -* Type "//sr devmgr ethernet query//" and press enter. This queries the local network for RF Gateways.
57 -* Type "//sr devmgr ethernet show devices//" and press enter. This displays all found Crestron ethernet devices.
58 -* 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.
59 -* Type "//sr discover zum false//" and press enter.
60 -* Status messages and the results will be displayed on the console. The process should take about 3 minutes.
61 -* 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.
62 -* Type "//progreset//" and press enter to restart ShowRunner
63 -* Once ShowRunner has finished restarting type "//sr discover zum false//" and press enter. ShowRunner will be able to acquire the loads attached to the Zum rooms at this point.
64 -* Once completed ShowRunner is now ready for full Zum control
73 +* Type "//sr discover zum true//" and press enter.
74 +* Status messages and the results will be displayed on the console. The process should take about 3 minutes.
75 +* 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.
76 +* Type "//progreset//" and press enter to restart SHOWRUNNER™
77 +* 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.
78 +* Once completed SHOWRUNNER™ is now ready for full Zūm control
65 65  
66 66  == Examples ==
67 67  
68 -=== Example for Option 1: ===
82 +=== Manual Example ===
69 69  
70 -{{{MC4>sr discover zum true
71 -Starting Zum Discovery with gateway claiming
72 -MC4>Found 1 Gateways to check.
73 -Claimed Gateway SN: 1720JBH04269 at IP-ID: 30
74 -Update request from IP-ID-30 in Program 01
75 -Claimed 1 Gateways. Waiting for queries to finish.
76 -Performing Discovery on 1 Gateways.
84 +{{{MC4>sr devmgr ethernet query
85 +Ethrenet AutoDiscovery Result: AutoDiscoveryOperationSuccess
86 +MC4>sr devmgr ethernet show devices
87 +
88 ++--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
89 +| Adapter | Hostname | IP Address | IP-ID | ID |
90 ++--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
91 +| EthernetLANAdapter | CI-SJC-CEN-CI3-1-COM3 | 10.44.5.20 | 00 | CEN-CI3-1-C3COM-3 [v1.1620.00000, #008436E2] type:1 |
92 ++--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
93 +| EthernetLANAdapter | SB-DIN-CENCN-2 | 10.44.5.81 | 00 | DIN-CENCN-2-POE [v1.3544.00006, #8AB25AA3] |
94 ++--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
95 +| EthernetLANAdapter | CEN-GWEXER-9E6ADA | 10.44.5.120 | 00 | CEN-GWEXER [v1.4230.00015, #848210AD] |
96 ++--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
97 +
98 +MC4>sr ethernet device claim CEN-GWEXER-9E6ADA
99 +Claimed ethernet device: CEN-GWEXER-9E6ADA
100 +MC4>Update request from IP-ID-30 in Program 01
101 +MC4>sr discover zum false
102 +Starting Zum Discovery without gateway claiming
103 +MC4>Performing Discovery on 1 Gateways.
77 77  Evaluating 3 Devices on Gateway 30
78 78  Claiming ZUM-NETBRIDGE SN: 1726NEJ01096 from IP-ID: 30
79 79  Dev: ZUM-NETBRIDGE addrssing to RF ID: 03
... ... @@ -84,6 +84,7 @@
84 84  Claiming ZUM-NETBRIDGE SN: 1914NEJ03098 from IP-ID: 30
85 85  Dev: ZUM-NETBRIDGE addrssing to RF ID: 05
86 86  Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 05
114 +Querying cresnet
87 87  Discovering Zum Loads on 1 Gateways.
88 88  Discovering Zum Loads on 3 Devices.
89 89  NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0
... ... @@ -152,31 +152,17 @@
152 152  New Loads: 6
153 153  Modified Loads: 0
154 154  Removed Loads: 0
155 -Zum Discovery Finished
156 -}}}
183 +Zum Discovery Finished}}}
157 157  
158 -=== Example for Option 2: ===
185 +=== Claim All Example ===
159 159  
160 -{{{MC4>sr devmgr ethernet query
161 -Ethrenet AutoDiscovery Result: AutoDiscoveryOperationSuccess
162 -MC4>sr devmgr ethernet show devices
163 -
164 -+--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
165 -| Adapter | Hostname | IP Address | IP-ID | ID |
166 -+--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
167 -| EthernetLANAdapter | CI-SJC-CEN-CI3-1-COM3 | 10.44.5.20 | 00 | CEN-CI3-1-C3COM-3 [v1.1620.00000, #008436E2] type:1 |
168 -+--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
169 -| EthernetLANAdapter | SB-DIN-CENCN-2 | 10.44.5.81 | 00 | DIN-CENCN-2-POE [v1.3544.00006, #8AB25AA3] |
170 -+--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
171 -| EthernetLANAdapter | CEN-GWEXER-9E6ADA | 10.44.5.120 | 00 | CEN-GWEXER [v1.4230.00015, #848210AD] |
172 -+--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
173 -
174 -MC4>sr ethernet device claim CEN-GWEXER-9E6ADA
175 -Claimed ethernet device: CEN-GWEXER-9E6ADA
176 -MC4>Update request from IP-ID-30 in Program 01
177 -MC4>sr discover zum false
178 -Starting Zum Discovery without gateway claiming
179 -MC4>Performing Discovery on 1 Gateways.
187 +{{{MC4>sr discover zum true
188 +Starting Zum Discovery with gateway claiming
189 +MC4>Found 1 Gateways to check.
190 +Claimed Gateway SN: 1720JBH04269 at IP-ID: 30
191 +Update request from IP-ID-30 in Program 01
192 +Claimed 1 Gateways. Waiting for queries to finish.
193 +Performing Discovery on 1 Gateways.
180 180  Evaluating 3 Devices on Gateway 30
181 181  Claiming ZUM-NETBRIDGE SN: 1726NEJ01096 from IP-ID: 30
182 182  Dev: ZUM-NETBRIDGE addrssing to RF ID: 03
... ... @@ -187,7 +187,6 @@
187 187  Claiming ZUM-NETBRIDGE SN: 1914NEJ03098 from IP-ID: 30
188 188  Dev: ZUM-NETBRIDGE addrssing to RF ID: 05
189 189  Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 05
190 -Querying cresnet
191 191  Discovering Zum Loads on 1 Gateways.
192 192  Discovering Zum Loads on 3 Devices.
193 193  NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0
... ... @@ -257,5 +257,5 @@
257 257  Modified Loads: 0
258 258  Removed Loads: 0
259 259  Zum Discovery Finished
260 - }}}
273 +}}}
261 261  )))