Skip to Content

Changes for page Zūm Discovery

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