Skip to Content

Changes for page Zūm Discovery

Last modified by Austin Weygandt on 2025/05/02 20:21
From version 24.3
edited by Craig Lewis
on 2024/05/22 21:47
Change comment: There is no comment for this version
To version 5.1
edited by Alexander Mott
on 2022/09/22 21:55
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
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.craig\.lewis@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 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,116 +16,67 @@
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™.
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.
22 -
23 -= Zūm Wired Discovery =
24 -
25 -== Notes and Limitations ==
26 -
27 -(% class="box warningmessage" %)
11 +(% class="row" %)
28 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)
31 -* Disconnect from any ZUMNET devices you may be connected to in Toolbox prior to running the discovery commands
32 -* Cresnet devices landed on Zūm Link will not be discovered (Crestron bug expected to be corrected in a future firmware release)
33 -* One area will be created per ZUMNET-JBOX; if there are more areas than ZUMNET-JBOXs, additional areas must be created manually
34 -)))
13 +If Zūm Net devices have been configured using Crestron's Zūm App
35 35  
36 -== Steps ==
15 += Zūm Wired =
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
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 -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 -1*. Connect to the first ZUMNET-JBOX in Toolbox
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
45 -1*. Set unique Connection IDs for each device hosted on the ZUMNET-JBOX so that their firmware can be updated
46 -1*. Load the Zūm Wired firmware to the ZUMNET-JBOX
47 -1*. Repeat the above steps for all ZUMNET-JBOXs
48 -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
49 -1. Connect to each ZUMNET-JBOX in the Crestron Zūm App
50 -1*. Commission room through the app
51 -1**. configure keypad logic
52 -1**. configure occupancy sensor settings
53 -1**. calibrate photocell(s)
54 -1*. Set hostnames for the ZUMNETs.
55 -1**. Zūm discovery will bring in hostnames.
56 -1. Unique Connection IDs should be automatically assigned to any Zūm Link and Cresnet devices on the ZUMNET-JBOX
57 -1*. If firmware was out-of-date, then this step should have already been completed
58 -1*. If unique CIDs are not automatically assigned, connect to the JBOX in Toolbox and give the devices unique CIDs
59 -1. Configure a static IP address for the ZUMNET-JBOX if there is no DHCP server on the network 
60 -1*. If firmware was out-of-date, then this step should have already been completed
61 -1*. Note: The ShowRunnerCLC™ built-in DHCP server is not meant to be used in production
62 -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
63 -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
64 -1*. If you do not manually configure the IP table, then SHOWRUNNER™ will automatically configure the IP-ID for each ZUMNET-JBOX during discovery
65 -1. Set the ZUMNET-JBOX into either Zūm ("App") mode or CNET mode as required for the program
66 -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
67 -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
68 -1. Disconnect from any ZUMNET-JBOXs and then connect to the processor in Toolbox
69 -1. Run the command: ##sr discover zumnet true false##
70 -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
71 -1. Run the command: ##sr discover zumnet true true##
72 -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
73 -1**. One area will be created per ZUMNET-JBOX, and all hardware attached to that ZUMNET-JBOX will be assigned to that area
74 -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
75 -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.
17 +Lorem
76 76  
77 -= Zūm Wireless Discovery =
19 += Zūm Wireless =
78 78  
79 -== Notes and Limitations ==
21 +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.
22 +*Disconnect from the gateway before discovery as they cannot support multiple connections*
23 +*Plug loads do not appear in the UI*
80 80  
81 -(% class="box warningmessage" %)
82 -(((
83 -* Processor with ShowRunnerCLC™ version 2.190 or newer must be running on the same network as the gateway(s) to be acquired
84 -** For ShowRunnerCLC™ versions prior to 3.014 and newer, replace **##sr discover zummesh##** commands with **##sr discover zum##**
85 -* ZUM-NETBRIDGES must already be acquired to their respective gateway
86 -* ShowRunnerCLC™ will automatically address any ZUM-NETBRIDGES that do not need have addresses assigned, but will still honor any already addressed devices
87 -* Disconnect from any RF gateways you may be connected to in Toolbox prior to running the discovery command
88 -* Plug loads will not appear in the ShowRunnerCLC™ UI
25 +== Pre-Requisites: ==
26 +
27 +* Zum NETBRIDGES acquired to their respective gateway (CEN-GWEXER/ZUMNET-GATEWAY)
28 +* SHOWRUNNER™ installed and running on a 3-series processor on the same network as the gateway
29 +* NETBRIDGES do not need to have addresses assigned. SHOWRUNNER™ will automatically address them. If devices all already addressed then their addresses will be honored.
89 89  )))
90 90  
91 -(% class="box infomessage" id="HCaution:" %)
32 +(% class="box warningmessage" id="HCaution:" %)
92 92  (((
93 -**Note:** ShowRunnerCLC™ has two different approaches for Zūm Wireless Discovery
34 +**Note:** SHOWRUNNER™ has two different approaches for Zūm Wireless Autodiscovery
94 94  
95 -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.
96 -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.
36 +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.
37 +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.
97 97  )))
98 98  
99 -== Manual RF Gateway Assignment Instructions ==
40 +(% class="row" %)
41 +(((
42 +== Manual RF Gateway Claiming ==
100 100  
101 -Use this method if you have multiple ShowRunnerCLC™ instances on the same network or have gateways used by other Crestron systems.
44 +Use this method if you have multiple SHOWRUNNER™ instances on the same network or have gateways used by other Crestron systems.
102 102  
103 103  * Connect to the processor's console with Toolbox or your favorite SSH client.
104 -* Type ##sr devmgr ethernet query## and press enter. This queries the local network for RF Gateways.
105 -* Type ##sr devmgr ethernet show devices## and press enter. This displays all found Crestron ethernet devices.
106 -* 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.
107 -* Type ##sr discover zummesh false## and press enter.
47 +* Type "//sr devmgr ethernet query//" and press enter. This queries the local network for RF Gateways.
48 +* Type "//sr devmgr ethernet show devices//" and press enter. This displays all found Crestron ethernet devices.
49 +* 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.
50 +* Type "//sr discover zum false//" and press enter.
108 108  * Status messages and the results will be displayed on the console. The process should take about 3 minutes.
109 -* 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.
110 -* Type ##progreset## and press enter to restart ShowRunnerCLC™
111 -* 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.
52 +* 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.
53 +* Type "//progreset//" and press enter to restart SHOWRUNNER™
54 +* 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.
112 112  * Once completed SHOWRUNNER™ is now ready for full Zūm control
113 113  
114 -== Claim All RF Gateways Instructions ==
57 +== Claim All RF Gateways ==
115 115  
116 -Use this method when you have a single ShowRunnerCLC™ instance on a local network with all gateways being used for ShowRunnerCLC™.
59 +Use this method when you have a single SHOWRUNNER™ instance on a local network with all gateways being used for SHOWRUNNER™.
117 117  
118 118  * Connect to the processor's console with Toolbox or your favorite SSH client.
119 -* Type ##sr discover zummesh true## and press enter.
62 +* Type "//sr discover zum true//" and press enter.
120 120  * Status messages and the results will be displayed on the console. The process should take about 3 minutes.
121 -* 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.
122 -* Type ##progreset## and press enter to restart ShowRunnerCLC™
123 -* 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.
124 -* Once completed ShowRunnerCLC™ is now ready for full Zūm control
64 +* 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.
65 +* Type "//progreset//" and press enter to restart SHOWRUNNER™
66 +* 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.
67 +* Once completed SHOWRUNNER™ is now ready for full Zūm control
125 125  
126 126  == Examples ==
127 127  
128 -=== Manual Example ===
71 +=== Claim Selectively (Manual) Example ===
129 129  
130 130  {{{MC4>sr devmgr ethernet query
131 131  Ethrenet AutoDiscovery Result: AutoDiscoveryOperationSuccess
... ... @@ -144,7 +144,7 @@
144 144  MC4>sr ethernet device claim CEN-GWEXER-9E6ADA
145 145  Claimed ethernet device: CEN-GWEXER-9E6ADA
146 146  MC4>Update request from IP-ID-30 in Program 01
147 -MC4>sr discover zummesh false
90 +MC4>sr discover zum false
148 148  Starting Zum Discovery without gateway claiming
149 149  MC4>Performing Discovery on 1 Gateways.
150 150  Evaluating 3 Devices on Gateway 30
... ... @@ -177,7 +177,7 @@
177 177  MC4>progreset
178 178  ...
179 179  CI ShowRunner startup completed successfully in 8072ms
180 -MC4>sr discover zummesh false
123 +MC4>sr discover zum false
181 181  Starting Zum Discovery without gateway claiming
182 182  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
183 183  Performing Discovery on 1 Gateways.
... ... @@ -230,7 +230,7 @@
230 230  
231 231  === Claim All Example ===
232 232  
233 -{{{MC4>sr discover zummesh true
176 +{{{MC4>sr discover zum true
234 234  Starting Zum Discovery with gateway claiming
235 235  MC4>Found 1 Gateways to check.
236 236  Claimed Gateway SN: 1720JBH04269 at IP-ID: 30
... ... @@ -266,7 +266,7 @@
266 266  MC4>progreset
267 267  ...
268 268  CI ShowRunner startup completed successfully in 8072ms
269 -MC4>sr discover zummesh false
212 +MC4>sr discover zum false
270 270  Starting Zum Discovery without gateway claiming
271 271  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
272 272  Performing Discovery on 1 Gateways.
... ... @@ -317,3 +317,4 @@
317 317  Removed Loads: 0
318 318  Zum Discovery Finished
319 319  }}}
263 +)))