Skip to Content

Zūm Autodiscovery

Version 4.1 by Alexander Mott on 2022/09/22 21:50

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.
For instructions on configuring Zūm Net devices using Crestron Toolbox, see this page.

CONTENTS

If Zūm Net devices have been configured using Crestron's Zūm App

Zūm Wired

Lorem

Zūm Wireless

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*

Pre-Requisites:

  • 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.

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.
  2. 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.

Option 1: Manual RF Gateway Claiming:

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 Zum rooms at this point.
  • Once completed ShowRunner is now ready for full Zum control

Option 2: Claim All Gateways:

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 Zum rooms at this point.
  • Once completed ShowRunner is now ready for full Zum control

Examples

Example for Option 1:

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

Example for Option 2:

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