Skip to Content

Changes for page Zūm Discovery

Last modified by Austin Weygandt on 2025/05/02 20:21
From version 23.1
edited by Alexander Mott
on 2023/12/12 18:30
Change comment: There is no comment for this version
To version 8.1
edited by Alexander Mott
on 2022/09/23 00:00
Change comment: There is no comment for this version

Summary

Details

Page properties
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 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,32 +16,31 @@
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 23  = Zūm Wired Discovery =
24 24  
25 25  == Notes and Limitations ==
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)
21 +* SHOWRUNNER™ version 3.014 or newer required
22 +* Zūm Wired firmware version 1.02.10 or greater required
31 31  * Disconnect from any ZUMNET devices you may be connected to in Toolbox prior to running the discovery commands
32 32  * Cresnet devices landed on Zūm Link will not be discovered (Crestron bug expected to be corrected in a future firmware release)
33 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 36  == Steps ==
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
29 +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 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 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 41  1*. Connect to the first ZUMNET-JBOX in Toolbox
42 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
34 +1**. Note: The SHOWRUNNER™ built-in DHCP server is not meant to be used in production
35 +1**. If the SHOWRUNNER™ built-in DHCP server was used to assign IP addresses to devices, it is still necessary to give those devices static IP addresses
45 45  1*. Set unique Connection IDs for each device hosted on the ZUMNET-JBOX so that their firmware can be updated
46 46  1*. Load the Zūm Wired firmware to the ZUMNET-JBOX
47 47  1*. Repeat the above steps for all ZUMNET-JBOXs
... ... @@ -52,70 +52,69 @@
52 52  1*. If unique CIDs are not automatically assigned, connect to the JBOX in Toolbox and give the devices unique CIDs
53 53  1. Configure a static IP address for the ZUMNET-JBOX if there is no DHCP server on the network 
54 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
46 +1*. Note: The SHOWRUNNER™ built-in DHCP server is not meant to be used in production
47 +1*. If the SHOWRUNNER™ built-in DHCP server was used to assign IP addresses to devices, it is still necessary to give those devices static IP addresses
57 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 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
50 +1. Repeat from step 3 until all ZUMNET-JBOXs that are to be controlled by SHOWRUNNER™ have static IP addresses and unique CIDs for any hosted devices
62 62  1. Disconnect from any ZUMNET-JBOXs and then connect to the processor in Toolbox
63 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
53 +1*. This command tells SHOWRUNNER™ to discover all ZUMMNET-JBOXs on the network, configure their IP tables, and then add corresponding areas and loads to the configuration
54 +1*. One area will be created per ZUMNET-JBOX
65 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
56 +1*. This command tells SHOWRUNNER™ to discover all Zūm Link hardware on the previously discovered Zūm Net devices
68 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.
58 +1. Put all ZUMNET-JBOXs into CNET mode in order to allow full control from SHOWRUNNER™
59 +1*. Odd behavior may result from conflicts between SHOWRUNNER™ and internal logic if the ZUMNET-JBOXs are not put into CNET mode
70 70  
71 71  = Zūm Wireless Discovery =
72 72  
73 73  == Notes and Limitations ==
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##**
65 +* Processor with SHOWRUNNER™ version 2.190 or newer must be running on the same network as the gateway(s) to be acquired
66 +** For SHOWRUNNER™ versions 3.014 and newer, replace ##sr discover zum## commands with ##sr discover zummesh##
79 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
68 +* SHOWRUNNER™ will automatically address any ZUM-NETBRIDGES that do not need have addresses assigned, but will still honor any already addressed devices
81 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
70 +* Plug loads will not appear in the SHOWRUNNER™ UI
83 83  )))
84 84  
85 -(% class="box infomessage" id="HCaution:" %)
73 +(% class="box warningmessage" id="HCaution:" %)
86 86  (((
87 -**Note:** ShowRunnerCLC™ has two different approaches for Zūm Wireless Discovery
75 +**Note:** SHOWRUNNER™ has two different approaches for Zūm Wireless Discovery
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.
77 +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.
78 +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.
91 91  )))
92 92  
81 +(% class="row" %)
82 +(((
93 93  == Manual RF Gateway Assignment Instructions ==
94 94  
95 -Use this method if you have multiple ShowRunnerCLC™ instances on the same network or have gateways used by other Crestron systems.
85 +Use this method if you have multiple SHOWRUNNER™ instances on the same network or have gateways used by other Crestron systems.
96 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.
88 +* Type "//sr devmgr ethernet query//" and press enter. This queries the local network for RF Gateways.
89 +* Type "//sr devmgr ethernet show devices//" and press enter. This displays all found Crestron ethernet devices.
90 +* 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.
91 +* Type "//sr discover zum false//" and press enter.
102 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.
93 +* 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.
94 +* Type "//progreset//" and press enter to restart SHOWRUNNER™
95 +* 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.
106 106  * Once completed SHOWRUNNER™ is now ready for full Zūm control
107 107  
108 108  == Claim All RF Gateways Instructions ==
109 109  
110 -Use this method when you have a single ShowRunnerCLC™ instance on a local network with all gateways being used for ShowRunnerCLC™.
100 +Use this method when you have a single SHOWRUNNER™ instance on a local network with all gateways being used for SHOWRUNNER™.
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.
103 +* Type "//sr discover zum true//" and press enter.
114 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
105 +* 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.
106 +* Type "//progreset//" and press enter to restart SHOWRUNNER™
107 +* 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.
108 +* Once completed SHOWRUNNER™ is now ready for full Zūm control
119 119  
120 120  == Examples ==
121 121  
... ... @@ -138,7 +138,7 @@
138 138  MC4>sr ethernet device claim CEN-GWEXER-9E6ADA
139 139  Claimed ethernet device: CEN-GWEXER-9E6ADA
140 140  MC4>Update request from IP-ID-30 in Program 01
141 -MC4>sr discover zummesh false
131 +MC4>sr discover zum false
142 142  Starting Zum Discovery without gateway claiming
143 143  MC4>Performing Discovery on 1 Gateways.
144 144  Evaluating 3 Devices on Gateway 30
... ... @@ -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
164 +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.
... ... @@ -224,7 +224,7 @@
224 224  
225 225  === Claim All Example ===
226 226  
227 -{{{MC4>sr discover zummesh true
217 +{{{MC4>sr discover zum true
228 228  Starting Zum Discovery with gateway claiming
229 229  MC4>Found 1 Gateways to check.
230 230  Claimed Gateway SN: 1720JBH04269 at IP-ID: 30
... ... @@ -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
253 +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.
... ... @@ -311,3 +311,4 @@
311 311  Removed Loads: 0
312 312  Zum Discovery Finished
313 313  }}}
304 +)))