Skip to Content

Changes for page Zūm Discovery

Last modified by Alexander Mott on 2025/04/03 17:35
From version 8.1
edited by Alexander Mott
on 2022/09/23 00:00
Change comment: There is no comment for this version
To version 21.1
edited by Alexander Mott
on 2023/10/11 16:37
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,6 +1,18 @@
1 +(% class="box errormessage" %)
2 +(((
3 +WARNING: Cresnet Discovery is not currently working on ZUMNET-JBOXs. Crestron has acknowledged a fix has been sent to QE.
4 +
5 +Downgrade ShowRunnerCLC™ to v3.018 in order to auto-discover hardware. ShowRunnerCLC™ can be subsequently upgraded once discovery is complete.
6 +)))
7 +
8 +(% class="box errormessage" %)
9 +(((
10 +**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.
11 +)))
12 +
1 1  (% class="box warningmessage" %)
2 2  (((
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]].
15 +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]].
4 4  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]].
5 5  )))
6 6  
... ... @@ -8,31 +8,32 @@
8 8  {{toc/}}
9 9  {{/box}}
10 10  
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™.
23 +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™.
14 14  
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.
25 +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.
16 16  
17 17  = Zūm Wired Discovery =
18 18  
19 19  == Notes and Limitations ==
20 20  
21 -* SHOWRUNNER™ version 3.014 or newer required
22 -* Zūm Wired firmware version 1.02.10 or greater required
31 +(% class="box warningmessage" %)
32 +(((
33 +* ShowRunnerCLC™ version 3.014 or newer required
34 +* Zūm Wired firmware .puf version 1.02.10 or greater required (ZUMNET-JBOX installed minimum version 1.001.00081)
23 23  * Disconnect from any ZUMNET devices you may be connected to in Toolbox prior to running the discovery commands
24 24  * Cresnet devices landed on Zūm Link will not be discovered (Crestron bug expected to be corrected in a future firmware release)
25 25  * One area will be created per ZUMNET-JBOX; if there are more areas than ZUMNET-JBOXs, additional areas must be created manually
38 +)))
26 26  
27 27  == Steps ==
28 28  
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
42 +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
30 30  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.
31 31  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: 
32 32  1*. Connect to the first ZUMNET-JBOX in Toolbox
33 33  1*. Configure a static IP address for the ZUMNET-JBOX if there is no DHCP server on the network 
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
47 +1**. Note: The ShowRunnerCLC™ built-in DHCP server is not meant to be used in production
48 +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
36 36  1*. Set unique Connection IDs for each device hosted on the ZUMNET-JBOX so that their firmware can be updated
37 37  1*. Load the Zūm Wired firmware to the ZUMNET-JBOX
38 38  1*. Repeat the above steps for all ZUMNET-JBOXs
... ... @@ -43,69 +43,70 @@
43 43  1*. If unique CIDs are not automatically assigned, connect to the JBOX in Toolbox and give the devices unique CIDs
44 44  1. Configure a static IP address for the ZUMNET-JBOX if there is no DHCP server on the network 
45 45  1*. If firmware was out-of-date, then this step should have already been completed
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
59 +1*. Note: The ShowRunnerCLC™ built-in DHCP server is not meant to be used in production
60 +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 48  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
49 49  1*. If you do not manually configure the IP table, then SHOWRUNNER™ will automatically configure the IP-ID for each ZUMNET-JBOX during discovery
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
63 +1. Set the ZUMNET-JBOX into either Zūm ("App") mode or CNET mode as required for the program
64 +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
65 +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
51 51  1. Disconnect from any ZUMNET-JBOXs and then connect to the processor in Toolbox
52 52  1. Run the command: ##sr discover zumnet true false##
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
68 +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
55 55  1. Run the command: ##sr discover zumnet true true##
56 -1*. This command tells SHOWRUNNER™ to discover all Zūm Link hardware on the previously discovered Zūm Net devices
70 +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
71 +1**. One area will be created per ZUMNET-JBOX, and all hardware attached to that ZUMNET-JBOX will be assigned to that area
57 57  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
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
73 +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.
60 60  
61 61  = Zūm Wireless Discovery =
62 62  
63 63  == Notes and Limitations ==
64 64  
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 +(% class="box warningmessage" %)
80 +(((
81 +* Processor with ShowRunnerCLC™ version 2.190 or newer must be running on the same network as the gateway(s) to be acquired
82 +** For ShowRunnerCLC™ versions prior to 3.014 and newer, replace **##sr discover zummesh##** commands with **##sr discover zum##**
67 67  * ZUM-NETBRIDGES must already be acquired to their respective gateway
68 -* SHOWRUNNER™ will automatically address any ZUM-NETBRIDGES that do not need have addresses assigned, but will still honor any already addressed devices
84 +* ShowRunnerCLC™ will automatically address any ZUM-NETBRIDGES that do not need have addresses assigned, but will still honor any already addressed devices
69 69  * Disconnect from any RF gateways you may be connected to in Toolbox prior to running the discovery command
70 -* Plug loads will not appear in the SHOWRUNNER™ UI
86 +* Plug loads will not appear in the ShowRunnerCLC™ UI
71 71  )))
72 72  
73 -(% class="box warningmessage" id="HCaution:" %)
89 +(% class="box infomessage" id="HCaution:" %)
74 74  (((
75 -**Note:** SHOWRUNNER™ has two different approaches for Zūm Wireless Discovery
91 +**Note:** ShowRunnerCLC™ has two different approaches for Zūm Wireless Discovery
76 76  
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.
93 +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.
94 +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.
79 79  )))
80 80  
81 -(% class="row" %)
82 -(((
83 83  == Manual RF Gateway Assignment Instructions ==
84 84  
85 -Use this method if you have multiple SHOWRUNNER™ instances on the same network or have gateways used by other Crestron systems.
99 +Use this method if you have multiple ShowRunnerCLC™ instances on the same network or have gateways used by other Crestron systems.
86 86  
87 87  * Connect to the processor's console with Toolbox or your favorite SSH client.
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 +* Type ##sr devmgr ethernet query## and press enter. This queries the local network for RF Gateways.
103 +* Type ##sr devmgr ethernet show devices## and press enter. This displays all found Crestron ethernet devices.
104 +* 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.
105 +* Type ##sr discover zummesh false## and press enter.
92 92  * Status messages and the results will be displayed on the console. The process should take about 3 minutes.
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.
107 +* 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.
108 +* Type ##progreset## and press enter to restart ShowRunnerCLC™
109 +* 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.
96 96  * Once completed SHOWRUNNER™ is now ready for full Zūm control
97 97  
98 98  == Claim All RF Gateways Instructions ==
99 99  
100 -Use this method when you have a single SHOWRUNNER™ instance on a local network with all gateways being used for SHOWRUNNER™.
114 +Use this method when you have a single ShowRunnerCLC™ instance on a local network with all gateways being used for ShowRunnerCLC™.
101 101  
102 102  * Connect to the processor's console with Toolbox or your favorite SSH client.
103 -* Type "//sr discover zum true//" and press enter.
117 +* Type ##sr discover zummesh true## and press enter.
104 104  * Status messages and the results will be displayed on the console. The process should take about 3 minutes.
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 +* 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.
120 +* Type ##progreset## and press enter to restart ShowRunnerCLC™
121 +* 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.
122 +* Once completed ShowRunnerCLC™ is now ready for full Zūm control
109 109  
110 110  == Examples ==
111 111  
... ... @@ -128,7 +128,7 @@
128 128  MC4>sr ethernet device claim CEN-GWEXER-9E6ADA
129 129  Claimed ethernet device: CEN-GWEXER-9E6ADA
130 130  MC4>Update request from IP-ID-30 in Program 01
131 -MC4>sr discover zum false
145 +MC4>sr discover zummesh false
132 132  Starting Zum Discovery without gateway claiming
133 133  MC4>Performing Discovery on 1 Gateways.
134 134  Evaluating 3 Devices on Gateway 30
... ... @@ -161,7 +161,7 @@
161 161  MC4>progreset
162 162  ...
163 163  CI ShowRunner startup completed successfully in 8072ms
164 -MC4>sr discover zum false
178 +MC4>sr discover zummesh false
165 165  Starting Zum Discovery without gateway claiming
166 166  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
167 167  Performing Discovery on 1 Gateways.
... ... @@ -214,7 +214,7 @@
214 214  
215 215  === Claim All Example ===
216 216  
217 -{{{MC4>sr discover zum true
231 +{{{MC4>sr discover zummesh true
218 218  Starting Zum Discovery with gateway claiming
219 219  MC4>Found 1 Gateways to check.
220 220  Claimed Gateway SN: 1720JBH04269 at IP-ID: 30
... ... @@ -250,7 +250,7 @@
250 250  MC4>progreset
251 251  ...
252 252  CI ShowRunner startup completed successfully in 8072ms
253 -MC4>sr discover zum false
267 +MC4>sr discover zummesh false
254 254  Starting Zum Discovery without gateway claiming
255 255  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
256 256  Performing Discovery on 1 Gateways.
... ... @@ -301,4 +301,3 @@
301 301  Removed Loads: 0
302 302  Zum Discovery Finished
303 303  }}}
304 -)))