Skip to Content

Changes for page Zūm Discovery

Last modified by Austin Weygandt on 2025/05/02 20:21
From version 10.1
edited by Alexander Mott
on 2022/10/05 16:18
Change comment: There is no comment for this version
To version 6.4
edited by Alexander Mott
on 2022/09/22 23:42
Change comment: (Autosaved)

Summary

Details

Page properties
Content
... ... @@ -18,57 +18,22 @@
18 18  
19 19  == Notes and Limitations ==
20 20  
21 -(% class="box errormessage" %)
22 -(((
23 23  * SHOWRUNNER™ version 3.014 or newer required
24 24  * Zūm Wired firmware version 1.02.10 or greater required
25 25  * Disconnect from any ZUMNET devices you may be connected to in Toolbox prior to running the discovery commands
26 26  * Cresnet devices landed on Zūm Link will not be discovered (Crestron bug expected to be corrected in a future firmware release)
27 27  * One area will be created per ZUMNET-JBOX; if there are more areas than ZUMNET-JBOXs, additional areas must be created manually
28 -)))
29 29  
30 30  == Steps ==
31 31  
32 -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
33 -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.
34 -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: 
35 -1*. Connect to the first ZUMNET-JBOX in Toolbox
36 -1*. Configure a static IP address for the ZUMNET-JBOX if there is no DHCP server on the network 
37 -1**. Note: The SHOWRUNNER™ built-in DHCP server is not meant to be used in production
38 -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
39 -1*. Set unique Connection IDs for each device hosted on the ZUMNET-JBOX so that their firmware can be updated
40 -1*. Load the Zūm Wired firmware to the ZUMNET-JBOX
41 -1*. Repeat the above steps for all ZUMNET-JBOXs
42 -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
43 -1. Connect to first ZUMNET-JBOX in the Crestron Zūm App
44 -1. Unique Connection IDs should be automatically assigned to any Zūm Link and Cresnet devices on the ZUMNET-JBOX
45 -1*. If firmware was out-of-date, then this step should have already been completed
46 -1*. If unique CIDs are not automatically assigned, connect to the JBOX in Toolbox and give the devices unique CIDs
47 -1. Configure a static IP address for the ZUMNET-JBOX if there is no DHCP server on the network 
48 -1*. If firmware was out-of-date, then this step should have already been completed
49 -1*. Note: The SHOWRUNNER™ built-in DHCP server is not meant to be used in production
50 -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
51 -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
52 -1*. If you do not manually configure the IP table, then SHOWRUNNER™ will automatically configure the IP-ID for each ZUMNET-JBOX during discovery
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 areas and loads to the configuration
57 -1*. One area will be created per ZUMNET-JBOX
58 -1. Run the command: ##sr discover zumnet true true##
59 -1*. This command tells SHOWRUNNER™ to discover all Zūm Link hardware on the previously discovered Zūm Net devices
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. Put all ZUMNET-JBOXs into CNET mode in order to allow full control from SHOWRUNNER™
62 -1*. Odd behavior may result from conflicts between SHOWRUNNER™ and internal logic if the ZUMNET-JBOXs are not put into CNET mode
29 +1.
63 63  
64 64  = Zūm Wireless Discovery =
65 65  
66 66  == Notes and Limitations ==
67 67  
68 -(% class="box errormessage" %)
69 -(((
70 70  * Processor with SHOWRUNNER™ version 2.190 or newer must be running on the same network as the gateway(s) to be acquired
71 -** For SHOWRUNNER™ versions prior to 3.014 and newer, replace **##sr discover zummesh##** commands with **##sr discover zum##**
36 +** For SHOWRUNNER™ versions 3.014 and newer, replace ##sr discover zum## commands with ##sr discover zummesh##
72 72  * ZUM-NETBRIDGES must already be acquired to their respective gateway
73 73  * SHOWRUNNER™ will automatically address any ZUM-NETBRIDGES that do not need have addresses assigned, but will still honor any already addressed devices
74 74  * Disconnect from any RF gateways you may be connected to in Toolbox prior to running the discovery command
... ... @@ -83,19 +83,21 @@
83 83  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.
84 84  )))
85 85  
51 +(% class="row" %)
52 +(((
86 86  == Manual RF Gateway Assignment Instructions ==
87 87  
88 88  Use this method if you have multiple SHOWRUNNER™ instances on the same network or have gateways used by other Crestron systems.
89 89  
90 90  * Connect to the processor's console with Toolbox or your favorite SSH client.
91 -* Type ##sr devmgr ethernet query## and press enter. This queries the local network for RF Gateways.
92 -* Type ##sr devmgr ethernet show devices## and press enter. This displays all found Crestron ethernet devices.
93 -* 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.
94 -* Type ##sr discover zummesh false## and press enter.
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.
95 95  * Status messages and the results will be displayed on the console. The process should take about 3 minutes.
96 -* 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.
97 -* Type ##progreset## and press enter to restart SHOWRUNNER™
98 -* 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.
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.
99 99  * Once completed SHOWRUNNER™ is now ready for full Zūm control
100 100  
101 101  == Claim All RF Gateways Instructions ==
... ... @@ -103,11 +103,11 @@
103 103  Use this method when you have a single SHOWRUNNER™ instance on a local network with all gateways being used for SHOWRUNNER™.
104 104  
105 105  * Connect to the processor's console with Toolbox or your favorite SSH client.
106 -* Type ##sr discover zummesh true## and press enter.
73 +* Type "//sr discover zum true//" and press enter.
107 107  * Status messages and the results will be displayed on the console. The process should take about 3 minutes.
108 -* 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.
109 -* Type ##progreset## and press enter to restart SHOWRUNNER™
110 -* 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.
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.
111 111  * Once completed SHOWRUNNER™ is now ready for full Zūm control
112 112  
113 113  == Examples ==
... ... @@ -131,7 +131,7 @@
131 131  MC4>sr ethernet device claim CEN-GWEXER-9E6ADA
132 132  Claimed ethernet device: CEN-GWEXER-9E6ADA
133 133  MC4>Update request from IP-ID-30 in Program 01
134 -MC4>sr discover zummesh false
101 +MC4>sr discover zum false
135 135  Starting Zum Discovery without gateway claiming
136 136  MC4>Performing Discovery on 1 Gateways.
137 137  Evaluating 3 Devices on Gateway 30
... ... @@ -164,7 +164,7 @@
164 164  MC4>progreset
165 165  ...
166 166  CI ShowRunner startup completed successfully in 8072ms
167 -MC4>sr discover zummesh false
134 +MC4>sr discover zum false
168 168  Starting Zum Discovery without gateway claiming
169 169  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
170 170  Performing Discovery on 1 Gateways.
... ... @@ -217,7 +217,7 @@
217 217  
218 218  === Claim All Example ===
219 219  
220 -{{{MC4>sr discover zummesh true
187 +{{{MC4>sr discover zum true
221 221  Starting Zum Discovery with gateway claiming
222 222  MC4>Found 1 Gateways to check.
223 223  Claimed Gateway SN: 1720JBH04269 at IP-ID: 30
... ... @@ -253,7 +253,7 @@
253 253  MC4>progreset
254 254  ...
255 255  CI ShowRunner startup completed successfully in 8072ms
256 -MC4>sr discover zummesh false
223 +MC4>sr discover zum false
257 257  Starting Zum Discovery without gateway claiming
258 258  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
259 259  Performing Discovery on 1 Gateways.