Skip to Content

Changes for page Zūm Discovery

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