Skip to Content

Changes for page Zūm Discovery

Last modified by Austin Weygandt on 2025/05/02 20:21
From version 16.2
edited by Alexander Mott
on 2023/03/29 21:28
Change comment: There is no comment for this version
To version 4.1
edited by Alexander Mott
on 2022/09/22 21:50
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
Content
... ... @@ -1,11 +6,6 @@
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. Discovery must be fixed before SHOWRUNNER™ can auto-discover hardware.
4 -)))
5 -
6 6  (% class="box warningmessage" %)
7 7  (((
8 -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]].
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]].
9 9  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]].
10 10  )))
11 11  
... ... @@ -13,111 +13,70 @@
13 13  {{toc/}}
14 14  {{/box}}
15 15  
16 -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™.
11 +(% class="row" %)
12 +(((
13 +If Zūm Net devices have been configured using Crestron's Zūm App
17 17  
18 -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.
15 += Zūm Wired =
19 19  
20 -= Zūm Wired Discovery =
17 +Lorem
21 21  
22 -== Notes and Limitations ==
19 += Zūm Wireless =
23 23  
24 -(% class="box warningmessage" %)
25 -(((
26 -* SHOWRUNNER™ version 3.014 or newer required
27 -* Zūm Wired firmware .puf version 1.02.10 or greater required (ZUMNET-JBOX installed minimum version 1.001.00081)
28 -* Disconnect from any ZUMNET devices you may be connected to in Toolbox prior to running the discovery commands
29 -* Cresnet devices landed on Zūm Link will not be discovered (Crestron bug expected to be corrected in a future firmware release)
30 -* One area will be created per ZUMNET-JBOX; if there are more areas than ZUMNET-JBOXs, additional areas must be created manually
31 -)))
32 32  
33 -== Steps ==
22 +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.
23 +*Disconnect from the gateway before discovery as they cannot support multiple connections*
24 +*Plug loads do not appear in the UI*
34 34  
35 -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
36 -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.
37 -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: 
38 -1*. Connect to the first ZUMNET-JBOX in Toolbox
39 -1*. Configure a static IP address for the ZUMNET-JBOX if there is no DHCP server on the network 
40 -1**. Note: The SHOWRUNNER™ built-in DHCP server is not meant to be used in production
41 -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
42 -1*. Set unique Connection IDs for each device hosted on the ZUMNET-JBOX so that their firmware can be updated
43 -1*. Load the Zūm Wired firmware to the ZUMNET-JBOX
44 -1*. Repeat the above steps for all ZUMNET-JBOXs
45 -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
46 -1. Connect to first ZUMNET-JBOX in the Crestron Zūm App
47 -1. Unique Connection IDs should be automatically assigned to any Zūm Link and Cresnet devices on the ZUMNET-JBOX
48 -1*. If firmware was out-of-date, then this step should have already been completed
49 -1*. If unique CIDs are not automatically assigned, connect to the JBOX in Toolbox and give the devices unique CIDs
50 -1. Configure a static IP address for the ZUMNET-JBOX if there is no DHCP server on the network 
51 -1*. If firmware was out-of-date, then this step should have already been completed
52 -1*. Note: The SHOWRUNNER™ built-in DHCP server is not meant to be used in production
53 -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
54 -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
55 -1*. If you do not manually configure the IP table, then SHOWRUNNER™ will automatically configure the IP-ID for each ZUMNET-JBOX during discovery
56 -1. Set the ZUMNET-JBOX into either Zūm ("App") mode or CNET mode as required for the program
57 -1*. Full control from SHOWRUNNER™ is only possible if all ZUMNET-JBOXs are in CNET mode. Odd behavior may result from conflicts between SHOWRUNNER™ and internal logic if the ZUMNET-JBOXs are not put into CNET mode
58 -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
59 -1. Disconnect from any ZUMNET-JBOXs and then connect to the processor in Toolbox
60 -1. Run the command: ##sr discover zumnet true false##
61 -1*. This command tells SHOWRUNNER™ to discover all ZUMMNET-JBOXs on the network, configure their IP tables, and then add corresponding IP Devices to the configuration
62 -1. Run the command: ##sr discover zumnet true true##
63 -1*. This command tells SHOWRUNNER™ 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
64 -1**. One area will be created per ZUMNET-JBOX, and all hardware attached to that ZUMNET-JBOX will be assigned to that area
65 -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
66 -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.
26 +== Pre-Requisites: ==
67 67  
68 -= Zūm Wireless Discovery =
69 -
70 -== Notes and Limitations ==
71 -
72 -(% class="box warningmessage" %)
73 -(((
74 -* Processor with SHOWRUNNER™ version 2.190 or newer must be running on the same network as the gateway(s) to be acquired
75 -** For SHOWRUNNER™ versions prior to 3.014 and newer, replace **##sr discover zummesh##** commands with **##sr discover zum##**
76 -* ZUM-NETBRIDGES must already be acquired to their respective gateway
77 -* SHOWRUNNER™ will automatically address any ZUM-NETBRIDGES that do not need have addresses assigned, but will still honor any already addressed devices
78 -* Disconnect from any RF gateways you may be connected to in Toolbox prior to running the discovery command
79 -* Plug loads will not appear in the SHOWRUNNER™ UI
28 +* Zum NETBRIDGES acquired to their respective gateway (CEN-GWEXER/ZUMNET-GATEWAY)
29 +* ShowRunner installed and running on a 3-series processor on the same network as the gateway
30 +* NETBRIDGES do not need to have addresses assigned. ShowRunner will automatically address them. If devices all already addressed then their addresses will be honored.
80 80  )))
81 81  
82 -(% class="box infomessage" id="HCaution:" %)
33 +(% class="box warningmessage" id="HCaution:" %)
83 83  (((
84 -**Note:** SHOWRUNNER™ has two different approaches for Zūm Wireless Discovery
35 +**Note:** SHOWRUNNER™ has two different approaches for Zūm Wireless Autodiscovery
85 85  
86 86  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.
87 87  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.
88 88  )))
89 89  
90 -== Manual RF Gateway Assignment Instructions ==
41 +(% class="row" %)
42 +(((
43 +== Option 1: Manual RF Gateway Claiming: ==
91 91  
92 -Use this method if you have multiple SHOWRUNNER™ instances on the same network or have gateways used by other Crestron systems.
45 +Use this method if you have multiple ShowRunner instances on the same network or have gateways used by other Crestron systems.
93 93  
94 94  * Connect to the processor's console with Toolbox or your favorite SSH client.
95 -* Type ##sr devmgr ethernet query## and press enter. This queries the local network for RF Gateways.
96 -* Type ##sr devmgr ethernet show devices## and press enter. This displays all found Crestron ethernet devices.
97 -* 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.
98 -* Type ##sr discover zummesh false## and press enter.
99 -* Status messages and the results will be displayed on the console. The process should take about 3 minutes.
100 -* 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.
101 -* Type ##progreset## and press enter to restart SHOWRUNNER™
102 -* Once SHOWRUNNER™ has finished restarting type ##sr discover zummesh false## and press enter. SHOWRUNNER™ will be able to acquire the loads attached to the Zūm rooms at this point.
103 -* Once completed SHOWRUNNER™ is now ready for full Zūm control
48 +* Type "//sr devmgr ethernet query//" and press enter. This queries the local network for RF Gateways.
49 +* Type "//sr devmgr ethernet show devices//" and press enter. This displays all found Crestron ethernet devices.
50 +* 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.
51 +* Type "//sr discover zum false//" and press enter.
52 +* Status messages and the results will be displayed on the console. The process should take about 3 minutes.
53 +* 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.
54 +* Type "//progreset//" and press enter to restart ShowRunner
55 +* Once ShowRunner has finished restarting type "//sr discover zum false//" and press enter. ShowRunner will be able to acquire the loads attached to the Zum rooms at this point.
56 +* Once completed ShowRunner is now ready for full Zum control
104 104  
105 -== Claim All RF Gateways Instructions ==
58 +== Option 2: Claim All Gateways: ==
106 106  
107 -Use this method when you have a single SHOWRUNNER™ instance on a local network with all gateways being used for SHOWRUNNER™.
60 +Use this method when you have a single ShowRunner instance on a local network with all gateways being used for ShowRunner.
108 108  
109 109  * Connect to the processor's console with Toolbox or your favorite SSH client.
110 -* Type ##sr discover zummesh true## and press enter.
111 -* Status messages and the results will be displayed on the console. The process should take about 3 minutes.
112 -* 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.
113 -* Type ##progreset## and press enter to restart SHOWRUNNER™
114 -* Once SHOWRUNNER™ has finished restarting type ##sr discover zummesh false## and press enter. SHOWRUNNER™ will be able to acquire the loads attached to the Zūm rooms at this point.
115 -* Once completed SHOWRUNNER™ is now ready for full Zūm control
63 +* Type "//sr discover zum true//" and press enter.
64 +* Status messages and the results will be displayed on the console. The process should take about 3 minutes.
65 +* 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.
66 +* Type "//progreset//" and press enter to restart ShowRunner
67 +* Once ShowRunner has finished restarting type "//sr discover zum false//" and press enter. ShowRunner will be able to acquire the loads attached to the Zum rooms at this point.
68 +* Once completed ShowRunner is now ready for full Zum control
116 116  
117 117  == Examples ==
118 118  
119 -=== Manual Example ===
120 120  
73 +=== Example for Option 1: ===
74 +
121 121  {{{MC4>sr devmgr ethernet query
122 122  Ethrenet AutoDiscovery Result: AutoDiscoveryOperationSuccess
123 123  MC4>sr devmgr ethernet show devices
... ... @@ -135,7 +135,7 @@
135 135  MC4>sr ethernet device claim CEN-GWEXER-9E6ADA
136 136  Claimed ethernet device: CEN-GWEXER-9E6ADA
137 137  MC4>Update request from IP-ID-30 in Program 01
138 -MC4>sr discover zummesh false
92 +MC4>sr discover zum false
139 139  Starting Zum Discovery without gateway claiming
140 140  MC4>Performing Discovery on 1 Gateways.
141 141  Evaluating 3 Devices on Gateway 30
... ... @@ -168,7 +168,7 @@
168 168  MC4>progreset
169 169  ...
170 170  CI ShowRunner startup completed successfully in 8072ms
171 -MC4>sr discover zummesh false
125 +MC4>sr discover zum false
172 172  Starting Zum Discovery without gateway claiming
173 173  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
174 174  Performing Discovery on 1 Gateways.
... ... @@ -219,9 +219,9 @@
219 219  Removed Loads: 0
220 220  Zum Discovery Finished}}}
221 221  
222 -=== Claim All Example ===
176 +=== Example for Option 2: ===
223 223  
224 -{{{MC4>sr discover zummesh true
178 +{{{MC4>sr discover zum true
225 225  Starting Zum Discovery with gateway claiming
226 226  MC4>Found 1 Gateways to check.
227 227  Claimed Gateway SN: 1720JBH04269 at IP-ID: 30
... ... @@ -257,7 +257,7 @@
257 257  MC4>progreset
258 258  ...
259 259  CI ShowRunner startup completed successfully in 8072ms
260 -MC4>sr discover zummesh false
214 +MC4>sr discover zum false
261 261  Starting Zum Discovery without gateway claiming
262 262  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
263 263  Performing Discovery on 1 Gateways.
... ... @@ -308,3 +308,4 @@
308 308  Removed Loads: 0
309 309  Zum Discovery Finished
310 310  }}}
265 +)))