Changes for page Zūm Discovery

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

From 1.2 to 1.1 From 6.4 to 6.3

From version 6.3

edited by Alexander Mott
on 2022/09/22 23:37

Change comment: (Autosaved)

To version 1.2

edited by Alexander Mott
on 2022/09/22 21:31

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Title

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

Content

@@ -1,6 +1,6 @@
  (% 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]].
++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]].
  )))
@@ -10,265 +10,29 @@
  (% 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™.
++Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
--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.
++= Para 1 =
--= Zūm Wired Discovery =
++Lorem
--== Notes and Limitations ==
++== Sub 1 ==
--* SHOWRUNNER™ version 3.014 or newer required
--* 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
++Lorem
--== Steps ==
++== Sub 2 ==
--1.
++Lorem
--= Zūm Wireless Discovery =
++= Para 2 =
--== Notes and Limitations ==
++Lorem
--* 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 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
--* Plug loads will not appear in the SHOWRUNNER™ UI
--)))
++== Sub 1 ==
--(% class="box warningmessage" id="HCaution:" %)
--(((
--**Note:** SHOWRUNNER™ has two different approaches for Zūm Wireless Discovery
++Lorem
--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.
--)))
++== Sub 2 ==
--(% 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 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 Zūm rooms at this point.
--* Once completed SHOWRUNNER™ is now ready for full Zūm control
--
--== Claim All RF Gateways Instructions ==
--
--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 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 Zūm rooms at this point.
--* Once completed SHOWRUNNER™ is now ready for full Zūm control
--
--== Examples ==
--
--=== Manual Example ===
--
--{{{MC4>sr devmgr ethernet query
--Ethrenet AutoDiscovery Result: AutoDiscoveryOperationSuccess
--MC4>sr devmgr ethernet show devices
--
--+--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
--| Adapter | Hostname | IP Address | IP-ID | ID |
--+--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
--| EthernetLANAdapter | CI-SJC-CEN-CI3-1-COM3 | 10.44.5.20 | 00 | CEN-CI3-1-C3COM-3 [v1.1620.00000, #008436E2] type:1 |
--+--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
--| EthernetLANAdapter | SB-DIN-CENCN-2 | 10.44.5.81 | 00 | DIN-CENCN-2-POE [v1.3544.00006, #8AB25AA3] |
--+--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
--| EthernetLANAdapter | CEN-GWEXER-9E6ADA | 10.44.5.120 | 00 | CEN-GWEXER [v1.4230.00015, #848210AD] |
--+--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+
--
--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 zum false
--Starting Zum Discovery without gateway claiming
--MC4>Performing Discovery on 1 Gateways.
--Evaluating 3 Devices on Gateway 30
--Claiming ZUM-NETBRIDGE SN: 1726NEJ01096 from IP-ID: 30
--Dev: ZUM-NETBRIDGE addrssing to RF ID: 03
--Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 03
--Claiming ZUM-NETBRIDGE SN: 1914NEJ03096 from IP-ID: 30
--Dev: ZUM-NETBRIDGE addrssing to RF ID: 04
--Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 04
--Claiming ZUM-NETBRIDGE SN: 1914NEJ03098 from IP-ID: 30
--Dev: ZUM-NETBRIDGE addrssing to RF ID: 05
--Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 05
--Querying cresnet
--Discovering Zum Loads on 1 Gateways.
--Discovering Zum Loads on 3 Devices.
--NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0
--Device: ZUM Netbridge 30:03 at 30:03 discovery result: .
--NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0
--Device: ZUM Netbridge 30:04 at 30:04 discovery result: .
--NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0
--Device: ZUM Netbridge 30:05 at 30:05 discovery result: .
--RF Gateways: 0
--RF Devices: 3
--New Loads: 0
--Modified Loads: 0
--Removed Loads: 0
--Zum Discovery Finished
--MC4>sr save
--Saved config
--MC4>progreset
--...
--CI ShowRunner startup completed successfully in 8072ms
--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.
--Evaluating 3 Devices on Gateway 30
--Claiming ZUM-NETBRIDGE SN: 1726NEJ01096 from IP-ID: 30
--Dev: ZUMMESH-NETBRIDGE already claimed at RF ID: 03
--Claiming ZUM-NETBRIDGE SN: 1914NEJ03096 from IP-ID: 30
--Dev: ZUMMESH-NETBRIDGE already claimed at RF ID: 04
--Claiming ZUM-NETBRIDGE SN: 1914NEJ03098 from IP-ID: 30
--Dev: ZUMMESH-NETBRIDGE already claimed at RF ID: 05
--Discovering Zum Loads on 1 Gateways.
--Discovering Zum Loads on 3 Devices.
--Evaluating Device: ZUM-BLE ShortAddress: FFFA Type: BLERadio
--Evaluating Device: ZUM-JBOX-20A-PLUG ShortAddress: 0000 Type: PlugLoad
--Evaluating Device: ZUM-KP10C-BATT ShortAddress: 52E5 Type: Keypad
--Evaluating Device: ZUM-PIR-OCC-BATT ShortAddress: DAF1 Type: OccupancySensor
--Evaluating Device: ZUM-JBOX-5A-LV ShortAddress: 92EF Type: DimmableLoad
--Load: Load37615 Added
--NETBIRDGE: NewLoads: 1 ModifiedLoads: 0 RemovedLoads: 0
--Device: ZUM Netbridge 30:03 at 30:03 discovery result: .
--Evaluating Device: ZUM-BLE ShortAddress: FFFA Type: BLERadio
--Evaluating Device: ZUM-DALI ShortAddress: 740D Type: Unknown
--Evaluating Device: ZUM-5A-LV ShortAddress: 0482 Type: DimmableLoad
--Load: Load1154 Added
--Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: 0000 Type: DimmableLoad
--Load: Load0 Added
--Evaluating Device: ZUM-KP10C-BATT ShortAddress: D766 Type: Keypad
--Evaluating Device: ZUM-OL-PHO-BATT ShortAddress: 95ED Type: Photocell
--Evaluating Device: ZUM-PIR-OCC-BATT ShortAddress: 44C2 Type: OccupancySensor
--Evaluating Device: ZUM-DALI-GROUP ShortAddress: 740D Type: Unknown
--Evaluating Device: ZUM-DALI-GROUP ShortAddress: 740D Type: Unknown
--NETBIRDGE: NewLoads: 2 ModifiedLoads: 0 RemovedLoads: 0
--Device: ZUM Netbridge 30:04 at 30:04 discovery result: .
--Evaluating Device: ZUM-BLE ShortAddress: FFFA Type: BLERadio
--Evaluating Device: ZUM-SIM ShortAddress: 0000 Type: OccupancySensor, PartitionSensor
--Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: EBCF Type: DimmableLoad
--Load: Load60367 Added
--Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: 3CC1 Type: DimmableLoad
--Load: Load15553 Added
--Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: F94A Type: DimmableLoad
--Load: Load63818 Added
--NETBIRDGE: NewLoads: 3 ModifiedLoads: 0 RemovedLoads: 0
--Device: ZUM Netbridge 30:05 at 30:05 discovery result: .
--RF Gateways: 0
--RF Devices: 3
--New Loads: 6
--Modified Loads: 0
--Removed Loads: 0
--Zum Discovery Finished}}}
--
--=== Claim All Example ===
--
--{{{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
--Update request from IP-ID-30 in Program 01
--Claimed 1 Gateways. Waiting for queries to finish.
--Performing Discovery on 1 Gateways.
--Evaluating 3 Devices on Gateway 30
--Claiming ZUM-NETBRIDGE SN: 1726NEJ01096 from IP-ID: 30
--Dev: ZUM-NETBRIDGE addrssing to RF ID: 03
--Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 03
--Claiming ZUM-NETBRIDGE SN: 1914NEJ03096 from IP-ID: 30
--Dev: ZUM-NETBRIDGE addrssing to RF ID: 04
--Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 04
--Claiming ZUM-NETBRIDGE SN: 1914NEJ03098 from IP-ID: 30
--Dev: ZUM-NETBRIDGE addrssing to RF ID: 05
--Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 05
--Discovering Zum Loads on 1 Gateways.
--Discovering Zum Loads on 3 Devices.
--NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0
--Device: ZUM Netbridge 30:03 at 30:03 discovery result: .
--NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0
--Device: ZUM Netbridge 30:04 at 30:04 discovery result: .
--NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0
--Device: ZUM Netbridge 30:05 at 30:05 discovery result: .
--RF Gateways: 0
--RF Devices: 3
--New Loads: 0
--Modified Loads: 0
--Removed Loads: 0
--Zum Discovery Finished
--MC4>sr save
--Saved config
--MC4>progreset
--...
--CI ShowRunner startup completed successfully in 8072ms
--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.
--Evaluating 3 Devices on Gateway 30
--Claiming ZUM-NETBRIDGE SN: 1726NEJ01096 from IP-ID: 30
--Dev: ZUMMESH-NETBRIDGE already claimed at RF ID: 03
--Claiming ZUM-NETBRIDGE SN: 1914NEJ03096 from IP-ID: 30
--Dev: ZUMMESH-NETBRIDGE already claimed at RF ID: 04
--Claiming ZUM-NETBRIDGE SN: 1914NEJ03098 from IP-ID: 30
--Dev: ZUMMESH-NETBRIDGE already claimed at RF ID: 05
--Discovering Zum Loads on 1 Gateways.
--Discovering Zum Loads on 3 Devices.
--Evaluating Device: ZUM-BLE ShortAddress: FFFA Type: BLERadio
--Evaluating Device: ZUM-JBOX-20A-PLUG ShortAddress: 0000 Type: PlugLoad
--Evaluating Device: ZUM-KP10C-BATT ShortAddress: 52E5 Type: Keypad
--Evaluating Device: ZUM-PIR-OCC-BATT ShortAddress: DAF1 Type: OccupancySensor
--Evaluating Device: ZUM-JBOX-5A-LV ShortAddress: 92EF Type: DimmableLoad
--Load: Load37615 Added
--NETBIRDGE: NewLoads: 1 ModifiedLoads: 0 RemovedLoads: 0
--Device: ZUM Netbridge 30:03 at 30:03 discovery result: .
--Evaluating Device: ZUM-BLE ShortAddress: FFFA Type: BLERadio
--Evaluating Device: ZUM-DALI ShortAddress: 740D Type: Unknown
--Evaluating Device: ZUM-5A-LV ShortAddress: 0482 Type: DimmableLoad
--Load: Load1154 Added
--Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: 0000 Type: DimmableLoad
--Load: Load0 Added
--Evaluating Device: ZUM-KP10C-BATT ShortAddress: D766 Type: Keypad
--Evaluating Device: ZUM-OL-PHO-BATT ShortAddress: 95ED Type: Photocell
--Evaluating Device: ZUM-PIR-OCC-BATT ShortAddress: 44C2 Type: OccupancySensor
--Evaluating Device: ZUM-DALI-GROUP ShortAddress: 740D Type: Unknown
--Evaluating Device: ZUM-DALI-GROUP ShortAddress: 740D Type: Unknown
--NETBIRDGE: NewLoads: 2 ModifiedLoads: 0 RemovedLoads: 0
--Device: ZUM Netbridge 30:04 at 30:04 discovery result: .
--Evaluating Device: ZUM-BLE ShortAddress: FFFA Type: BLERadio
--Evaluating Device: ZUM-SIM ShortAddress: 0000 Type: OccupancySensor, PartitionSensor
--Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: EBCF Type: DimmableLoad
--Load: Load60367 Added
--Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: 3CC1 Type: DimmableLoad
--Load: Load15553 Added
--Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: F94A Type: DimmableLoad
--Load: Load63818 Added
--NETBIRDGE: NewLoads: 3 ModifiedLoads: 0 RemovedLoads: 0
--Device: ZUM Netbridge 30:05 at 30:05 discovery result: .
--RF Gateways: 0
--RF Devices: 3
--New Loads: 6
--Modified Loads: 0
--Removed Loads: 0
--Zum Discovery Finished
--}}}
++Lorem
  )))