Changes for page Zūm Discovery

Last modified by Austin Weygandt on 2025/05/02 20:21

From 4.1 to 3.1 From 34.1 to 33.1

From version 33.1

edited by Mark Kohlmann
on 2024/10/14 21:55

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

Raw
Rendered

Summary

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

Details

Page properties

Title

@@ -1,1 +1,1 @@
--Zūm Discovery
++Zūm Autodiscovery

Parent

@@ -1,1 +1,1 @@
--SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Program Configuration.WebHome
++SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Device Addressing.WebHome

Author

@@ -1,1 +1,1 @@
--XWiki.mark\.kohlmann@chiefintegrations\.com
++XWiki.alexander\.mott@chiefintegrations\.com

Content

@@ -1,14 +9,6 @@
--(% class="box errormessage" %)
--(((
--**IMPORTANT:** When using ShowRunnerCLC™ with a ZUM-HUB4, **do not** discover Zūm Rooms using the Crestron HUB4 Web UI. During discovery, the HUB4 will claim ZUMNET-JBOXs and prevent ShowRunnerCLC™ from auto-discovering or registering the Zūm hardware for itself.
--
--**WARNING:** Cresnet Discovery is non-functional for ZUMNET-JBOXs with certain versions of Crestron Device Database.
--ShowRunnerCLC™ versions v3.019 through v3.041 must be either downgraded to v3.018 or upgraded to v3.042 or newer in order to perform auto-discover functions.
--)))
--
  (% class="box warningmessage" %)
  (((
--This article is about automatically building a ShowRunnerCLC™ configuration using the Zūm Discovery feature of ShowRunnerCLC™. For instructions on configuring Zūm Wired rooms using the Crestron Zūm App, see [[this page>>SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Preparation.Zūm App Overview.WebHome]].
++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]].
  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]].
  )))
@@ -16,146 +16,70 @@
  {{toc/}}
  {{/box}}
