Skip to Content

Changes for page Zūm Discovery

Last modified by Austin Weygandt on 2025/05/02 20:21
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 14.1
edited by Alexander Mott
on 2022/10/10 23:35
Change comment: There is no comment for this version

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  
... ... @@ -8,72 +8,131 @@
8 8  {{toc/}}
9 9  {{/box}}
10 10  
11 -(% class="row" %)
12 -(((
13 -If Zūm Net devices have been configured using Crestron's Zūm App
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™.
14 14  
15 -= Zūm Wired =
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.
16 16  
17 -Lorem
15 += Zūm Wired Discovery =
18 18  
19 -= Zūm Wireless =
17 +== Notes and Limitations ==
20 20  
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 +)))
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*
28 +== Steps ==
25 25  
26 -== Pre-Requisites: ==
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.
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.
63 += Zūm Wireless Discovery =
31 31  
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 +
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.
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.
37 37  )))
38 38  
39 -== Option 1: Claim All Gateways: ==
85 +== 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.
87 +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
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
50 50  
51 -== Option 2: Manual RF Gateway Claiming: ==
100 +== 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.
102 +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
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
65 65  
66 66  == Examples ==
67 67  
68 -=== Example for Option 1: ===
114 +=== 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.
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.
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
146 +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
... ... @@ -103,7 +103,7 @@
103 103  MC4>progreset
104 104  ...
105 105  CI ShowRunner startup completed successfully in 8072ms
106 -MC4>sr discover zum false
166 +MC4>sr discover zummesh false
107 107  Starting Zum Discovery without gateway claiming
108 108  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
109 109  Performing Discovery on 1 Gateways.
... ... @@ -152,31 +152,17 @@
152 152  New Loads: 6
153 153  Modified Loads: 0
154 154  Removed Loads: 0
155 -Zum Discovery Finished
156 -}}}
215 +Zum Discovery Finished}}}
157 157  
158 -=== Example for Option 2: ===
217 +=== 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.
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.
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
... ... @@ -207,7 +207,7 @@
207 207  MC4>progreset
208 208  ...
209 209  CI ShowRunner startup completed successfully in 8072ms
210 -MC4>sr discover zum false
255 +MC4>sr discover zummesh false
211 211  Starting Zum Discovery without gateway claiming
212 212  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
213 213  Performing Discovery on 1 Gateways.
... ... @@ -257,5 +257,4 @@
257 257  Modified Loads: 0
258 258  Removed Loads: 0
259 259  Zum Discovery Finished
260 - }}}
261 -)))
305 +}}}