Skip to Content

Changes for page Zūm Discovery

Last modified by Austin Weygandt on 2025/05/02 20:21
From version 4.1
edited by Alexander Mott
on 2022/09/22 21:50
Change comment: There is no comment for this version
To version 21.1
edited by Alexander Mott
on 2023/10/11 16:37
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,18 @@
1 +(% class="box errormessage" %)
2 +(((
3 +WARNING: Cresnet Discovery is not currently working on ZUMNET-JBOXs. Crestron has acknowledged a fix has been sent to QE.
4 +
5 +Downgrade ShowRunnerCLC™ to v3.018 in order to auto-discover hardware. ShowRunnerCLC™ can be subsequently upgraded once discovery is complete.
6 +)))
7 +
8 +(% class="box errormessage" %)
9 +(((
10 +**IMPORTANT:** When using ShowRunnerCLC™ with a ZUM-HUB4, **do not** discover Zūm Rooms using the Crestron HUB4 Web UI. During discovery, the HUB4 will claim ZUMNET-JBOXs and prevent ShowRunnerCLC™ from auto-discovering or registering the Zūm hardware for itself.
11 +)))
12 +
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]].
15 +This article is about automatically building a ShowRunnerCLC™ configuration using the Zūm Discovery feature of ShowRunnerCLC™. 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,70 +8,111 @@
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
23 +If Zūm Wired or Wireless devices have been configured using Crestron's Zūm App, then it is possible to automatically build a ShowRunnerCLC™ configuration file using the Zūm Discovery feature that is built into ShowRunnerCLC™.
14 14  
15 -= Zūm Wired =
25 +There are certain pre-requisites and limitations when building a ShowRunnerCLC™ 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
27 += Zūm Wired Discovery =
18 18  
19 -= Zūm Wireless =
29 +== Notes and Limitations ==
20 20  
31 +(% class="box warningmessage" %)
32 +(((
33 +* ShowRunnerCLC™ version 3.014 or newer required
34 +* Zūm Wired firmware .puf version 1.02.10 or greater required (ZUMNET-JBOX installed minimum version 1.001.00081)
35 +* Disconnect from any ZUMNET devices you may be connected to in Toolbox prior to running the discovery commands
36 +* Cresnet devices landed on Zūm Link will not be discovered (Crestron bug expected to be corrected in a future firmware release)
37 +* One area will be created per ZUMNET-JBOX; if there are more areas than ZUMNET-JBOXs, additional areas must be created manually
38 +)))
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*
40 +== Steps ==
25 25  
26 -== Pre-Requisites: ==
42 +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
43 +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.
44 +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: 
45 +1*. Connect to the first ZUMNET-JBOX in Toolbox
46 +1*. Configure a static IP address for the ZUMNET-JBOX if there is no DHCP server on the network 
47 +1**. Note: The ShowRunnerCLC™ built-in DHCP server is not meant to be used in production
48 +1**. If the ShowRunnerCLC™ 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*. Set unique Connection IDs for each device hosted on the ZUMNET-JBOX so that their firmware can be updated
50 +1*. Load the Zūm Wired firmware to the ZUMNET-JBOX
51 +1*. Repeat the above steps for all ZUMNET-JBOXs
52 +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
53 +1. Connect to first ZUMNET-JBOX in the Crestron Zūm App
54 +1. Unique Connection IDs should be automatically assigned to any Zūm Link and Cresnet devices on the ZUMNET-JBOX
55 +1*. If firmware was out-of-date, then this step should have already been completed
56 +1*. If unique CIDs are not automatically assigned, connect to the JBOX in Toolbox and give the devices unique CIDs
57 +1. Configure a static IP address for the ZUMNET-JBOX if there is no DHCP server on the network 
58 +1*. If firmware was out-of-date, then this step should have already been completed
59 +1*. Note: The ShowRunnerCLC™ built-in DHCP server is not meant to be used in production
60 +1*. If the ShowRunnerCLC™ built-in DHCP server was used to assign IP addresses to devices, it is still necessary to give those devices static IP addresses
61 +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
62 +1*. If you do not manually configure the IP table, then SHOWRUNNER™ will automatically configure the IP-ID for each ZUMNET-JBOX during discovery
63 +1. Set the ZUMNET-JBOX into either Zūm ("App") mode or CNET mode as required for the program
64 +1*. Full control from ShowRunnerCLC™ is only possible if all ZUMNET-JBOXs are in CNET mode. Odd behavior may result from conflicts between ShowRunnerCLC™ and internal logic if the ZUMNET-JBOXs are not put into CNET mode
65 +1. Repeat from step 3 until all ZUMNET-JBOXs that are to be controlled by ShowRunnerCLC™ have static IP addresses and unique CIDs for any hosted devices
66 +1. Disconnect from any ZUMNET-JBOXs and then connect to the processor in Toolbox
67 +1. Run the command: ##sr discover zumnet true false##
68 +1*. This command tells ShowRunnerCLC™ to discover all ZUMMNET-JBOXs on the network, configure their IP tables, and then add corresponding IP Devices to the configuration
69 +1. Run the command: ##sr discover zumnet true true##
70 +1*. This command tells ShowRunnerCLC™ 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
71 +1**. One area will be created per ZUMNET-JBOX, and all hardware attached to that ZUMNET-JBOX will be assigned to that area
72 +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
73 +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.
75 += Zūm Wireless Discovery =
76 +
77 +== Notes and Limitations ==
78 +
79 +(% class="box warningmessage" %)
80 +(((
81 +* Processor with ShowRunnerCLC™ version 2.190 or newer must be running on the same network as the gateway(s) to be acquired
82 +** For ShowRunnerCLC™ versions prior to 3.014 and newer, replace **##sr discover zummesh##** commands with **##sr discover zum##**
83 +* ZUM-NETBRIDGES must already be acquired to their respective gateway
84 +* ShowRunnerCLC™ will automatically address any ZUM-NETBRIDGES that do not need have addresses assigned, but will still honor any already addressed devices
85 +* Disconnect from any RF gateways you may be connected to in Toolbox prior to running the discovery command
86 +* Plug loads will not appear in the ShowRunnerCLC™ UI
31 31  )))
32 32  
33 -(% class="box warningmessage" id="HCaution:" %)
89 +(% class="box infomessage" id="HCaution:" %)
34 34  (((
35 -**Note:** SHOWRUNNER™ has two different approaches for Zūm Wireless Autodiscovery
91 +**Note:** ShowRunnerCLC™ has two different approaches for Zūm Wireless Discovery
36 36  
37 -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.
38 -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.
93 +1. **Manual RF Gateway Assignment** - ShowRunnerCLC™ 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.
94 +1. **Claim All RF Gateways** - ShowRunnerCLC™ 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 ShowRunnerCLC™ or other Crestron systems on the same local network.
39 39  )))
40 40  
41 -(% class="row" %)
42 -(((
43 -== Option 1: Manual RF Gateway Claiming: ==
97 +== Manual RF Gateway Assignment Instructions ==
44 44  
45 -Use this method if you have multiple ShowRunner instances on the same network or have gateways used by other Crestron systems.
99 +Use this method if you have multiple ShowRunnerCLC™ instances on the same network or have gateways used by other Crestron systems.
46 46  
47 47  * Connect to the processor's console with Toolbox or your favorite SSH client.
48 -* Type "//sr devmgr ethernet query//" and press enter. This queries the local network for RF Gateways.
49 -* Type "//sr devmgr ethernet show devices//" and press enter. This displays all found Crestron ethernet devices.
50 -* 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.
51 -* Type "//sr discover zum false//" and press enter.
52 -* Status messages and the results will be displayed on the console. The process should take about 3 minutes.
53 -* 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.
54 -* Type "//progreset//" and press enter to restart ShowRunner
55 -* 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.
56 -* Once completed ShowRunner is now ready for full Zum control
102 +* Type ##sr devmgr ethernet query## and press enter. This queries the local network for RF Gateways.
103 +* Type ##sr devmgr ethernet show devices## and press enter. This displays all found Crestron ethernet devices.
104 +* 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##. ShowRunnerCLC™ will auto-assign an IP-ID. After all gateways have been claimed by ShowRunnerCLC™, proceed to the next step.
105 +* Type ##sr discover zummesh false## 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, ShowRunnerCLC™ must be restarted to complete the acquire process.
108 +* Type ##progreset## and press enter to restart ShowRunnerCLC™
109 +* Once SHOWRUNNER™ has finished restarting type ##sr discover zummesh false## and press enter. ShowRunnerCLC™ 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
57 57  
58 -== Option 2: Claim All Gateways: ==
112 +== Claim All RF Gateways Instructions ==
59 59  
60 -Use this method when you have a single ShowRunner instance on a local network with all gateways being used for ShowRunner.
114 +Use this method when you have a single ShowRunnerCLC™ instance on a local network with all gateways being used for ShowRunnerCLC™.
61 61  
62 62  * Connect to the processor's console with Toolbox or your favorite SSH client.
63 -* Type "//sr discover zum true//" and press enter.
64 -* Status messages and the results will be displayed on the console. The process should take about 3 minutes.
65 -* 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.
66 -* Type "//progreset//" and press enter to restart ShowRunner
67 -* 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.
68 -* Once completed ShowRunner is now ready for full Zum control
117 +* Type ##sr discover zummesh true## and press enter.
118 +* Status messages and the results will be displayed on the console. The process should take about 3 minutes.
119 +* 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, ShowRunnerCLC™ must be restarted to complete the acquire process.
120 +* Type ##progreset## and press enter to restart ShowRunnerCLC™
121 +* Once ShowRunnerCLC™ has finished restarting type ##sr discover zummesh false## and press enter. ShowRunnerCLC™ will be able to acquire the loads attached to the Zūm rooms at this point.
122 +* Once completed ShowRunnerCLC™ is now ready for full Zūm control
69 69  
70 70  == Examples ==
71 71  
126 +=== Manual Example ===
72 72  
73 -=== Example for Option 1: ===
74 -
75 75  {{{MC4>sr devmgr ethernet query
76 76  Ethrenet AutoDiscovery Result: AutoDiscoveryOperationSuccess
77 77  MC4>sr devmgr ethernet show devices
... ... @@ -89,7 +89,7 @@
89 89  MC4>sr ethernet device claim CEN-GWEXER-9E6ADA
90 90  Claimed ethernet device: CEN-GWEXER-9E6ADA
91 91  MC4>Update request from IP-ID-30 in Program 01
92 -MC4>sr discover zum false
145 +MC4>sr discover zummesh false
93 93  Starting Zum Discovery without gateway claiming
94 94  MC4>Performing Discovery on 1 Gateways.
95 95  Evaluating 3 Devices on Gateway 30
... ... @@ -122,7 +122,7 @@
122 122  MC4>progreset
123 123  ...
124 124  CI ShowRunner startup completed successfully in 8072ms
125 -MC4>sr discover zum false
178 +MC4>sr discover zummesh false
126 126  Starting Zum Discovery without gateway claiming
127 127  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
128 128  Performing Discovery on 1 Gateways.
... ... @@ -173,9 +173,9 @@
173 173  Removed Loads: 0
174 174  Zum Discovery Finished}}}
175 175  
176 -=== Example for Option 2: ===
229 +=== Claim All Example ===
177 177  
178 -{{{MC4>sr discover zum true
231 +{{{MC4>sr discover zummesh true
179 179  Starting Zum Discovery with gateway claiming
180 180  MC4>Found 1 Gateways to check.
181 181  Claimed Gateway SN: 1720JBH04269 at IP-ID: 30
... ... @@ -211,7 +211,7 @@
211 211  MC4>progreset
212 212  ...
213 213  CI ShowRunner startup completed successfully in 8072ms
214 -MC4>sr discover zum false
267 +MC4>sr discover zummesh false
215 215  Starting Zum Discovery without gateway claiming
216 216  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
217 217  Performing Discovery on 1 Gateways.
... ... @@ -262,4 +262,3 @@
262 262  Removed Loads: 0
263 263  Zum Discovery Finished
264 264  }}}
265 -)))