Skip to Content

Changes for page Zūm Discovery

Last modified by Alexander Mott on 2025/04/03 17:35
From version 7.1
edited by Alexander Mott
on 2022/09/22 23:59
Change comment: There is no comment for this version
To version 22.1
edited by Alexander Mott
on 2023/12/08 18:34
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,6 +1,17 @@
1 +(% class="box errormessage" %)
2 +(((
3 +**WARNING:** Cresnet Discovery is non-functional for ZUMNET-JBOXs with certain versions of Crestron Device Database.
4 +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.
5 +)))
6 +
7 +(% class="box errormessage" %)
8 +(((
9 +**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.
10 +)))
11 +
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]].
14 +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,35 +8,36 @@
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™.
22 +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.
24 +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
30 +(% class="box warningmessage" %)
31 +(((
32 +* ShowRunnerCLC™ version 3.014 or newer required
33 +* 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
37 +)))
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
41 +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
46 +1**. Note: The ShowRunnerCLC™ built-in DHCP server is not meant to be used in production
47 +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
39 -1*. Once all the ZUMNET-JBOXs have pushed the new firmware to their hosted devices, proceed to the next step
51 +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
40 40  1. Connect to first ZUMNET-JBOX in the Crestron Zūm App
41 41  1. Unique Connection IDs should be automatically assigned to any Zūm Link and Cresnet devices on the ZUMNET-JBOX
42 42  1*. If firmware was out-of-date, then this step should have already been completed
... ... @@ -43,68 +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
58 +1*. Note: The ShowRunnerCLC™ built-in DHCP server is not meant to be used in production
59 +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
51 -1. Connect to the processor in Toolbox and run the command: ##sr discover zumnet true false##
52 -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
53 -1*. One area will be created per ZUMNET-JBOX
62 +1. Set the ZUMNET-JBOX into either Zūm ("App") mode or CNET mode as required for the program
63 +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
64 +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
65 +1. Disconnect from any ZUMNET-JBOXs and then connect to the processor in Toolbox
66 +1. Run the command: ##sr discover zumnet true false##
67 +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
54 54  1. Run the command: ##sr discover zumnet true true##
55 -1*. This command tells SHOWRUNNER™ to discover all Zūm Link hardware on the previously discovered Zūm Net devices
69 +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
70 +1**. One area will be created per ZUMNET-JBOX, and all hardware attached to that ZUMNET-JBOX will be assigned to that area
56 56  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
57 -1. Put all ZUMNET-JBOXs into CNET mode in order to allow full control from SHOWRUNNER™
58 -1*. Odd behavior may result from conflicts between SHOWRUNNER™ and internal logic if the ZUMNET-JBOXs are not put into CNET mode
72 +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.
59 59  
60 60  = Zūm Wireless Discovery =
61 61  
62 62  == Notes and Limitations ==
63 63  
64 -* Processor with SHOWRUNNER™ version 2.190 or newer must be running on the same network as the gateway(s) to be acquired
65 -** For SHOWRUNNER™ versions 3.014 and newer, replace ##sr discover zum## commands with ##sr discover zummesh##
78 +(% class="box warningmessage" %)
79 +(((
80 +* Processor with ShowRunnerCLC™ version 2.190 or newer must be running on the same network as the gateway(s) to be acquired
81 +** For ShowRunnerCLC™ versions prior to 3.014 and newer, replace **##sr discover zummesh##** commands with **##sr discover zum##**
66 66  * ZUM-NETBRIDGES must already be acquired to their respective gateway
67 -* SHOWRUNNER™ will automatically address any ZUM-NETBRIDGES that do not need have addresses assigned, but will still honor any already addressed devices
83 +* ShowRunnerCLC™ will automatically address any ZUM-NETBRIDGES that do not need have addresses assigned, but will still honor any already addressed devices
68 68  * Disconnect from any RF gateways you may be connected to in Toolbox prior to running the discovery command
69 -* Plug loads will not appear in the SHOWRUNNER™ UI
85 +* Plug loads will not appear in the ShowRunnerCLC™ UI
70 70  )))
71 71  
72 -(% class="box warningmessage" id="HCaution:" %)
88 +(% class="box infomessage" id="HCaution:" %)
73 73  (((
74 -**Note:** SHOWRUNNER™ has two different approaches for Zūm Wireless Discovery
90 +**Note:** ShowRunnerCLC™ has two different approaches for Zūm Wireless Discovery
75 75  
76 -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.
77 -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.
92 +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.
93 +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.
78 78  )))
79 79  
80 -(% class="row" %)
81 -(((
82 82  == Manual RF Gateway Assignment Instructions ==
83 83  
84 -Use this method if you have multiple SHOWRUNNER™ instances on the same network or have gateways used by other Crestron systems.
98 +Use this method if you have multiple ShowRunnerCLC™ instances on the same network or have gateways used by other Crestron systems.
85 85  
86 86  * Connect to the processor's console with Toolbox or your favorite SSH client.
87 -* Type "//sr devmgr ethernet query//" and press enter. This queries the local network for RF Gateways.
88 -* Type "//sr devmgr ethernet show devices//" and press enter. This displays all found Crestron ethernet devices.
89 -* 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.
90 -* Type "//sr discover zum false//" and press enter.
101 +* Type ##sr devmgr ethernet query## and press enter. This queries the local network for RF Gateways.
102 +* Type ##sr devmgr ethernet show devices## and press enter. This displays all found Crestron ethernet devices.
103 +* 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.
104 +* Type ##sr discover zummesh false## and press enter.
91 91  * Status messages and the results will be displayed on the console. The process should take about 3 minutes.
92 -* 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.
93 -* Type "//progreset//" and press enter to restart SHOWRUNNER™
94 -* 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 +* 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.
107 +* Type ##progreset## and press enter to restart ShowRunnerCLC™
108 +* 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.
95 95  * Once completed SHOWRUNNER™ is now ready for full Zūm control
96 96  
97 97  == Claim All RF Gateways Instructions ==
98 98  
99 -Use this method when you have a single SHOWRUNNER™ instance on a local network with all gateways being used for SHOWRUNNER™.
113 +Use this method when you have a single ShowRunnerCLC™ instance on a local network with all gateways being used for ShowRunnerCLC™.
100 100  
101 101  * Connect to the processor's console with Toolbox or your favorite SSH client.
102 -* Type "//sr discover zum true//" and press enter.
116 +* Type ##sr discover zummesh true## and press enter.
103 103  * Status messages and the results will be displayed on the console. The process should take about 3 minutes.
104 -* 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.
105 -* Type "//progreset//" and press enter to restart SHOWRUNNER™
106 -* 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 -* Once completed SHOWRUNNER™ is now ready for full Zūm control
118 +* 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.
119 +* Type ##progreset## and press enter to restart ShowRunnerCLC™
120 +* 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.
121 +* Once completed ShowRunnerCLC™ is now ready for full Zūm control
108 108  
109 109  == Examples ==
110 110  
... ... @@ -127,7 +127,7 @@
127 127  MC4>sr ethernet device claim CEN-GWEXER-9E6ADA
128 128  Claimed ethernet device: CEN-GWEXER-9E6ADA
129 129  MC4>Update request from IP-ID-30 in Program 01
130 -MC4>sr discover zum false
144 +MC4>sr discover zummesh false
131 131  Starting Zum Discovery without gateway claiming
132 132  MC4>Performing Discovery on 1 Gateways.
133 133  Evaluating 3 Devices on Gateway 30
... ... @@ -160,7 +160,7 @@
160 160  MC4>progreset
161 161  ...
162 162  CI ShowRunner startup completed successfully in 8072ms
163 -MC4>sr discover zum false
177 +MC4>sr discover zummesh false
164 164  Starting Zum Discovery without gateway claiming
165 165  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
166 166  Performing Discovery on 1 Gateways.
... ... @@ -213,7 +213,7 @@
213 213  
214 214  === Claim All Example ===
215 215  
216 -{{{MC4>sr discover zum true
230 +{{{MC4>sr discover zummesh true
217 217  Starting Zum Discovery with gateway claiming
218 218  MC4>Found 1 Gateways to check.
219 219  Claimed Gateway SN: 1720JBH04269 at IP-ID: 30
... ... @@ -249,7 +249,7 @@
249 249  MC4>progreset
250 250  ...
251 251  CI ShowRunner startup completed successfully in 8072ms
252 -MC4>sr discover zum false
266 +MC4>sr discover zummesh false
253 253  Starting Zum Discovery without gateway claiming
254 254  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
255 255  Performing Discovery on 1 Gateways.
... ... @@ -300,4 +300,3 @@
300 300  Removed Loads: 0
301 301  Zum Discovery Finished
302 302  }}}
303 -)))