Skip to Content

Changes for page Zūm Discovery

Last modified by Austin Weygandt on 2025/05/02 20:21
From version 33.1
edited by Mark Kohlmann
on 2024/10/14 21:55
Change comment: There is no comment for this version
To version 6.7
edited by Alexander Mott
on 2022/09/22 23:57
Change comment: (Autosaved)

Summary

Details

Page properties
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
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.mark\.kohlmann@chiefintegrations\.com
1 +XWiki.alexander\.mott@chiefintegrations\.com
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 Discovery 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,141 +16,74 @@
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 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™.
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 +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.
22 22  
23 -= Discovery Filter =
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.
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 -
36 -=== Hostname Filter ===
37 -
38 -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.
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 49  = Zūm Wired Discovery =
50 50  
51 51  == Notes and Limitations ==
52 52  
53 -(% class="box warningmessage" %)
54 -(((
55 -* ShowRunnerCLC™ version 3.014 or newer required
56 -* Zūm Wired firmware .puf version 1.02.10 or greater required (ZUMNET-JBOX installed minimum version 1.001.00081)
57 -* 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
21 +* SHOWRUNNER™ version 3.014 or newer required
22 +* Zūm Wired firmware version 1.02.10 or greater required
23 +* Disconnect from any ZUMNET devices you may be connected to in Toolbox prior to running the discovery commands
58 58  * Cresnet devices landed on Zūm Link will not be discovered (Crestron bug expected to be corrected in a future firmware release)
59 -* ZUMLINK-IOs will not be discovered (Expected to be discoverable in future ShowRunnerCLC™ release)
60 -* ZUMLINK-KPs will not be discovered on older versions of ShowRunnerCLC™ (v3.058 or newer will discover keypads and set as remote type)
61 61  * One area will be created per ZUMNET-JBOX; if there are more areas than ZUMNET-JBOXs, additional areas must be created manually
62 -)))
63 63  
64 64  == Steps ==
65 65  
66 -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
67 -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.
68 -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: 
69 -1*. Connect to the first ZUMNET-JBOX in Toolbox
70 -1*. Configure a static IP address for the ZUMNET-JBOX if there is no DHCP server on the network 
71 -1**. Note: The ShowRunnerCLC™ built-in DHCP server is not meant to be used in production
72 -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
73 -1*. Set unique Connection IDs for each device hosted on the ZUMNET-JBOX so that their firmware can be updated
74 -1*. Load the Zūm Wired firmware to the ZUMNET-JBOX
75 -1*. Repeat the above steps for all ZUMNET-JBOXs
76 -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
77 -1. Connect to each ZUMNET-JBOX in the Crestron Zūm App
78 -1*. Commission room through the app
79 -1**. configure keypad logic
80 -1**. configure occupancy sensor settings
81 -1**. calibrate photocell(s)
82 -1*. Set hostnames for the ZUMNETs.
83 -1**. Zūm discovery will bring in hostnames.
84 -1. Unique Connection IDs should be automatically assigned to any Zūm Link and Cresnet devices on the ZUMNET-JBOX
85 -1*. If firmware was out-of-date, then this step should have already been completed
86 -1*. If unique CIDs are not automatically assigned, connect to the JBOX in Toolbox and give the devices unique CIDs
87 -1. Configure a static IP address for the ZUMNET-JBOX if there is no DHCP server on the network 
88 -1*. If firmware was out-of-date, then this step should have already been completed
89 -1*. Note: The ShowRunnerCLC™ built-in DHCP server is not meant to be used in production
90 -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
91 -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
92 -1*. If you do not manually configure the IP table, then SHOWRUNNER™ will automatically configure the IP-ID for each ZUMNET-JBOX during discovery
93 -1. Set the ZUMNET-JBOX into either Zūm ("App") mode or CNET mode as required for the program
94 -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
95 -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
96 -1. Disconnect from any ZUMNET-JBOXs and then connect to the processor in Toolbox
97 -1. Run the command: ##sr discover zumnet true false##
98 -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
99 -1. Run the command: ##sr discover zumnet true true##
100 -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
101 -1**. One area will be created per ZUMNET-JBOX, and all hardware attached to that ZUMNET-JBOX will be assigned to that area
102 -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
103 -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.
29 +1.
104 104  
105 105  = Zūm Wireless Discovery =
106 106  
107 107  == Notes and Limitations ==
108 108  
109 -(% class="box warningmessage" %)
110 -(((
111 -* Processor with ShowRunnerCLC™ version 2.190 or newer must be running on the same network as the gateway(s) to be acquired
112 -** For ShowRunnerCLC™ versions prior to 3.014 and newer, replace **##sr discover zummesh##** commands with **##sr discover zum##**
35 +* Processor with SHOWRUNNER™ version 2.190 or newer must be running on the same network as the gateway(s) to be acquired
36 +** For SHOWRUNNER™ versions 3.014 and newer, replace ##sr discover zum## commands with ##sr discover zummesh##
113 113  * ZUM-NETBRIDGES must already be acquired to their respective gateway
114 -* ShowRunnerCLC™ will automatically address any ZUM-NETBRIDGES that do not need have addresses assigned, but will still honor any already addressed devices
38 +* SHOWRUNNER™ will automatically address any ZUM-NETBRIDGES that do not need have addresses assigned, but will still honor any already addressed devices
115 115  * Disconnect from any RF gateways you may be connected to in Toolbox prior to running the discovery command
116 -* Plug loads will not appear in the ShowRunnerCLC™ UI
117 -* 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
40 +* Plug loads will not appear in the SHOWRUNNER™ UI
118 118  )))
119 119  
120 -(% class="box infomessage" id="HCaution:" %)
43 +(% class="box warningmessage" id="HCaution:" %)
121 121  (((
122 -**Note:** ShowRunnerCLC™ has two different approaches for Zūm Wireless Discovery
45 +**Note:** SHOWRUNNER™ has two different approaches for Zūm Wireless Discovery
123 123  
124 -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.
125 -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.
47 +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.
48 +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.
126 126  )))
127 127  
51 +(% class="row" %)
52 +(((
128 128  == Manual RF Gateway Assignment Instructions ==
129 129  
130 -Use this method if you have multiple ShowRunnerCLC™ instances on the same network or have gateways used by other Crestron systems.
55 +Use this method if you have multiple SHOWRUNNER™ instances on the same network or have gateways used by other Crestron systems.
131 131  
132 132  * Connect to the processor's console with Toolbox or your favorite SSH client.
133 -* Type ##sr devmgr ethernet query## and press enter. This queries the local network for RF Gateways.
134 -* Type ##sr devmgr ethernet show devices## and press enter. This displays all found Crestron ethernet devices.
135 -* 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.
136 -* Type ##sr discover zummesh false## and press enter.
58 +* Type "//sr devmgr ethernet query//" and press enter. This queries the local network for RF Gateways.
59 +* Type "//sr devmgr ethernet show devices//" and press enter. This displays all found Crestron ethernet devices.
60 +* 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.
61 +* Type "//sr discover zum false//" and press enter.
137 137  * Status messages and the results will be displayed on the console. The process should take about 3 minutes.
138 -* 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.
139 -* Type ##progreset## and press enter to restart ShowRunnerCLC™
140 -* 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.
63 +* 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.
64 +* Type "//progreset//" and press enter to restart SHOWRUNNER™
65 +* 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.
141 141  * Once completed SHOWRUNNER™ is now ready for full Zūm control
142 142  
143 143  == Claim All RF Gateways Instructions ==
144 144  
145 -Use this method when you have a single ShowRunnerCLC™ instance on a local network with all gateways being used for ShowRunnerCLC™.
70 +Use this method when you have a single SHOWRUNNER™ instance on a local network with all gateways being used for SHOWRUNNER™.
146 146  
147 147  * Connect to the processor's console with Toolbox or your favorite SSH client.
148 -* Type ##sr discover zummesh true## and press enter.
73 +* Type "//sr discover zum true//" and press enter.
149 149  * Status messages and the results will be displayed on the console. The process should take about 3 minutes.
150 -* 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.
151 -* Type ##progreset## and press enter to restart ShowRunnerCLC™
152 -* 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.
153 -* Once completed ShowRunnerCLC™ is now ready for full Zūm control
75 +* 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.
76 +* Type "//progreset//" and press enter to restart SHOWRUNNER™
77 +* 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.
78 +* Once completed SHOWRUNNER™ is now ready for full Zūm control
154 154  
155 155  == Examples ==
156 156  
... ... @@ -173,7 +173,7 @@
173 173  MC4>sr ethernet device claim CEN-GWEXER-9E6ADA
174 174  Claimed ethernet device: CEN-GWEXER-9E6ADA
175 175  MC4>Update request from IP-ID-30 in Program 01
176 -MC4>sr discover zummesh false
101 +MC4>sr discover zum false
177 177  Starting Zum Discovery without gateway claiming
178 178  MC4>Performing Discovery on 1 Gateways.
179 179  Evaluating 3 Devices on Gateway 30
... ... @@ -206,7 +206,7 @@
206 206  MC4>progreset
207 207  ...
208 208  CI ShowRunner startup completed successfully in 8072ms
209 -MC4>sr discover zummesh false
134 +MC4>sr discover zum false
210 210  Starting Zum Discovery without gateway claiming
211 211  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
212 212  Performing Discovery on 1 Gateways.
... ... @@ -259,7 +259,7 @@
259 259  
260 260  === Claim All Example ===
261 261  
262 -{{{MC4>sr discover zummesh true
187 +{{{MC4>sr discover zum true
263 263  Starting Zum Discovery with gateway claiming
264 264  MC4>Found 1 Gateways to check.
265 265  Claimed Gateway SN: 1720JBH04269 at IP-ID: 30
... ... @@ -295,7 +295,7 @@
295 295  MC4>progreset
296 296  ...
297 297  CI ShowRunner startup completed successfully in 8072ms
298 -MC4>sr discover zummesh false
223 +MC4>sr discover zum false
299 299  Starting Zum Discovery without gateway claiming
300 300  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
301 301  Performing Discovery on 1 Gateways.
... ... @@ -346,3 +346,4 @@
346 346  Removed Loads: 0
347 347  Zum Discovery Finished
348 348  }}}
274 +)))