Skip to Content

Changes for page Zūm Discovery

Last modified by Austin Weygandt on 2025/05/02 20:21
From version 23.2
edited by Alexander Mott
on 2023/12/13 19:15
Change comment: Update document after refactoring.
To version 2.1
edited by Alexander Mott
on 2022/09/22 21:44
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
Parent
... ... @@ -1,1 +1,1 @@
1 -SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Program Configuration.WebHome
1 +SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Device Addressing.WebHome
Content
... ... @@ -1,14 +9,6 @@
1 -(% class="box errormessage" %)
2 -(((
3 -**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.
4 -
5 -**WARNING:** Cresnet Discovery is non-functional for ZUMNET-JBOXs with certain versions of Crestron Device Database.
6 -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.
7 -)))
8 -
9 9  (% class="box warningmessage" %)
10 10  (((
11 -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]].
12 12  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]].
13 13  )))
14 14  
... ... @@ -16,131 +16,71 @@
16 16  {{toc/}}
17 17  {{/box}}
18 18  
19 -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
20 20  
21 -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 =
22 22  
23 -= Zūm Wired Discovery =
17 +Lorem
24 24  
25 -== Notes and Limitations ==
19 += Zūm Wireless =
26 26  
27 -(% class="box warningmessage" %)
28 -(((
29 -* ShowRunnerCLC™ version 3.014 or newer required
30 -* Zūm Wired firmware .puf version 1.02.10 or greater required (ZUMNET-JBOX installed minimum version 1.001.00081)
31 -* Disconnect from any ZUMNET devices you may be connected to in Toolbox prior to running the discovery commands
32 -* Cresnet devices landed on Zūm Link will not be discovered (Crestron bug expected to be corrected in a future firmware release)
33 -* One area will be created per ZUMNET-JBOX; if there are more areas than ZUMNET-JBOXs, additional areas must be created manually
34 -)))
35 35  
36 -== 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*
37 37  
38 -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
39 -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.
40 -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: 
41 -1*. Connect to the first ZUMNET-JBOX in Toolbox
42 -1*. Configure a static IP address for the ZUMNET-JBOX if there is no DHCP server on the network 
43 -1**. Note: The ShowRunnerCLC™ built-in DHCP server is not meant to be used in production
44 -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
45 -1*. Set unique Connection IDs for each device hosted on the ZUMNET-JBOX so that their firmware can be updated
46 -1*. Load the Zūm Wired firmware to the ZUMNET-JBOX
47 -1*. Repeat the above steps for all ZUMNET-JBOXs
48 -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
49 -1. Connect to first ZUMNET-JBOX in the Crestron Zūm App
50 -1. Unique Connection IDs should be automatically assigned to any Zūm Link and Cresnet devices on the ZUMNET-JBOX
51 -1*. If firmware was out-of-date, then this step should have already been completed
52 -1*. If unique CIDs are not automatically assigned, connect to the JBOX in Toolbox and give the devices unique CIDs
53 -1. Configure a static IP address for the ZUMNET-JBOX if there is no DHCP server on the network 
54 -1*. If firmware was out-of-date, then this step should have already been completed
55 -1*. Note: The ShowRunnerCLC™ built-in DHCP server is not meant to be used in production
56 -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
57 -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
58 -1*. If you do not manually configure the IP table, then SHOWRUNNER™ will automatically configure the IP-ID for each ZUMNET-JBOX during discovery
59 -1. Set the ZUMNET-JBOX into either Zūm ("App") mode or CNET mode as required for the program
60 -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
61 -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
62 -1. Disconnect from any ZUMNET-JBOXs and then connect to the processor in Toolbox
63 -1. Run the command: ##sr discover zumnet true false##
64 -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
65 -1. Run the command: ##sr discover zumnet true true##
66 -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
67 -1**. One area will be created per ZUMNET-JBOX, and all hardware attached to that ZUMNET-JBOX will be assigned to that area
68 -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
69 -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:** ==
70 70  
71 -= Zūm Wireless Discovery =
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.
72 72  
73 -== Notes and Limitations ==
32 +=== **Caution:** ===
74 74  
75 -(% class="box warningmessage" %)
76 -(((
77 -* Processor with ShowRunnerCLC™ version 2.190 or newer must be running on the same network as the gateway(s) to be acquired
78 -** For ShowRunnerCLC™ versions prior to 3.014 and newer, replace **##sr discover zummesh##** commands with **##sr discover zum##**
79 -* ZUM-NETBRIDGES must already be acquired to their respective gateway
80 -* ShowRunnerCLC™ will automatically address any ZUM-NETBRIDGES that do not need have addresses assigned, but will still honor any already addressed devices
81 -* Disconnect from any RF gateways you may be connected to in Toolbox prior to running the discovery command
82 -* Plug loads will not appear in the ShowRunnerCLC™ UI
83 -)))
34 +* ShowRunner has 2 discovery approaches.
35 +** Option 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.
36 +** Option 2: 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.
84 84  
85 -(% class="box infomessage" id="HCaution:" %)
86 -(((
87 -**Note:** ShowRunnerCLC™ has two different approaches for Zūm Wireless Discovery
38 +== Option 1: Claim All Gateways: ==
88 88  
89 -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.
90 -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.
91 -)))
40 +Use this method when you have a single ShowRunner instance on a local network with all gateways being used for ShowRunner.
92 92  
93 -== Manual RF Gateway Assignment Instructions ==
94 -
95 -Use this method if you have multiple ShowRunnerCLC™ instances on the same network or have gateways used by other Crestron systems.
96 -
97 97  * Connect to the processor's console with Toolbox or your favorite SSH client.
98 -* Type ##sr devmgr ethernet query## and press enter. This queries the local network for RF Gateways.
99 -* Type ##sr devmgr ethernet show devices## and press enter. This displays all found Crestron ethernet devices.
100 -* 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.
101 -* Type ##sr discover zummesh false## and press enter.
102 -* Status messages and the results will be displayed on the console. The process should take about 3 minutes.
103 -* 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.
104 -* Type ##progreset## and press enter to restart ShowRunnerCLC™
105 -* 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.
106 -* Once completed SHOWRUNNER™ is now ready for full Zūm control
43 +* Type "//sr discover zum true//" and press enter.
44 +* Status messages and the results will be displayed on the console. The process should take about 3 minutes.
45 +* 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.
46 +* Type "//progreset//" and press enter to restart ShowRunner
47 +* 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.
48 +* Once completed ShowRunner is now ready for full Zum control
107 107  
108 -== Claim All RF Gateways Instructions ==
50 +== Option 2: Manual RF Gateway Claiming: ==
109 109  
110 -Use this method when you have a single ShowRunnerCLC™ instance on a local network with all gateways being used for ShowRunnerCLC™.
52 +Use this method if you have multiple ShowRunner instances on the same network or have gateways used by other Crestron systems.
111 111  
112 112  * Connect to the processor's console with Toolbox or your favorite SSH client.
113 -* Type ##sr discover zummesh true## and press enter.
114 -* Status messages and the results will be displayed on the console. The process should take about 3 minutes.
115 -* 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.
116 -* Type ##progreset## and press enter to restart ShowRunnerCLC™
117 -* 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.
118 -* Once completed ShowRunnerCLC™ is now ready for full Zūm control
55 +* Type "//sr devmgr ethernet query//" and press enter. This queries the local network for RF Gateways.
56 +* Type "//sr devmgr ethernet show devices//" and press enter. This displays all found Crestron ethernet devices.
57 +* 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.
58 +* Type "//sr discover zum false//" and press enter.
59 +* Status messages and the results will be displayed on the console. The process should take about 3 minutes.
60 +* 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.
61 +* Type "//progreset//" and press enter to restart ShowRunner
62 +* 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.
63 +* Once completed ShowRunner is now ready for full Zum control
119 119  
120 120  == Examples ==
121 121  
122 -=== Manual Example ===
67 +=== Example for Option 1: ===
123 123  
124 -{{{MC4>sr devmgr ethernet query
125 -Ethrenet AutoDiscovery Result: AutoDiscoveryOperationSuccess
126 -MC4>sr devmgr ethernet show devices
127 -
128 -+--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
129 -| Adapter | Hostname | IP Address | IP-ID | ID |
130 -+--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
131 -| EthernetLANAdapter | CI-SJC-CEN-CI3-1-COM3 | 10.44.5.20 | 00 | CEN-CI3-1-C3COM-3 [v1.1620.00000, #008436E2] type:1 |
132 -+--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
133 -| EthernetLANAdapter | SB-DIN-CENCN-2 | 10.44.5.81 | 00 | DIN-CENCN-2-POE [v1.3544.00006, #8AB25AA3] |
134 -+--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
135 -| EthernetLANAdapter | CEN-GWEXER-9E6ADA | 10.44.5.120 | 00 | CEN-GWEXER [v1.4230.00015, #848210AD] |
136 -+--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
137 -
138 -MC4>sr ethernet device claim CEN-GWEXER-9E6ADA
139 -Claimed ethernet device: CEN-GWEXER-9E6ADA
140 -MC4>Update request from IP-ID-30 in Program 01
141 -MC4>sr discover zummesh false
142 -Starting Zum Discovery without gateway claiming
143 -MC4>Performing Discovery on 1 Gateways.
69 +{{{MC4>sr discover zum true
70 +Starting Zum Discovery with gateway claiming
71 +MC4>Found 1 Gateways to check.
72 +Claimed Gateway SN: 1720JBH04269 at IP-ID: 30
73 +Update request from IP-ID-30 in Program 01
74 +Claimed 1 Gateways. Waiting for queries to finish.
75 +Performing Discovery on 1 Gateways.
144 144  Evaluating 3 Devices on Gateway 30
145 145  Claiming ZUM-NETBRIDGE SN: 1726NEJ01096 from IP-ID: 30
146 146  Dev: ZUM-NETBRIDGE addrssing to RF ID: 03
... ... @@ -151,7 +151,6 @@
151 151  Claiming ZUM-NETBRIDGE SN: 1914NEJ03098 from IP-ID: 30
152 152  Dev: ZUM-NETBRIDGE addrssing to RF ID: 05
153 153  Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 05
154 -Querying cresnet
155 155  Discovering Zum Loads on 1 Gateways.
156 156  Discovering Zum Loads on 3 Devices.
157 157  NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0
... ... @@ -171,7 +171,7 @@
171 171  MC4>progreset
172 172  ...
173 173  CI ShowRunner startup completed successfully in 8072ms
174 -MC4>sr discover zummesh false
105 +MC4>sr discover zum false
175 175  Starting Zum Discovery without gateway claiming
176 176  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
177 177  Performing Discovery on 1 Gateways.
... ... @@ -220,17 +220,31 @@
220 220  New Loads: 6
221 221  Modified Loads: 0
222 222  Removed Loads: 0
223 -Zum Discovery Finished}}}
154 +Zum Discovery Finished
155 +}}}
224 224  
225 -=== Claim All Example ===
157 +=== Example for Option 2: ===
226 226  
227 -{{{MC4>sr discover zummesh true
228 -Starting Zum Discovery with gateway claiming
229 -MC4>Found 1 Gateways to check.
230 -Claimed Gateway SN: 1720JBH04269 at IP-ID: 30
231 -Update request from IP-ID-30 in Program 01
232 -Claimed 1 Gateways. Waiting for queries to finish.
233 -Performing Discovery on 1 Gateways.
159 +{{{MC4>sr devmgr ethernet query
160 +Ethrenet AutoDiscovery Result: AutoDiscoveryOperationSuccess
161 +MC4>sr devmgr ethernet show devices
162 +
163 ++--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
164 +| Adapter | Hostname | IP Address | IP-ID | ID |
165 ++--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
166 +| EthernetLANAdapter | CI-SJC-CEN-CI3-1-COM3 | 10.44.5.20 | 00 | CEN-CI3-1-C3COM-3 [v1.1620.00000, #008436E2] type:1 |
167 ++--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
168 +| EthernetLANAdapter | SB-DIN-CENCN-2 | 10.44.5.81 | 00 | DIN-CENCN-2-POE [v1.3544.00006, #8AB25AA3] |
169 ++--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
170 +| EthernetLANAdapter | CEN-GWEXER-9E6ADA | 10.44.5.120 | 00 | CEN-GWEXER [v1.4230.00015, #848210AD] |
171 ++--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
172 +
173 +MC4>sr ethernet device claim CEN-GWEXER-9E6ADA
174 +Claimed ethernet device: CEN-GWEXER-9E6ADA
175 +MC4>Update request from IP-ID-30 in Program 01
176 +MC4>sr discover zum false
177 +Starting Zum Discovery without gateway claiming
178 +MC4>Performing Discovery on 1 Gateways.
234 234  Evaluating 3 Devices on Gateway 30
235 235  Claiming ZUM-NETBRIDGE SN: 1726NEJ01096 from IP-ID: 30
236 236  Dev: ZUM-NETBRIDGE addrssing to RF ID: 03
... ... @@ -241,6 +241,7 @@
241 241  Claiming ZUM-NETBRIDGE SN: 1914NEJ03098 from IP-ID: 30
242 242  Dev: ZUM-NETBRIDGE addrssing to RF ID: 05
243 243  Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 05
189 +Querying cresnet
244 244  Discovering Zum Loads on 1 Gateways.
245 245  Discovering Zum Loads on 3 Devices.
246 246  NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0
... ... @@ -260,7 +260,7 @@
260 260  MC4>progreset
261 261  ...
262 262  CI ShowRunner startup completed successfully in 8072ms
263 -MC4>sr discover zummesh false
209 +MC4>sr discover zum false
264 264  Starting Zum Discovery without gateway claiming
265 265  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
266 266  Performing Discovery on 1 Gateways.
... ... @@ -310,4 +310,5 @@
310 310  Modified Loads: 0
311 311  Removed Loads: 0
312 312  Zum Discovery Finished
313 -}}}
259 + }}}
260 +)))