Skip to Content

Changes for page Zūm Discovery

Last modified by Austin Weygandt on 2025/05/02 20:21
From version 22.1
edited by Alexander Mott
on 2023/12/08 18:34
Change comment: There is no comment for this version
To version 4.1
edited by Alexander Mott
on 2022/09/22 21:50
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Zūm Discovery
1 +Zūm Autodiscovery
Content
... ... @@ -1,17 +12,6 @@
1 -(% class="box errormessage" %)
2 -(((
3 -**WARNING:** Cresnet Discovery is non-functional for ZUMNET-JBOXs with certain versions of Crestron Device Database.
4 -ShowRunnerCLC™ versions v3.019 through v3.041 must be either downgraded to v3.018 or upgraded to v3.042 or newer in order to perform auto-discover functions.
5 -)))
6 -
7 -(% class="box errormessage" %)
8 -(((
9 -**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.
10 -)))
11 -
12 12  (% class="box warningmessage" %)
13 13  (((
14 -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]].
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 15  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]].
16 16  )))
17 17  
... ... @@ -19,111 +19,70 @@
19 19  {{toc/}}
20 20  {{/box}}
21 21  
22 -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™.
11 +(% class="row" %)
12 +(((
13 +If Zūm Net devices have been configured using Crestron's Zūm App
23 23  
24 -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.
15 += Zūm Wired =
25 25  
26 -= Zūm Wired Discovery =
17 +Lorem
27 27  
28 -== Notes and Limitations ==
19 += Zūm Wireless =
29 29  
30 -(% class="box warningmessage" %)
31 -(((
32 -* ShowRunnerCLC™ version 3.014 or newer required
33 -* Zūm Wired firmware .puf version 1.02.10 or greater required (ZUMNET-JBOX installed minimum version 1.001.00081)
34 -* Disconnect from any ZUMNET devices you may be connected to in Toolbox prior to running the discovery commands
35 -* Cresnet devices landed on Zūm Link will not be discovered (Crestron bug expected to be corrected in a future firmware release)
36 -* One area will be created per ZUMNET-JBOX; if there are more areas than ZUMNET-JBOXs, additional areas must be created manually
37 -)))
38 38  
39 -== Steps ==
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 40  
41 -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
42 -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.
43 -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: 
44 -1*. Connect to the first ZUMNET-JBOX in Toolbox
45 -1*. Configure a static IP address for the ZUMNET-JBOX if there is no DHCP server on the network 
46 -1**. Note: The ShowRunnerCLC™ built-in DHCP server is not meant to be used in production
47 -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
48 -1*. Set unique Connection IDs for each device hosted on the ZUMNET-JBOX so that their firmware can be updated
49 -1*. Load the Zūm Wired firmware to the ZUMNET-JBOX
50 -1*. Repeat the above steps for all ZUMNET-JBOXs
51 -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
52 -1. Connect to first ZUMNET-JBOX in the Crestron Zūm App
53 -1. Unique Connection IDs should be automatically assigned to any Zūm Link and Cresnet devices on the ZUMNET-JBOX
54 -1*. If firmware was out-of-date, then this step should have already been completed
55 -1*. If unique CIDs are not automatically assigned, connect to the JBOX in Toolbox and give the devices unique CIDs
56 -1. Configure a static IP address for the ZUMNET-JBOX if there is no DHCP server on the network 
57 -1*. If firmware was out-of-date, then this step should have already been completed
58 -1*. Note: The ShowRunnerCLC™ built-in DHCP server is not meant to be used in production
59 -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
60 -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
61 -1*. If you do not manually configure the IP table, then SHOWRUNNER™ will automatically configure the IP-ID for each ZUMNET-JBOX during discovery
62 -1. Set the ZUMNET-JBOX into either Zūm ("App") mode or CNET mode as required for the program
63 -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
64 -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
65 -1. Disconnect from any ZUMNET-JBOXs and then connect to the processor in Toolbox
66 -1. Run the command: ##sr discover zumnet true false##
67 -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
68 -1. Run the command: ##sr discover zumnet true true##
69 -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
70 -1**. One area will be created per ZUMNET-JBOX, and all hardware attached to that ZUMNET-JBOX will be assigned to that area
71 -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
72 -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.
26 +== Pre-Requisites: ==
73 73  
74 -= Zūm Wireless Discovery =
75 -
76 -== Notes and Limitations ==
77 -
78 -(% class="box warningmessage" %)
79 -(((
80 -* Processor with ShowRunnerCLC™ version 2.190 or newer must be running on the same network as the gateway(s) to be acquired
81 -** For ShowRunnerCLC™ versions prior to 3.014 and newer, replace **##sr discover zummesh##** commands with **##sr discover zum##**
82 -* ZUM-NETBRIDGES must already be acquired to their respective gateway
83 -* ShowRunnerCLC™ will automatically address any ZUM-NETBRIDGES that do not need have addresses assigned, but will still honor any already addressed devices
84 -* Disconnect from any RF gateways you may be connected to in Toolbox prior to running the discovery command
85 -* Plug loads will not appear in the ShowRunnerCLC™ UI
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.
86 86  )))
87 87  
88 -(% class="box infomessage" id="HCaution:" %)
33 +(% class="box warningmessage" id="HCaution:" %)
89 89  (((
90 -**Note:** ShowRunnerCLC™ has two different approaches for Zūm Wireless Discovery
35 +**Note:** SHOWRUNNER™ has two different approaches for Zūm Wireless Autodiscovery
91 91  
92 -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.
93 -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.
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.
94 94  )))
95 95  
96 -== Manual RF Gateway Assignment Instructions ==
41 +(% class="row" %)
42 +(((
43 +== Option 1: Manual RF Gateway Claiming: ==
97 97  
98 -Use this method if you have multiple ShowRunnerCLC™ instances on the same network or have gateways used by other Crestron systems.
45 +Use this method if you have multiple ShowRunner instances on the same network or have gateways used by other Crestron systems.
99 99  
100 100  * Connect to the processor's console with Toolbox or your favorite SSH client.
101 -* Type ##sr devmgr ethernet query## and press enter. This queries the local network for RF Gateways.
102 -* Type ##sr devmgr ethernet show devices## and press enter. This displays all found Crestron ethernet devices.
103 -* 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.
104 -* Type ##sr discover zummesh false## and press enter.
105 -* Status messages and the results will be displayed on the console. The process should take about 3 minutes.
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, ShowRunnerCLC™ must be restarted to complete the acquire process.
107 -* Type ##progreset## and press enter to restart ShowRunnerCLC™
108 -* 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.
109 -* Once completed SHOWRUNNER™ is now ready for full Zūm control
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
110 110  
111 -== Claim All RF Gateways Instructions ==
58 +== Option 2: Claim All Gateways: ==
112 112  
113 -Use this method when you have a single ShowRunnerCLC™ instance on a local network with all gateways being used for ShowRunnerCLC™.
60 +Use this method when you have a single ShowRunner instance on a local network with all gateways being used for ShowRunner.
114 114  
115 115  * Connect to the processor's console with Toolbox or your favorite SSH client.
116 -* Type ##sr discover zummesh true## and press enter.
117 -* Status messages and the results will be displayed on the console. The process should take about 3 minutes.
118 -* 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.
119 -* Type ##progreset## and press enter to restart ShowRunnerCLC™
120 -* 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.
121 -* Once completed ShowRunnerCLC™ is now ready for full Zūm control
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
122 122  
123 123  == Examples ==
124 124  
125 -=== Manual Example ===
126 126  
73 +=== Example for Option 1: ===
74 +
127 127  {{{MC4>sr devmgr ethernet query
128 128  Ethrenet AutoDiscovery Result: AutoDiscoveryOperationSuccess
129 129  MC4>sr devmgr ethernet show devices
... ... @@ -141,7 +141,7 @@
141 141  MC4>sr ethernet device claim CEN-GWEXER-9E6ADA
142 142  Claimed ethernet device: CEN-GWEXER-9E6ADA
143 143  MC4>Update request from IP-ID-30 in Program 01
144 -MC4>sr discover zummesh false
92 +MC4>sr discover zum false
145 145  Starting Zum Discovery without gateway claiming
146 146  MC4>Performing Discovery on 1 Gateways.
147 147  Evaluating 3 Devices on Gateway 30
... ... @@ -174,7 +174,7 @@
174 174  MC4>progreset
175 175  ...
176 176  CI ShowRunner startup completed successfully in 8072ms
177 -MC4>sr discover zummesh false
125 +MC4>sr discover zum false
178 178  Starting Zum Discovery without gateway claiming
179 179  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
180 180  Performing Discovery on 1 Gateways.
... ... @@ -225,9 +225,9 @@
225 225  Removed Loads: 0
226 226  Zum Discovery Finished}}}
227 227  
228 -=== Claim All Example ===
176 +=== Example for Option 2: ===
229 229  
230 -{{{MC4>sr discover zummesh true
178 +{{{MC4>sr discover zum true
231 231  Starting Zum Discovery with gateway claiming
232 232  MC4>Found 1 Gateways to check.
233 233  Claimed Gateway SN: 1720JBH04269 at IP-ID: 30
... ... @@ -263,7 +263,7 @@
263 263  MC4>progreset
264 264  ...
265 265  CI ShowRunner startup completed successfully in 8072ms
266 -MC4>sr discover zummesh false
214 +MC4>sr discover zum false
267 267  Starting Zum Discovery without gateway claiming
268 268  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
269 269  Performing Discovery on 1 Gateways.
... ... @@ -314,3 +314,4 @@
314 314  Removed Loads: 0
315 315  Zum Discovery Finished
316 316  }}}
265 +)))