Skip to Content

Changes for page Zūm Discovery

Last modified by Austin Weygandt on 2025/05/02 20:21
From version 11.1
edited by Alexander Mott
on 2022/10/05 16:19
Change comment: There is no comment for this version
To version 2.1
edited by Alexander Mott
on 2022/09/22 21:44
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Zūm Discovery
1 +Zūm Autodiscovery
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 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]].
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]].
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  
... ... @@ -8,130 +8,71 @@
8 8  {{toc/}}
9 9  {{/box}}
10 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™.
11 +(% class="row" %)
12 +(((
13 +If Zūm Net devices have been configured using Crestron's Zūm App
12 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.
15 += Zūm Wired =
14 14  
15 -= Zūm Wired Discovery =
17 +Lorem
16 16  
17 -== Notes and Limitations ==
19 += Zūm Wireless =
18 18  
19 -(% class="box errormessage" %)
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
26 -)))
27 27  
28 -== Steps ==
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*
29 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. 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
52 -1. Disconnect from any ZUMNET-JBOXs and then connect to the processor in Toolbox
53 -1. Run the command: ##sr discover zumnet true false##
54 -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
55 -1*. One area will be created per ZUMNET-JBOX
56 -1. Run the command: ##sr discover zumnet true true##
57 -1*. This command tells SHOWRUNNER™ to discover all Zūm Link hardware on the previously discovered Zūm Net devices
58 -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
59 -1. Put all ZUMNET-JBOXs into CNET mode in order to allow full control from SHOWRUNNER™
60 -1*. Odd behavior may result from conflicts between SHOWRUNNER™ and internal logic if the ZUMNET-JBOXs are not put into CNET mode
26 +== **Pre-Requisites:** ==
61 61  
62 -= Zūm Wireless Discovery =
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.
63 63  
64 -== Notes and Limitations ==
32 +=== **Caution:** ===
65 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 -)))
34 +* ShowRunner has 2 discovery approaches.
35 +** Option 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 +** Option 2: 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.
75 75  
76 -(% class="box warningmessage" id="HCaution:" %)
77 -(((
78 -**Note:** SHOWRUNNER™ has two different approaches for Zūm Wireless Discovery
38 +== Option 1: Claim All Gateways: ==
79 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 -)))
40 +Use this method when you have a single ShowRunner instance on a local network with all gateways being used for ShowRunner.
83 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 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
43 +* Type "//sr discover zum true//" and press enter.
44 +* Status messages and the results will be displayed on the console. The process should take about 3 minutes.
45 +* 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.
46 +* Type "//progreset//" and press enter to restart ShowRunner
47 +* 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.
48 +* Once completed ShowRunner is now ready for full Zum control
98 98  
99 -== Claim All RF Gateways Instructions ==
50 +== Option 2: Manual RF Gateway Claiming: ==
100 100  
101 -Use this method when you have a single SHOWRUNNER™ instance on a local network with all gateways being used for SHOWRUNNER™.
52 +Use this method if you have multiple ShowRunner instances on the same network or have gateways used by other Crestron systems.
102 102  
103 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
55 +* Type "//sr devmgr ethernet query//" and press enter. This queries the local network for RF Gateways.
56 +* Type "//sr devmgr ethernet show devices//" and press enter. This displays all found Crestron ethernet devices.
57 +* 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.
58 +* Type "//sr discover zum false//" and press enter.
59 +* Status messages and the results will be displayed on the console. The process should take about 3 minutes.
60 +* 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.
61 +* Type "//progreset//" and press enter to restart ShowRunner
62 +* 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.
63 +* Once completed ShowRunner is now ready for full Zum control
110 110  
111 111  == Examples ==
112 112  
113 -=== Manual Example ===
67 +=== Example for Option 1: ===
114 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.
69 +{{{MC4>sr discover zum true
70 +Starting Zum Discovery with gateway claiming
71 +MC4>Found 1 Gateways to check.
72 +Claimed Gateway SN: 1720JBH04269 at IP-ID: 30
73 +Update request from IP-ID-30 in Program 01
74 +Claimed 1 Gateways. Waiting for queries to finish.
75 +Performing Discovery on 1 Gateways.
135 135  Evaluating 3 Devices on Gateway 30
136 136  Claiming ZUM-NETBRIDGE SN: 1726NEJ01096 from IP-ID: 30
137 137  Dev: ZUM-NETBRIDGE addrssing to RF ID: 03
... ... @@ -142,7 +142,6 @@
142 142  Claiming ZUM-NETBRIDGE SN: 1914NEJ03098 from IP-ID: 30
143 143  Dev: ZUM-NETBRIDGE addrssing to RF ID: 05
144 144  Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 05
145 -Querying cresnet
146 146  Discovering Zum Loads on 1 Gateways.
147 147  Discovering Zum Loads on 3 Devices.
148 148  NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0
... ... @@ -162,7 +162,7 @@
162 162  MC4>progreset
163 163  ...
164 164  CI ShowRunner startup completed successfully in 8072ms
165 -MC4>sr discover zummesh false
105 +MC4>sr discover zum false
166 166  Starting Zum Discovery without gateway claiming
167 167  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
168 168  Performing Discovery on 1 Gateways.
... ... @@ -211,17 +211,31 @@
211 211  New Loads: 6
212 212  Modified Loads: 0
213 213  Removed Loads: 0
214 -Zum Discovery Finished}}}
154 +Zum Discovery Finished
155 +}}}
215 215  
216 -=== Claim All Example ===
157 +=== Example for Option 2: ===
217 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.
159 +{{{MC4>sr devmgr ethernet query
160 +Ethrenet AutoDiscovery Result: AutoDiscoveryOperationSuccess
161 +MC4>sr devmgr ethernet show devices
162 +
163 ++--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
164 +| Adapter | Hostname | IP Address | IP-ID | ID |
165 ++--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
166 +| EthernetLANAdapter | CI-SJC-CEN-CI3-1-COM3 | 10.44.5.20 | 00 | CEN-CI3-1-C3COM-3 [v1.1620.00000, #008436E2] type:1 |
167 ++--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
168 +| EthernetLANAdapter | SB-DIN-CENCN-2 | 10.44.5.81 | 00 | DIN-CENCN-2-POE [v1.3544.00006, #8AB25AA3] |
169 ++--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
170 +| EthernetLANAdapter | CEN-GWEXER-9E6ADA | 10.44.5.120 | 00 | CEN-GWEXER [v1.4230.00015, #848210AD] |
171 ++--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
172 +
173 +MC4>sr ethernet device claim CEN-GWEXER-9E6ADA
174 +Claimed ethernet device: CEN-GWEXER-9E6ADA
175 +MC4>Update request from IP-ID-30 in Program 01
176 +MC4>sr discover zum false
177 +Starting Zum Discovery without gateway claiming
178 +MC4>Performing Discovery on 1 Gateways.
225 225  Evaluating 3 Devices on Gateway 30
226 226  Claiming ZUM-NETBRIDGE SN: 1726NEJ01096 from IP-ID: 30
227 227  Dev: ZUM-NETBRIDGE addrssing to RF ID: 03
... ... @@ -232,6 +232,7 @@
232 232  Claiming ZUM-NETBRIDGE SN: 1914NEJ03098 from IP-ID: 30
233 233  Dev: ZUM-NETBRIDGE addrssing to RF ID: 05
234 234  Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 05
189 +Querying cresnet
235 235  Discovering Zum Loads on 1 Gateways.
236 236  Discovering Zum Loads on 3 Devices.
237 237  NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0
... ... @@ -251,7 +251,7 @@
251 251  MC4>progreset
252 252  ...
253 253  CI ShowRunner startup completed successfully in 8072ms
254 -MC4>sr discover zummesh false
209 +MC4>sr discover zum false
255 255  Starting Zum Discovery without gateway claiming
256 256  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
257 257  Performing Discovery on 1 Gateways.
... ... @@ -301,4 +301,5 @@
301 301  Modified Loads: 0
302 302  Removed Loads: 0
303 303  Zum Discovery Finished
304 -}}}
259 + }}}
260 +)))