Skip to Content

Changes for page Zūm Discovery

Last modified by Alexander Mott on 2025/04/03 17:35
From version 6.7
edited by Alexander Mott
on 2022/09/22 23:57
Change comment: (Autosaved)
To version 11.1
edited by Alexander Mott
on 2022/10/05 16:19
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -8,8 +8,6 @@
8 8  {{toc/}}
9 9  {{/box}}
10 10  
11 -(% class="row" %)
12 -(((
13 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 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.
... ... @@ -18,22 +18,57 @@
18 18  
19 19  == Notes and Limitations ==
20 20  
19 +(% class="box errormessage" %)
20 +(((
21 21  * SHOWRUNNER™ version 3.014 or newer required
22 22  * Zūm Wired firmware version 1.02.10 or greater required
23 23  * Disconnect from any ZUMNET devices you may be connected to in Toolbox prior to running the discovery commands
24 24  * Cresnet devices landed on Zūm Link will not be discovered (Crestron bug expected to be corrected in a future firmware release)
25 25  * One area will be created per ZUMNET-JBOX; if there are more areas than ZUMNET-JBOXs, additional areas must be created manually
26 +)))
26 26  
27 27  == Steps ==
28 28  
29 -1.
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
30 30  
31 31  = Zūm Wireless Discovery =
32 32  
33 33  == Notes and Limitations ==
34 34  
66 +(% class="box errormessage" %)
67 +(((
35 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##
69 +** For SHOWRUNNER™ versions prior to 3.014 and newer, replace **##sr discover zummesh##** commands with **##sr discover zum##**
37 37  * ZUM-NETBRIDGES must already be acquired to their respective gateway
38 38  * SHOWRUNNER™ will automatically address any ZUM-NETBRIDGES that do not need have addresses assigned, but will still honor any already addressed devices
39 39  * Disconnect from any RF gateways you may be connected to in Toolbox prior to running the discovery command
... ... @@ -48,21 +48,19 @@
48 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.
49 49  )))
50 50  
51 -(% class="row" %)
52 -(((
53 53  == Manual RF Gateway Assignment Instructions ==
54 54  
55 55  Use this method if you have multiple SHOWRUNNER™ instances on the same network or have gateways used by other Crestron systems.
56 56  
57 57  * Connect to the processor's console with Toolbox or your favorite SSH client.
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.
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.
62 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.
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.
66 66  * Once completed SHOWRUNNER™ is now ready for full Zūm control
67 67  
68 68  == Claim All RF Gateways Instructions ==
... ... @@ -70,11 +70,11 @@
70 70  Use this method when you have a single SHOWRUNNER™ instance on a local network with all gateways being used for SHOWRUNNER™.
71 71  
72 72  * Connect to the processor's console with Toolbox or your favorite SSH client.
73 -* Type "//sr discover zum true//" and press enter.
104 +* Type ##sr discover zummesh true## and press enter.
74 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.
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.
78 78  * Once completed SHOWRUNNER™ is now ready for full Zūm control
79 79  
80 80  == Examples ==
... ... @@ -98,7 +98,7 @@
98 98  MC4>sr ethernet device claim CEN-GWEXER-9E6ADA
99 99  Claimed ethernet device: CEN-GWEXER-9E6ADA
100 100  MC4>Update request from IP-ID-30 in Program 01
101 -MC4>sr discover zum false
132 +MC4>sr discover zummesh false
102 102  Starting Zum Discovery without gateway claiming
103 103  MC4>Performing Discovery on 1 Gateways.
104 104  Evaluating 3 Devices on Gateway 30
... ... @@ -131,7 +131,7 @@
131 131  MC4>progreset
132 132  ...
133 133  CI ShowRunner startup completed successfully in 8072ms
134 -MC4>sr discover zum false
165 +MC4>sr discover zummesh false
135 135  Starting Zum Discovery without gateway claiming
136 136  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
137 137  Performing Discovery on 1 Gateways.
... ... @@ -184,7 +184,7 @@
184 184  
185 185  === Claim All Example ===
186 186  
187 -{{{MC4>sr discover zum true
218 +{{{MC4>sr discover zummesh true
188 188  Starting Zum Discovery with gateway claiming
189 189  MC4>Found 1 Gateways to check.
190 190  Claimed Gateway SN: 1720JBH04269 at IP-ID: 30
... ... @@ -220,7 +220,7 @@
220 220  MC4>progreset
221 221  ...
222 222  CI ShowRunner startup completed successfully in 8072ms
223 -MC4>sr discover zum false
254 +MC4>sr discover zummesh false
224 224  Starting Zum Discovery without gateway claiming
225 225  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
226 226  Performing Discovery on 1 Gateways.
... ... @@ -271,4 +271,3 @@
271 271  Removed Loads: 0
272 272  Zum Discovery Finished
273 273  }}}
274 -)))