--If Zūm Wired or Wireless devices have been configured using Crestron's Zūm App, then it is possible to automatically build a ShowRunnerCLC™ configuration file using the Zūm Discovery feature that is built into ShowRunnerCLC™.
++(% class="row" %)
++(((
++If Zūm Net devices have been configured using Crestron's Zūm App
--There are certain pre-requisites and limitations when building a ShowRunnerCLC™ 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.
++= Zūm Wired =
--= Discovery Filter =
++Lorem
--Discovered ethernet devices may be filtered using either a hostname or IP Address filter.  The filter is configured from the command line interface.
++= Zūm Wireless =
--##+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+
--~| Command                        | Help                                       |
--~|~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-|~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-|
--~| SR discover clear filter       | Remove Discovery Filter                    |
--~| SR discover filter             | Show Discovery Filter                      |
--~| SR discover filter (X:S)       | Set Discovery Filter                       |
--~|  -                             |  (X):S:Filter String                       |
--~|~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-|~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-|##
--=== Hostname Filter ===
++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.
++*Disconnect from the gateway before discovery as they cannot support multiple connections*
++*Plug loads do not appear in the UI*
--Hostname filter uses a regular expression to filter discovered ZUMNET GATEWAYs or JBOXs.  Multiple expressions can be applied by using a comma to separate the expressions.
++== Pre-Requisites: ==
--Command Syntax: ##"Type='Hostname' Settings='Expr1[,Expr2]'"##
--
--Examples:
--
--1. Only include hostnames that start with ZUMNET-06:
--(% style="font-family: Menlo, Monaco, Consolas, Courier New, monospace; white-space: pre" %)sr discover filter "Type='Hostname' Settings='^ZUMNET-06'"
--1. Include hostnames that start with ZUMNET-FL01 or contain FL03:
--(% style="font-family: Menlo, Monaco, Consolas, Courier New, monospace; white-space: pre" %)sr discover filter "Type='Hostname' Settings='^ZUMNET-FL01,FL03'"
--
--= Zūm Wired Discovery =
--
--== Notes and Limitations ==
--
--(% class="box warningmessage" %)
--(((
--* ShowRunnerCLC™ 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)
--* Disconnect from any ZUMNET devices you may be connected to in Toolbox and confirm all hardware (NETs and LINKs) are online 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)
--* ZUMLINK-IOs will not be discovered (Expected to be discoverable in future ShowRunnerCLC™ release)
--* ZUMLINK-KPs will not be discovered on older versions of ShowRunnerCLC™ (v3.058 or newer will discover keypads and set as remote type)
--* One area will be created per ZUMNET-JBOX; if there are more areas than ZUMNET-JBOXs, additional areas must be created manually
++* Zum NETBRIDGES acquired to their respective gateway (CEN-GWEXER/ZUMNET-GATEWAY)
++* ShowRunner installed and running on a 3-series processor on the same network as the gateway
++* NETBRIDGES do not need to have addresses assigned.  ShowRunner will automatically address them.  If devices all already addressed then their addresses will be honored.
  )))
--== Steps ==
--
--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
--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.
--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:
--1*. Connect to the first ZUMNET-JBOX in Toolbox
--1*. Configure a static IP address for the ZUMNET-JBOX if there is no DHCP server on the network
--1**. Note: The ShowRunnerCLC™ built-in DHCP server is not meant to be used in production
--1**. If the ShowRunnerCLC™ built-in DHCP server was used to assign IP addresses to devices, it is still necessary to give those devices static IP addresses
--1*. Set unique Connection IDs for each device hosted on the ZUMNET-JBOX so that their firmware can be updated
--1*. Load the Zūm Wired firmware to the ZUMNET-JBOX
--1*. Repeat the above steps for all ZUMNET-JBOXs
--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
--1. Connect to each ZUMNET-JBOX in the Crestron Zūm App
--1*. Commission room through the app
--1**. configure keypad logic
--1**. configure occupancy sensor settings
--1**. calibrate photocell(s)
--1*. Set hostnames for the ZUMNETs.
--1**. Zūm discovery will bring in hostnames.
--1. Unique Connection IDs should be automatically assigned to any Zūm Link and Cresnet devices on the ZUMNET-JBOX
--1*. If firmware was out-of-date, then this step should have already been completed
--1*. If unique CIDs are not automatically assigned, connect to the JBOX in Toolbox and give the devices unique CIDs
--1. Configure a static IP address for the ZUMNET-JBOX if there is no DHCP server on the network
--1*. If firmware was out-of-date, then this step should have already been completed
--1*. Note: The ShowRunnerCLC™ built-in DHCP server is not meant to be used in production
--1*. If the ShowRunnerCLC™ built-in DHCP server was used to assign IP addresses to devices, it is still necessary to give those devices static IP addresses
--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
--1*. 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 ShowRunnerCLC™ is only possible if all ZUMNET-JBOXs are in CNET mode. Odd behavior may result from conflicts between ShowRunnerCLC™ and internal logic if the ZUMNET-JBOXs are not put into CNET mode
--1. Repeat from step 3 until all ZUMNET-JBOXs that are to be controlled by ShowRunnerCLC™ have static IP addresses and unique CIDs for any hosted devices
--1. Disconnect from any ZUMNET-JBOXs and then connect to the processor in Toolbox
--1. Run the command: ##sr discover zumnet true false##
--1*. This command tells ShowRunnerCLC™ to discover all ZUMMNET-JBOXs on the network, configure their IP tables, and then add corresponding IP Devices to the configuration
--1. Run the command: ##sr discover zumnet true true##
--1*. This command tells ShowRunnerCLC™ 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 **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.
--
--= Zūm Wireless Discovery =
--
--== Notes and Limitations ==
--
--(% class="box warningmessage" %)
++(% class="box warningmessage" id="HCaution:" %)
  (((
--* Processor with ShowRunnerCLC™ version 2.190 or newer must be running on the same network as the gateway(s) to be acquired
--** For ShowRunnerCLC™ versions prior to 3.014 and newer, replace **##sr discover zummesh##** commands with **##sr discover zum##**
--* ZUM-NETBRIDGES must already be acquired to their respective gateway
--* ShowRunnerCLC™ 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
--* Plug loads will not appear in the ShowRunnerCLC™ UI
--* Newer GWEXER firmware enables SSL by default. Follow the instructions at [[SSL User Configuration>>doc:SHOWRUNNER™ User Guide & Wiki.SHOWRUNNER™ Appendix.SSL User Configuration.WebHome]] and manually add the IP Table entries on the GWEXER
++**Note:** SHOWRUNNER™ has two different approaches for Zūm Wireless Autodiscovery
++
++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.
++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.
  )))
--(% class="box infomessage" id="HCaution:" %)
++(% class="row" %)
  (((
--**Note:** ShowRunnerCLC™ has two different approaches for Zūm Wireless Discovery
++== Option 1: Manual RF Gateway Claiming: ==
--1. **Manual RF Gateway Assignment** - ShowRunnerCLC™ 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.
--1. **Claim All RF Gateways** - ShowRunnerCLC™ 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 ShowRunnerCLC™ or other Crestron systems on the same local network.
--)))
++Use this method if you have multiple ShowRunner instances on the same network or have gateways used by other Crestron systems.
--== Manual RF Gateway Assignment Instructions ==
--
--Use this method if you have multiple ShowRunnerCLC™ 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##. ShowRunnerCLC™ will auto-assign an IP-ID. After all gateways have been claimed by ShowRunnerCLC™, proceed to the next step.
--* Type ##sr discover zummesh 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, ShowRunnerCLC™ must be restarted to complete the acquire process.
--* Type ##progreset## and press enter to restart ShowRunnerCLC™
--* Once SHOWRUNNER™ has finished restarting type ##sr discover zummesh false## and press enter. ShowRunnerCLC™ 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
++* 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 zum false//" and press enter.  ShowRunner will be able to acquire the loads attached to the Zum rooms at this point.
++* Once completed ShowRunner is now ready for full Zum control
--== Claim All RF Gateways Instructions ==
++== Option 2: Claim All Gateways: ==
--Use this method when you have a single ShowRunnerCLC™ instance on a local network with all gateways being used for ShowRunnerCLC™.
++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.
--* 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, ShowRunnerCLC™ must be restarted to complete the acquire process.
--* Type ##progreset## and press enter to restart ShowRunnerCLC™
--* Once ShowRunnerCLC™ has finished restarting type ##sr discover zummesh false## and press enter. ShowRunnerCLC™ will be able to acquire the loads attached to the Zūm rooms at this point.
--* Once completed ShowRunnerCLC™ is now ready for full Zūm control
++* 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 zum false//" and press enter.  ShowRunner will be able to acquire the loads attached to the Zum rooms at this point.
++* Once completed ShowRunner is now ready for full Zum control
  == Examples ==
--=== Manual Example ===
++=== Example for Option 1: ===
++
  {{{MC4>sr devmgr ethernet query
  Ethrenet AutoDiscovery Result: AutoDiscoveryOperationSuccess
  MC4>sr devmgr ethernet show devices
@@ -173,7 +173,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
@@ -206,7 +206,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.
@@ -257,9 +257,9 @@
  Removed Loads: 0
  Zum Discovery Finished}}}
--=== Claim All Example ===
++=== Example for Option 2: ===
--{{{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
@@ -295,7 +295,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.
@@ -346,3 +346,4 @@
  Removed Loads: 0
  Zum Discovery Finished
  }}}
++)))