Changes for page Zūm Discovery
Last modified by Austin Weygandt on 2025/05/02 20:21
From version 6.1
edited by Alexander Mott
on 2022/09/22 23:12
on 2022/09/22 23:12
Change comment:
There is no comment for this version
To version 9.1
edited by Alexander Mott
on 2022/10/05 16:17
on 2022/10/05 16:17
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -18,15 +18,58 @@ 18 18 19 19 == Notes and Limitations == 20 20 21 +(% class="box errormessage" %) 22 +((( 21 21 * SHOWRUNNER™ version 3.014 or newer required 22 -* Zūm Wired firmware version 23 -* Disconnect from any ZUMNET devices you may be connected to in Toolbox prior to running the discovery command 24 +* Zūm Wired firmware version 1.02.10 or greater required 25 +* Disconnect from any ZUMNET devices you may be connected to in Toolbox prior to running the discovery commands 26 +* Cresnet devices landed on Zūm Link will not be discovered (Crestron bug expected to be corrected in a future firmware release) 27 +* One area will be created per ZUMNET-JBOX; if there are more areas than ZUMNET-JBOXs, additional areas must be created manually 28 +))) 24 24 30 +== Steps == 31 + 32 +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 33 +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. 34 +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: 35 +1*. Connect to the first ZUMNET-JBOX in Toolbox 36 +1*. Configure a static IP address for the ZUMNET-JBOX if there is no DHCP server on the network 37 +1**. Note: The SHOWRUNNER™ built-in DHCP server is not meant to be used in production 38 +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 39 +1*. Set unique Connection IDs for each device hosted on the ZUMNET-JBOX so that their firmware can be updated 40 +1*. Load the Zūm Wired firmware to the ZUMNET-JBOX 41 +1*. Repeat the above steps for all ZUMNET-JBOXs 42 +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 43 +1. Connect to first ZUMNET-JBOX in the Crestron Zūm App 44 +1. Unique Connection IDs should be automatically assigned to any Zūm Link and Cresnet devices on the ZUMNET-JBOX 45 +1*. If firmware was out-of-date, then this step should have already been completed 46 +1*. If unique CIDs are not automatically assigned, connect to the JBOX in Toolbox and give the devices unique CIDs 47 +1. Configure a static IP address for the ZUMNET-JBOX if there is no DHCP server on the network 48 +1*. If firmware was out-of-date, then this step should have already been completed 49 +1*. Note: The SHOWRUNNER™ built-in DHCP server is not meant to be used in production 50 +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 51 +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 52 +1*. If you do not manually configure the IP table, then SHOWRUNNER™ will automatically configure the IP-ID for each ZUMNET-JBOX during discovery 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 areas and loads to the configuration 57 +1*. One area will be created per ZUMNET-JBOX 58 +1. Run the command: ##sr discover zumnet true true## 59 +1*. This command tells SHOWRUNNER™ to discover all Zūm Link hardware on the previously discovered Zūm Net devices 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. Put all ZUMNET-JBOXs into CNET mode in order to allow full control from SHOWRUNNER™ 62 +1*. Odd behavior may result from conflicts between SHOWRUNNER™ and internal logic if the ZUMNET-JBOXs are not put into CNET mode 63 + 25 25 = Zūm Wireless Discovery = 26 26 27 27 == Notes and Limitations == 67 +))) 28 28 69 +(% class="box errormessage" %) 70 +((( 29 29 * Processor with SHOWRUNNER™ version 2.190 or newer must be running on the same network as the gateway(s) to be acquired 72 +** For SHOWRUNNER™ versions prior to 3.014 and newer, replace **##sr discover zummesh##** commands with **##sr discover zum##** 30 30 * ZUM-NETBRIDGES must already be acquired to their respective gateway 31 31 * SHOWRUNNER™ will automatically address any ZUM-NETBRIDGES that do not need have addresses assigned, but will still honor any already addressed devices 32 32 * Disconnect from any RF gateways you may be connected to in Toolbox prior to running the discovery command ... ... @@ -43,31 +43,31 @@ 43 43 44 44 (% class="row" %) 45 45 ((( 46 -== Manual RF Gateway Assignment == 89 +== Manual RF Gateway Assignment Instructions == 47 47 48 48 Use this method if you have multiple SHOWRUNNER™ instances on the same network or have gateways used by other Crestron systems. 49 49 50 50 * Connect to the processor's console with Toolbox or your favorite SSH client. 51 -* Type "//sr devmgr ethernet query//"and press enter. This queries the local network for RF Gateways.52 -* Type "//sr devmgr ethernet show devices//"and press enter. This displays all found Crestron ethernet devices.53 -* 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.54 -* Type "//sr discover zum false//"and press enter.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. 55 55 * Status messages and the results will be displayed on the console. The process should take about 3 minutes. 56 -* 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.57 -* Type "//progreset//"and press enter to restart SHOWRUNNER™58 -* 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.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. 59 59 * Once completed SHOWRUNNER™ is now ready for full Zūm control 60 60 61 -== Claim All RF Gateways == 104 +== Claim All RF Gateways Instructions == 62 62 63 63 Use this method when you have a single SHOWRUNNER™ instance on a local network with all gateways being used for SHOWRUNNER™. 64 64 65 65 * Connect to the processor's console with Toolbox or your favorite SSH client. 66 -* Type "//sr discover zum true//"and press enter.109 +* Type ##sr discover zummesh true## and press enter. 67 67 * Status messages and the results will be displayed on the console. The process should take about 3 minutes. 68 -* 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.69 -* Type "//progreset//"and press enter to restart SHOWRUNNER™70 -* 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.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. 71 71 * Once completed SHOWRUNNER™ is now ready for full Zūm control 72 72 73 73 == Examples == ... ... @@ -91,7 +91,7 @@ 91 91 MC4>sr ethernet device claim CEN-GWEXER-9E6ADA 92 92 Claimed ethernet device: CEN-GWEXER-9E6ADA 93 93 MC4>Update request from IP-ID-30 in Program 01 94 -MC4>sr discover zum false 137 +MC4>sr discover zummesh false 95 95 Starting Zum Discovery without gateway claiming 96 96 MC4>Performing Discovery on 1 Gateways. 97 97 Evaluating 3 Devices on Gateway 30 ... ... @@ -124,7 +124,7 @@ 124 124 MC4>progreset 125 125 ... 126 126 CI ShowRunner startup completed successfully in 8072ms 127 -MC4>sr discover zum false 170 +MC4>sr discover zummesh false 128 128 Starting Zum Discovery without gateway claiming 129 129 MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable) 130 130 Performing Discovery on 1 Gateways. ... ... @@ -177,7 +177,7 @@ 177 177 178 178 === Claim All Example === 179 179 180 -{{{MC4>sr discover zum true 223 +{{{MC4>sr discover zummesh true 181 181 Starting Zum Discovery with gateway claiming 182 182 MC4>Found 1 Gateways to check. 183 183 Claimed Gateway SN: 1720JBH04269 at IP-ID: 30 ... ... @@ -213,7 +213,7 @@ 213 213 MC4>progreset 214 214 ... 215 215 CI ShowRunner startup completed successfully in 8072ms 216 -MC4>sr discover zum false 259 +MC4>sr discover zummesh false 217 217 Starting Zum Discovery without gateway claiming 218 218 MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable) 219 219 Performing Discovery on 1 Gateways.