Zūm Discovery
Version 11.1 by Alexander Mott on 2022/10/05 16:19
CONTENTS
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.
Zūm Wired Discovery
Notes and Limitations
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 SHOWRUNNER™ built-in DHCP server is not meant to be used in production
- 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
- 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 first ZUMNET-JBOX in the Crestron Zūm App
- 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 SHOWRUNNER™ built-in DHCP server is not meant to be used in production
- 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
- 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
- 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
- One area will be created per ZUMNET-JBOX
- Run the command: sr discover zumnet true true
- 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
- Put all ZUMNET-JBOXs into CNET mode in order to allow full control from SHOWRUNNER™
- 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
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.
- 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.
- 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 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, 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.
- 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 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