Zūm Discovery

Last modified by Alexander Mott on 2024/10/16 18:07

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.

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

CONTENTS

Discovery Filter (ShowRunnerCLC™ 3.062 or newer)
- - Hostname Filter
  - IP Address Filter
Zūm Wired Discovery
- Notes and Limitations
- Steps
Zūm Wireless Discovery

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

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.

Discovery Filter (ShowRunnerCLC™ 3.062 or newer)

Discovered ethernet devices may be filtered using either a hostname or IP Address filter. The filter is configured from the command line interface.

+--------------------------------+--------------------------------------------+
| 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

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

Command Syntax: "Type='Hostname' Settings='Expr1[,Expr2]'"

Examples:

Only include hostnames that start with ZUMNET-06:
sr discover filter "Type='Hostname' Settings='^ZUMNET-06'"
Include hostnames that start with ZUMNET-FL01 or contain FL03:
sr discover filter "Type='Hostname' Settings='^ZUMNET-FL01,FL03'"

IP Address Filter

The IP Address filter will restrict discovered ZUMNET GATEWAYs or JBOXs to matching IP Addresses or IP Address ranges. Multiple addresses and ranges can be used.

Command Syntax: "Type='IPAddress' Settings='Address[,AddressStart-AddressEnd]'"

Examples:

Only include a device with an address of 192.168.0.10 or 192.168.0.50:
sr discover filter "Type='IPAddress' Settings='192.168.0.10,192.168.0.50'"
Include addresses between 192.168.0.11 and 192.168.0.50 and 192.168.0.200 and 192.168.0.240:
sr discover filter "Type='IPAddress' Settings='192.168.0.11-192.168.0.50,192.168.0.200-192.168.0.240'"

Zūm Wired Discovery

Notes and Limitations

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

Steps

Install ShowRunner™ on the processor and configure the processor as necessary
- 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.
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:
- Connect to the first ZUMNET-JBOX in Toolbox
- Configure a static IP address for the ZUMNET-JBOX if there is no DHCP server on the network
  - Note: The ShowRunnerCLC™ built-in DHCP server is not meant to be used in production
  - 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
- Set unique Connection IDs for each device hosted on the ZUMNET-JBOX so that their firmware can be updated
- Load the Zūm Wired firmware to the ZUMNET-JBOX
- Repeat the above steps for all ZUMNET-JBOXs
- 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
Connect to each ZUMNET-JBOX in the Crestron Zūm App
- Commission room through the app
  - configure keypad logic
  - configure occupancy sensor settings
  - calibrate photocell(s)
- Set hostnames for the ZUMNETs.
  - Zūm discovery will bring in hostnames.
Unique Connection IDs should be automatically assigned to any Zūm Link and Cresnet devices on the ZUMNET-JBOX
- If firmware was out-of-date, then this step should have already been completed
- If unique CIDs are not automatically assigned, connect to the JBOX in Toolbox and give the devices unique CIDs
Configure a static IP address for the ZUMNET-JBOX if there is no DHCP server on the network
- If firmware was out-of-date, then this step should have already been completed
- Note: The ShowRunnerCLC™ built-in DHCP server is not meant to be used in production
- 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
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
Set the ZUMNET-JBOX into either Zūm ("App") mode or CNET mode as required for the program
- 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
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
Disconnect from any ZUMNET-JBOXs and then connect to the processor in Toolbox
If trying to Auto Discover on a job with multiple processors or you are returning to a job where new ZUMNET-JBOXs have been added and you only wish to Auto Discover those new devices, ShowRunnerCLC™ 3.062 and newer allow filtering based on hostname or IP address in order to limit the devices that are brought into the ShowRunnerCLC™ configuration
Run the command: sr discover zumnet true true
- This command tells ShowRunnerCLC™ to both claim all 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
  - One area will be created per ZUMNET-JBOX, and all hardware attached to that ZUMNET-JBOX will be assigned to that area
- 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
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.
If new Zūm Link hardware has been added, it is not necessary to do a full Auto Discovery to bring the new devices into ShowRunnerCLC™; instead you can just run sr discover zumnet false true to bring in the new Zūm Link devices without claiming any new Zūm Net devices

Zūm Wireless Discovery

Notes and Limitations

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 and manually add the IP Table entries on the GWEXER

Note: ShowRunnerCLC™ has two different approaches for Zūm Wireless Discovery

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

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

Claim All RF Gateways Instructions

Use this method when you have a single ShowRunnerCLC™ instance on a local network with all gateways being used for ShowRunnerCLC™.

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

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 zummesh 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 zummesh 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 zummesh 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 zummesh 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