Skip to Content

Changes for page Zūm Discovery

Last modified by Austin Weygandt on 2025/05/02 20:21
From version 5.2
edited by Alexander Mott
on 2022/09/22 22:11
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
Content
... ... @@ -8,68 +8,105 @@
8 8  {{toc/}}
9 9  {{/box}}
10 10  
11 -(% class="row" %)
12 -(((
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 Autodiscovery feature that is built into SHOWRUNNER™.
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 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 17  = Zūm Wired Discovery =
18 18  
19 -Lorem
17 +== Notes and Limitations ==
20 20  
21 -= Zūm Wireless Discovery =
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 +)))
22 22  
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 -== Notes and Limitations ==
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 -* SHOWRUNNER™ version 2.190 or newer required
29 -* Disconnect from any RF gateways you are connected to prior to running the autodiscovery command,
63 += Zūm Wireless Discovery =
30 30  
31 -== Pre-Requisites ==
65 +== Notes and Limitations ==
32 32  
33 -* Zum NETBRIDGES acquired to their respective gateway (CEN-GWEXER/ZUMNET-GATEWAY)
34 -* SHOWRUNNER™ installed and running on a 3-series processor on the same network as the gateway
35 -* NETBRIDGES do not need to have addresses assigned. SHOWRUNNER™ will automatically address them. If devices all already addressed then their addresses will be honored.
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
36 36  )))
37 37  
38 38  (% class="box warningmessage" id="HCaution:" %)
39 39  (((
40 -**Note:** SHOWRUNNER™ has two different approaches for Zūm Wireless Autodiscovery
79 +**Note:** SHOWRUNNER™ has two different approaches for Zūm Wireless Discovery
41 41  
42 42  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.
43 43  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.
44 44  )))
45 45  
46 -(% class="row" %)
47 -(((
48 -== Manual RF Gateway Assignment ==
85 +== Manual RF Gateway Assignment Instructions ==
49 49  
50 50  Use this method if you have multiple SHOWRUNNER™ instances on the same network or have gateways used by other Crestron systems.
51 51  
52 52  * Connect to the processor's console with Toolbox or your favorite SSH client.
53 -* Type "//sr devmgr ethernet query//" and press enter. This queries the local network for RF Gateways.
54 -* Type "//sr devmgr ethernet show devices//" and press enter. This displays all found Crestron ethernet devices.
55 -* 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.
56 -* Type "//sr discover zum false//" and press enter.
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.
57 57  * Status messages and the results will be displayed on the console. The process should take about 3 minutes.
58 -* 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.
59 -* Type "//progreset//" and press enter to restart SHOWRUNNER™
60 -* 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.
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.
61 61  * Once completed SHOWRUNNER™ is now ready for full Zūm control
62 62  
63 -== Claim All RF Gateways ==
100 +== Claim All RF Gateways Instructions ==
64 64  
65 65  Use this method when you have a single SHOWRUNNER™ instance on a local network with all gateways being used for SHOWRUNNER™.
66 66  
67 67  * Connect to the processor's console with Toolbox or your favorite SSH client.
68 -* Type "//sr discover zum true//" and press enter.
105 +* Type ##sr discover zummesh true## and press enter.
69 69  * Status messages and the results will be displayed on the console. The process should take about 3 minutes.
70 -* 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.
71 -* Type "//progreset//" and press enter to restart SHOWRUNNER™
72 -* 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.
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.
73 73  * Once completed SHOWRUNNER™ is now ready for full Zūm control
74 74  
75 75  == Examples ==
... ... @@ -93,7 +93,7 @@
93 93  MC4>sr ethernet device claim CEN-GWEXER-9E6ADA
94 94  Claimed ethernet device: CEN-GWEXER-9E6ADA
95 95  MC4>Update request from IP-ID-30 in Program 01
96 -MC4>sr discover zum false
133 +MC4>sr discover zummesh false
97 97  Starting Zum Discovery without gateway claiming
98 98  MC4>Performing Discovery on 1 Gateways.
99 99  Evaluating 3 Devices on Gateway 30
... ... @@ -126,7 +126,7 @@
126 126  MC4>progreset
127 127  ...
128 128  CI ShowRunner startup completed successfully in 8072ms
129 -MC4>sr discover zum false
166 +MC4>sr discover zummesh false
130 130  Starting Zum Discovery without gateway claiming
131 131  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
132 132  Performing Discovery on 1 Gateways.
... ... @@ -179,7 +179,7 @@
179 179  
180 180  === Claim All Example ===
181 181  
182 -{{{MC4>sr discover zum true
219 +{{{MC4>sr discover zummesh true
183 183  Starting Zum Discovery with gateway claiming
184 184  MC4>Found 1 Gateways to check.
185 185  Claimed Gateway SN: 1720JBH04269 at IP-ID: 30
... ... @@ -215,7 +215,7 @@
215 215  MC4>progreset
216 216  ...
217 217  CI ShowRunner startup completed successfully in 8072ms
218 -MC4>sr discover zum false
255 +MC4>sr discover zummesh false
219 219  Starting Zum Discovery without gateway claiming
220 220  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
221 221  Performing Discovery on 1 Gateways.
... ... @@ -266,4 +266,3 @@
266 266  Removed Loads: 0
267 267  Zum Discovery Finished
268 268  }}}
269 -)))