Changes for page Zūm Discovery

Last modified by Alexander Mott on 2025/04/03 17:35

From 8.1 to 7.1 From 19.1 to 18.1

From version 18.1

edited by Alexander Mott
on 2023/04/20 18:39

Change comment: There is no comment for this version

To version 8.1

edited by Alexander Mott
on 2022/09/23 00:00

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -1,10 +8,3 @@
--(% class="box errormessage" %)
--(((
--WARNING: Cresnet Discovery is not currently working on ZUMNET-JBOXs. Crestron has acknowledged a fix has been sent to QE.
--
--Downgrade SHOWRUNNER™ to v3.018 in order to auto-discover hardware. SHOWRUNNER™ can be subsequently upgraded once discovery is complete.
--)))
--
  (% class="box warningmessage" %)
  (((
  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]].
@@ -15,6 +15,8 @@
  {{toc/}}
  {{/box}}
++(% class="row" %)
++(((
  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™.
  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.
@@ -23,14 +23,11 @@
  == Notes and Limitations ==
--(% class="box warningmessage" %)
--(((
  * SHOWRUNNER™ version 3.014 or newer required
--* Zūm Wired firmware .puf version 1.02.10 or greater required (ZUMNET-JBOX installed minimum version 1.001.00081)
++* Zūm Wired firmware version 1.02.10 or greater required
  * Disconnect from any ZUMNET devices you may be connected to in Toolbox prior to running the discovery commands
  * Cresnet devices landed on Zūm Link will not be discovered (Crestron bug expected to be corrected in a future firmware release)
  * One area will be created per ZUMNET-JBOX; if there are more areas than ZUMNET-JBOXs, additional areas must be created manually
--)))
  == Steps ==
@@ -55,26 +55,23 @@
 *. 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
 . 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
 *. If you do not manually configure the IP table, then SHOWRUNNER™ will automatically configure the IP-ID for each ZUMNET-JBOX during discovery
--1. Set the ZUMNET-JBOX into either Zūm ("App") mode or CNET mode as required for the program
--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
 . 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
 . Disconnect from any ZUMNET-JBOXs and then connect to the processor in Toolbox
 . Run the command: ##sr discover zumnet true false##
--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
++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
++1*. One area will be created per ZUMNET-JBOX
 . Run the command: ##sr discover zumnet true true##
--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
--1**. One area will be created per ZUMNET-JBOX, and all hardware attached to that ZUMNET-JBOX will be assigned to that area
++1*. This command tells SHOWRUNNER™ to discover all Zūm Link hardware on the previously discovered Zūm Net devices
 *. 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
--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.
++1. Put all ZUMNET-JBOXs into CNET mode in order to allow full control from SHOWRUNNER™
++1*. Odd behavior may result from conflicts between SHOWRUNNER™ and internal logic if the ZUMNET-JBOXs are not put into CNET mode
  = Zūm Wireless Discovery =
  == Notes and Limitations ==
--(% class="box warningmessage" %)
--(((
  * Processor with SHOWRUNNER™ version 2.190 or newer must be running on the same network as the gateway(s) to be acquired
--** For SHOWRUNNER™ versions prior to 3.014 and newer, replace **##sr discover zummesh##** commands with **##sr discover zum##**
++** For SHOWRUNNER™ versions 3.014 and newer, replace ##sr discover zum## commands with ##sr discover zummesh##
  * ZUM-NETBRIDGES must already be acquired to their respective gateway
  * SHOWRUNNER™ will automatically address any ZUM-NETBRIDGES that do not need have addresses assigned, but will still honor any already addressed devices
  * Disconnect from any RF gateways you may be connected to in Toolbox prior to running the discovery command
@@ -81,7 +81,7 @@
  * Plug loads will not appear in the SHOWRUNNER™ UI
  )))
--(% class="box infomessage" id="HCaution:" %)
++(% class="box warningmessage" id="HCaution:" %)
  (((
  **Note:** SHOWRUNNER™ has two different approaches for Zūm Wireless Discovery
@@ -89,19 +89,21 @@
 . **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.
  )))
++(% class="row" %)
++(((
  == Manual RF Gateway Assignment Instructions ==
  Use this method if you have multiple SHOWRUNNER™ instances on the same network or have gateways used by other Crestron systems.
  * Connect to the processor's console with Toolbox or your favorite SSH client.
--* Type ##sr devmgr ethernet query## and press enter.  This queries the local network for RF Gateways.
--* Type ##sr devmgr ethernet show devices## and press enter.  This displays all found Crestron ethernet devices.
--* 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.
--* Type ##sr discover zummesh false## and press enter.
++* Type "//sr devmgr ethernet query//" and press enter.  This queries the local network for RF Gateways.
++* Type "//sr devmgr ethernet show devices//" and press enter.  This displays all found Crestron ethernet devices.
++* 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.
++* Type "//sr discover zum false//" and press enter.
  * Status messages and the results will be displayed on the console. The process should take about 3 minutes.
--* 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.
--* Type ##progreset## and press enter to restart SHOWRUNNER™
--* 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.
++* 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.
++* Type "//progreset//" and press enter to restart SHOWRUNNER™
++* 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.
  * Once completed SHOWRUNNER™ is now ready for full Zūm control
  == Claim All RF Gateways Instructions ==
@@ -109,11 +109,11 @@
  Use this method when you have a single SHOWRUNNER™ instance on a local network with all gateways being used for SHOWRUNNER™.
  * Connect to the processor's console with Toolbox or your favorite SSH client.
--* Type ##sr discover zummesh true## and press enter.
++* Type "//sr discover zum true//" and press enter.
  * Status messages and the results will be displayed on the console. The process should take about 3 minutes.
--* 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.
--* Type ##progreset## and press enter to restart SHOWRUNNER™
--* 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.
++* 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.
++* Type "//progreset//" and press enter to restart SHOWRUNNER™
++* 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.
  * Once completed SHOWRUNNER™ is now ready for full Zūm control
  == Examples ==
@@ -137,7 +137,7 @@
  MC4>sr ethernet device claim CEN-GWEXER-9E6ADA
  Claimed ethernet device: CEN-GWEXER-9E6ADA
  MC4>Update request from IP-ID-30 in Program 01
--MC4>sr discover zummesh false
++MC4>sr discover zum false
  Starting Zum Discovery without gateway claiming
  MC4>Performing Discovery on 1 Gateways.
  Evaluating 3 Devices on Gateway 30
@@ -170,7 +170,7 @@
  MC4>progreset
  ...
  CI ShowRunner startup completed successfully in 8072ms
--MC4>sr discover zummesh false
++MC4>sr discover zum false
  Starting Zum Discovery without gateway claiming
  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
  Performing Discovery on 1 Gateways.
@@ -223,7 +223,7 @@
  === Claim All Example ===
--{{{MC4>sr discover zummesh true
++{{{MC4>sr discover zum true
  Starting Zum Discovery with gateway claiming
  MC4>Found 1 Gateways to check.
  Claimed Gateway SN: 1720JBH04269 at IP-ID: 30
@@ -259,7 +259,7 @@
  MC4>progreset
  ...
  CI ShowRunner startup completed successfully in 8072ms
--MC4>sr discover zummesh false
++MC4>sr discover zum false
  Starting Zum Discovery without gateway claiming
  MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable)
  Performing Discovery on 1 Gateways.
@@ -310,3 +310,4 @@
  Removed Loads: 0
  Zum Discovery Finished
  }}}
++)))