Skip to Content

Changes for page Zūm Discovery

Last modified by Austin Weygandt on 2025/05/02 20:21
From version 35.1
edited by Alexander Mott
on 2024/10/16 18:04
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
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.SHOWRUNNER™ Installation Guide.Preparation.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,159 +16,70 @@
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 -= Discovery Filter (ShowRunnerCLC™ 3.062 or newer) =
17 +Lorem
24 24  
25 -Discovered ethernet devices may be filtered using either a hostname or IP Address filter.  The filter is configured from the command line interface.
19 += Zūm Wireless =
26 26  
27 -##+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+
28 -~| Command | Help |
29 -~|~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-|~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-|
30 -~| SR discover clear filter | Remove Discovery Filter |
31 -~| SR discover filter | Show Discovery Filter |
32 -~| SR discover filter (X:S) | Set Discovery Filter |
33 -~| - | (X):S:Filter String |
34 -~|~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-|~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-|##
35 35  
36 -=== Hostname Filter ===
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 -The Hostname filter uses a regular expression to filter discovered ZUMNET GATEWAYs or JBOXs.  Multiple expressions can be applied by using a comma to separate the expressions.
26 +== Pre-Requisites: ==
39 39  
40 -Command Syntax: ##"Type='Hostname' Settings='Expr1[,Expr2]'"##
41 -
42 -Examples:
43 -
44 -1. Only include hostnames that start with ZUMNET-06:
45 -(% style="font-family:Menlo,Monaco,Consolas,Courier New,monospace; white-space:pre" %)sr discover filter "Type='Hostname' Settings='^ZUMNET-06'"
46 -1. Include hostnames that start with ZUMNET-FL01 or contain FL03:
47 -(% style="font-family:Menlo,Monaco,Consolas,Courier New,monospace; white-space:pre" %)sr discover filter "Type='Hostname' Settings='^ZUMNET-FL01,FL03'"
48 -
49 -=== IP Address Filter ===
50 -
51 -The IP Address filter will restrict discovered ZUMNET GATEWAYs or JBOXs to matching IP Addresses or IP Address ranges.  Multiple addresses and ranges can be used.
52 -
53 -Command Syntax: ##"Type='IPAddress' Settings='Address[,AddressStart-AddressEnd]'"##
54 -
55 -Examples:
56 -
57 -1. Only include a device with an address of 192.168.0.10 or 192.168.0.50:
58 -(% style="font-family:Menlo,Monaco,Consolas,Courier New,monospace; white-space:pre" %)sr discover filter "Type='IPAddress' Settings='192.168.0.10,192.168.0.50'"
59 -1. Include addresses between 192.168.0.11 and 192.168.0.50 and 192.168.0.200 and 192.168.0.240:
60 -(% style="font-family:Menlo,Monaco,Consolas,Courier New,monospace; white-space:pre" %)sr discover filter "Type='IPAddress' Settings='192.168.0.11-192.168.0.50,192.168.0.200-192.168.0.240'"
61 -
62 -= Zūm Wired Discovery =
63 -
64 -== Notes and Limitations ==
65 -
66 -(% class="box warningmessage" %)
67 -(((
68 -* ShowRunnerCLC™ version 3.014 or newer required
69 -* Zūm Wired firmware .puf version 1.02.10 or greater required (ZUMNET-JBOX installed minimum version 1.001.00081)
70 -* Disconnect from any ZUMNET devices you may be connected to in Toolbox and confirm all hardware (NETs and LINKs) are online prior to running the discovery commands
71 -* Cresnet devices landed on Zūm Link will not be discovered (Crestron bug expected to be corrected in a future firmware release)
72 -* ZUMLINK-IOs will not be discovered (Expected to be discoverable in future ShowRunnerCLC™ release)
73 -* ZUMLINK-KPs will not be discovered on older versions of ShowRunnerCLC™ (v3.058 or newer will discover keypads and set as remote type)
74 -* One area will be created per ZUMNET-JBOX; if there are more areas than ZUMNET-JBOXs, additional areas must be created manually
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 75  )))
76 76  
77 -== Steps ==
78 -
79 -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
80 -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.
81 -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: 
82 -1*. Connect to the first ZUMNET-JBOX in Toolbox
83 -1*. Configure a static IP address for the ZUMNET-JBOX if there is no DHCP server on the network 
84 -1**. Note: The ShowRunnerCLC™ built-in DHCP server is not meant to be used in production
85 -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
86 -1*. Set unique Connection IDs for each device hosted on the ZUMNET-JBOX so that their firmware can be updated
87 -1*. Load the Zūm Wired firmware to the ZUMNET-JBOX
88 -1*. Repeat the above steps for all ZUMNET-JBOXs
89 -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
90 -1. Connect to each ZUMNET-JBOX in the Crestron Zūm App
91 -1*. Commission room through the app
92 -1**. configure keypad logic
93 -1**. configure occupancy sensor settings
94 -1**. calibrate photocell(s)
95 -1*. Set hostnames for the ZUMNETs.
96 -1**. Zūm discovery will bring in hostnames.
97 -1. Unique Connection IDs should be automatically assigned to any Zūm Link and Cresnet devices on the ZUMNET-JBOX
98 -1*. If firmware was out-of-date, then this step should have already been completed
99 -1*. If unique CIDs are not automatically assigned, connect to the JBOX in Toolbox and give the devices unique CIDs
100 -1. Configure a static IP address for the ZUMNET-JBOX if there is no DHCP server on the network 
101 -1*. If firmware was out-of-date, then this step should have already been completed
102 -1*. Note: The ShowRunnerCLC™ built-in DHCP server is not meant to be used in production
103 -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
104 -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
105 -1*. If you do not manually configure the IP table, then SHOWRUNNER™ will automatically configure the IP-ID for each ZUMNET-JBOX during discovery
106 -1. Set the ZUMNET-JBOX into either Zūm ("App") mode or CNET mode as required for the program
107 -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
108 -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
109 -1. Disconnect from any ZUMNET-JBOXs and then connect to the processor in Toolbox
110 -1. If trying to Auto Discover on a job with multiple processors or you are returning to a job where new ZUMNET-JBOXs have been added and you only wish to Auto Discover those new devices, ShowRunnerCLC™ 3.062 and newer allow [[filtering based on hostname or IP address>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Program Configuration.Zūm Discovery.WebHome#HDiscoveryFilter(ShowRunnerCLC™3.062ornewer)]] in order to limit the devices that are brought into the ShowRunnerCLC™ configuration
111 -1. Run the command: ##sr discover zumnet true true##
112 -1*. This command tells ShowRunnerCLC™ to both claim all 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
113 -1**. One area will be created per ZUMNET-JBOX, and all hardware attached to that ZUMNET-JBOX will be assigned to that area
114 -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
115 -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.
116 -1. If new Zūm Link hardware has been added, it is not necessary to do a full Auto Discovery to bring the new devices into ShowRunnerCLC™; instead you can just run ##sr discover zumnet false true## to bring in the new Zūm Link devices without claiming any new Zūm Net devices
117 -
118 -= Zūm Wireless Discovery =
119 -
120 -== Notes and Limitations ==
121 -
122 -(% class="box warningmessage" %)
33 +(% class="box warningmessage" id="HCaution:" %)
123 123  (((
124 -* Processor with ShowRunnerCLC™ version 2.190 or newer must be running on the same network as the gateway(s) to be acquired
125 -** For ShowRunnerCLC™ versions prior to 3.014 and newer, replace **##sr discover zummesh##** commands with **##sr discover zum##**
126 -* ZUM-NETBRIDGES must already be acquired to their respective gateway
127 -* ShowRunnerCLC™ will automatically address any ZUM-NETBRIDGES that do not need have addresses assigned, but will still honor any already addressed devices
128 -* Disconnect from any RF gateways you may be connected to in Toolbox prior to running the discovery command
129 -* Plug loads will not appear in the ShowRunnerCLC™ UI
130 -* Newer GWEXER firmware enables SSL by default. Follow the instructions at [[SSL User Configuration>>doc:SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Appendix.SSL User Configuration.WebHome]] and manually add the IP Table entries on the GWEXER
35 +**Note:** SHOWRUNNER™ has two different approaches for Zūm Wireless Autodiscovery
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.
131 131  )))
132 132  
133 -(% class="box infomessage" id="HCaution:" %)
41 +(% class="row" %)
134 134  (((
135 -**Note:** ShowRunnerCLC™ has two different approaches for Zūm Wireless Discovery
43 +== Option 1: Manual RF Gateway Claiming: ==
136 136  
137 -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.
138 -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.
139 -)))
45 +Use this method if you have multiple ShowRunner instances on the same network or have gateways used by other Crestron systems.
140 140  
141 -== Manual RF Gateway Assignment Instructions ==
142 -
143 -Use this method if you have multiple ShowRunnerCLC™ instances on the same network or have gateways used by other Crestron systems.
144 -
145 145  * Connect to the processor's console with Toolbox or your favorite SSH client.
146 -* Type ##sr devmgr ethernet query## and press enter. This queries the local network for RF Gateways.
147 -* Type ##sr devmgr ethernet show devices## and press enter. This displays all found Crestron ethernet devices.
148 -* 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.
149 -* Type ##sr discover zummesh false## and press enter.
150 -* Status messages and the results will be displayed on the console. The process should take about 3 minutes.
151 -* 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.
152 -* Type ##progreset## and press enter to restart ShowRunnerCLC™
153 -* 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.
154 -* 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
155 155  
156 -== Claim All RF Gateways Instructions ==
58 +== Option 2: Claim All Gateways: ==
157 157  
158 -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.
159 159  
160 160  * Connect to the processor's console with Toolbox or your favorite SSH client.
161 -* Type ##sr discover zummesh true## and press enter.
162 -* Status messages and the results will be displayed on the console. The process should take about 3 minutes.
163 -* 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.
164 -* Type ##progreset## and press enter to restart ShowRunnerCLC™
165 -* 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.
166 -* 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
167 167  
168 168  == Examples ==
169 169  
170 -=== Manual Example ===
171 171  
73 +=== Example for Option 1: ===
74 +
172 172  {{{MC4>sr devmgr ethernet query
173 173  Ethrenet AutoDiscovery Result: AutoDiscoveryOperationSuccess
174 174  MC4>sr devmgr ethernet show devices
... ... @@ -186,7 +186,7 @@
186 186  MC4>sr ethernet device claim CEN-GWEXER-9E6ADA
187 187  Claimed ethernet device: CEN-GWEXER-9E6ADA
188 188  MC4>Update request from IP-ID-30 in Program 01
189 -MC4>sr discover zummesh false
92 +MC4>sr discover zum false
190 190  Starting Zum Discovery without gateway claiming
191 191  MC4>Performing Discovery on 1 Gateways.
192 192  Evaluating 3 Devices on Gateway 30
... ... @@ -219,7 +219,7 @@
219 219  MC4>progreset
220 220  ...
221 221  CI ShowRunner startup completed successfully in 8072ms
222 -MC4>sr discover zummesh false
125 +MC4>sr discover zum false
223 223  Starting Zum Discovery without gateway claiming
224 224  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
225 225  Performing Discovery on 1 Gateways.
... ... @@ -270,9 +270,9 @@
270 270  Removed Loads: 0
271 271  Zum Discovery Finished}}}
272 272  
273 -=== Claim All Example ===
176 +=== Example for Option 2: ===
274 274  
275 -{{{MC4>sr discover zummesh true
178 +{{{MC4>sr discover zum true
276 276  Starting Zum Discovery with gateway claiming
277 277  MC4>Found 1 Gateways to check.
278 278  Claimed Gateway SN: 1720JBH04269 at IP-ID: 30
... ... @@ -308,7 +308,7 @@
308 308  MC4>progreset
309 309  ...
310 310  CI ShowRunner startup completed successfully in 8072ms
311 -MC4>sr discover zummesh false
214 +MC4>sr discover zum false
312 312  Starting Zum Discovery without gateway claiming
313 313  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
314 314  Performing Discovery on 1 Gateways.
... ... @@ -359,3 +359,4 @@
359 359  Removed Loads: 0
360 360  Zum Discovery Finished
361 361  }}}
265 +)))