Wiki source code of Zūm Discovery
Version 6.1 by Alexander Mott on 2022/09/22 23:12
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | (% class="box warningmessage" %) | ||
| 2 | ((( | ||
| 3 | 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]]. | ||
| 4 | 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]]. | ||
| 5 | ))) | ||
| 6 | |||
| 7 | {{box cssClass="floatinginfobox" title="**CONTENTS**"}} | ||
| 8 | {{toc/}} | ||
| 9 | {{/box}} | ||
| 10 | |||
| 11 | (% class="row" %) | ||
| 12 | ((( | ||
| 13 | 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™. | ||
| 14 | |||
| 15 | 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. | ||
| 16 | |||
| 17 | = Zūm Wired Discovery = | ||
| 18 | |||
| 19 | == Notes and Limitations == | ||
| 20 | |||
| 21 | * SHOWRUNNER™ version 3.014 or newer required | ||
| 22 | * Zūm Wired firmware version | ||
| 23 | * Disconnect from any ZUMNET devices you may be connected to in Toolbox prior to running the discovery command | ||
| 24 | |||
| 25 | = Zūm Wireless Discovery = | ||
| 26 | |||
| 27 | == Notes and Limitations == | ||
| 28 | |||
| 29 | * Processor with SHOWRUNNER™ version 2.190 or newer must be running on the same network as the gateway(s) to be acquired | ||
| 30 | * ZUM-NETBRIDGES must already be acquired to their respective gateway | ||
| 31 | * SHOWRUNNER™ will automatically address any ZUM-NETBRIDGES that do not need have addresses assigned, but will still honor any already addressed devices | ||
| 32 | * Disconnect from any RF gateways you may be connected to in Toolbox prior to running the discovery command | ||
| 33 | * Plug loads will not appear in the SHOWRUNNER™ UI | ||
| 34 | ))) | ||
| 35 | |||
| 36 | (% class="box warningmessage" id="HCaution:" %) | ||
| 37 | ((( | ||
| 38 | **Note:** SHOWRUNNER™ has two different approaches for Zūm Wireless Discovery | ||
| 39 | |||
| 40 | 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. | ||
| 41 | 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. | ||
| 42 | ))) | ||
| 43 | |||
| 44 | (% class="row" %) | ||
| 45 | ((( | ||
| 46 | == Manual RF Gateway Assignment == | ||
| 47 | |||
| 48 | Use this method if you have multiple SHOWRUNNER™ instances on the same network or have gateways used by other Crestron systems. | ||
| 49 | |||
| 50 | * Connect to the processor's console with Toolbox or your favorite SSH client. | ||
| 51 | * Type "//sr devmgr ethernet query//" and press enter. This queries the local network for RF Gateways. | ||
| 52 | * Type "//sr devmgr ethernet show devices//" and press enter. This displays all found Crestron ethernet devices. | ||
| 53 | * 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. | ||
| 54 | * Type "//sr discover zum false//" and press enter. | ||
| 55 | * Status messages and the results will be displayed on the console. The process should take about 3 minutes. | ||
| 56 | * 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. | ||
| 57 | * Type "//progreset//" and press enter to restart SHOWRUNNER™ | ||
| 58 | * 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. | ||
| 59 | * Once completed SHOWRUNNER™ is now ready for full Zūm control | ||
| 60 | |||
| 61 | == Claim All RF Gateways == | ||
| 62 | |||
| 63 | Use this method when you have a single SHOWRUNNER™ instance on a local network with all gateways being used for SHOWRUNNER™. | ||
| 64 | |||
| 65 | * Connect to the processor's console with Toolbox or your favorite SSH client. | ||
| 66 | * Type "//sr discover zum true//" and press enter. | ||
| 67 | * Status messages and the results will be displayed on the console. The process should take about 3 minutes. | ||
| 68 | * 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. | ||
| 69 | * Type "//progreset//" and press enter to restart SHOWRUNNER™ | ||
| 70 | * 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. | ||
| 71 | * Once completed SHOWRUNNER™ is now ready for full Zūm control | ||
| 72 | |||
| 73 | == Examples == | ||
| 74 | |||
| 75 | === Manual Example === | ||
| 76 | |||
| 77 | {{{MC4>sr devmgr ethernet query | ||
| 78 | Ethrenet AutoDiscovery Result: AutoDiscoveryOperationSuccess | ||
| 79 | MC4>sr devmgr ethernet show devices | ||
| 80 | |||
| 81 | +--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+ | ||
| 82 | | Adapter | Hostname | IP Address | IP-ID | ID | | ||
| 83 | +--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+ | ||
| 84 | | EthernetLANAdapter | CI-SJC-CEN-CI3-1-COM3 | 10.44.5.20 | 00 | CEN-CI3-1-C3COM-3 [v1.1620.00000, #008436E2] type:1 | | ||
| 85 | +--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+ | ||
| 86 | | EthernetLANAdapter | SB-DIN-CENCN-2 | 10.44.5.81 | 00 | DIN-CENCN-2-POE [v1.3544.00006, #8AB25AA3] | | ||
| 87 | +--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+ | ||
| 88 | | EthernetLANAdapter | CEN-GWEXER-9E6ADA | 10.44.5.120 | 00 | CEN-GWEXER [v1.4230.00015, #848210AD] | | ||
| 89 | +--------------------+-------------------------------+-------------+-------+----------------------------------------------------------------------------------+ | ||
| 90 | |||
| 91 | MC4>sr ethernet device claim CEN-GWEXER-9E6ADA | ||
| 92 | Claimed ethernet device: CEN-GWEXER-9E6ADA | ||
| 93 | MC4>Update request from IP-ID-30 in Program 01 | ||
| 94 | MC4>sr discover zum false | ||
| 95 | Starting Zum Discovery without gateway claiming | ||
| 96 | MC4>Performing Discovery on 1 Gateways. | ||
| 97 | Evaluating 3 Devices on Gateway 30 | ||
| 98 | Claiming ZUM-NETBRIDGE SN: 1726NEJ01096 from IP-ID: 30 | ||
| 99 | Dev: ZUM-NETBRIDGE addrssing to RF ID: 03 | ||
| 100 | Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 03 | ||
| 101 | Claiming ZUM-NETBRIDGE SN: 1914NEJ03096 from IP-ID: 30 | ||
| 102 | Dev: ZUM-NETBRIDGE addrssing to RF ID: 04 | ||
| 103 | Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 04 | ||
| 104 | Claiming ZUM-NETBRIDGE SN: 1914NEJ03098 from IP-ID: 30 | ||
| 105 | Dev: ZUM-NETBRIDGE addrssing to RF ID: 05 | ||
| 106 | Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 05 | ||
| 107 | Querying cresnet | ||
| 108 | Discovering Zum Loads on 1 Gateways. | ||
| 109 | Discovering Zum Loads on 3 Devices. | ||
| 110 | NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0 | ||
| 111 | Device: ZUM Netbridge 30:03 at 30:03 discovery result: . | ||
| 112 | NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0 | ||
| 113 | Device: ZUM Netbridge 30:04 at 30:04 discovery result: . | ||
| 114 | NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0 | ||
| 115 | Device: ZUM Netbridge 30:05 at 30:05 discovery result: . | ||
| 116 | RF Gateways: 0 | ||
| 117 | RF Devices: 3 | ||
| 118 | New Loads: 0 | ||
| 119 | Modified Loads: 0 | ||
| 120 | Removed Loads: 0 | ||
| 121 | Zum Discovery Finished | ||
| 122 | MC4>sr save | ||
| 123 | Saved config | ||
| 124 | MC4>progreset | ||
| 125 | ... | ||
| 126 | CI ShowRunner startup completed successfully in 8072ms | ||
| 127 | MC4>sr discover zum false | ||
| 128 | Starting Zum Discovery without gateway claiming | ||
| 129 | MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable) | ||
| 130 | Performing Discovery on 1 Gateways. | ||
| 131 | Evaluating 3 Devices on Gateway 30 | ||
| 132 | Claiming ZUM-NETBRIDGE SN: 1726NEJ01096 from IP-ID: 30 | ||
| 133 | Dev: ZUMMESH-NETBRIDGE already claimed at RF ID: 03 | ||
| 134 | Claiming ZUM-NETBRIDGE SN: 1914NEJ03096 from IP-ID: 30 | ||
| 135 | Dev: ZUMMESH-NETBRIDGE already claimed at RF ID: 04 | ||
| 136 | Claiming ZUM-NETBRIDGE SN: 1914NEJ03098 from IP-ID: 30 | ||
| 137 | Dev: ZUMMESH-NETBRIDGE already claimed at RF ID: 05 | ||
| 138 | Discovering Zum Loads on 1 Gateways. | ||
| 139 | Discovering Zum Loads on 3 Devices. | ||
| 140 | Evaluating Device: ZUM-BLE ShortAddress: FFFA Type: BLERadio | ||
| 141 | Evaluating Device: ZUM-JBOX-20A-PLUG ShortAddress: 0000 Type: PlugLoad | ||
| 142 | Evaluating Device: ZUM-KP10C-BATT ShortAddress: 52E5 Type: Keypad | ||
| 143 | Evaluating Device: ZUM-PIR-OCC-BATT ShortAddress: DAF1 Type: OccupancySensor | ||
| 144 | Evaluating Device: ZUM-JBOX-5A-LV ShortAddress: 92EF Type: DimmableLoad | ||
| 145 | Load: Load37615 Added | ||
| 146 | NETBIRDGE: NewLoads: 1 ModifiedLoads: 0 RemovedLoads: 0 | ||
| 147 | Device: ZUM Netbridge 30:03 at 30:03 discovery result: . | ||
| 148 | Evaluating Device: ZUM-BLE ShortAddress: FFFA Type: BLERadio | ||
| 149 | Evaluating Device: ZUM-DALI ShortAddress: 740D Type: Unknown | ||
| 150 | Evaluating Device: ZUM-5A-LV ShortAddress: 0482 Type: DimmableLoad | ||
| 151 | Load: Load1154 Added | ||
| 152 | Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: 0000 Type: DimmableLoad | ||
| 153 | Load: Load0 Added | ||
| 154 | Evaluating Device: ZUM-KP10C-BATT ShortAddress: D766 Type: Keypad | ||
| 155 | Evaluating Device: ZUM-OL-PHO-BATT ShortAddress: 95ED Type: Photocell | ||
| 156 | Evaluating Device: ZUM-PIR-OCC-BATT ShortAddress: 44C2 Type: OccupancySensor | ||
| 157 | Evaluating Device: ZUM-DALI-GROUP ShortAddress: 740D Type: Unknown | ||
| 158 | Evaluating Device: ZUM-DALI-GROUP ShortAddress: 740D Type: Unknown | ||
| 159 | NETBIRDGE: NewLoads: 2 ModifiedLoads: 0 RemovedLoads: 0 | ||
| 160 | Device: ZUM Netbridge 30:04 at 30:04 discovery result: . | ||
| 161 | Evaluating Device: ZUM-BLE ShortAddress: FFFA Type: BLERadio | ||
| 162 | Evaluating Device: ZUM-SIM ShortAddress: 0000 Type: OccupancySensor, PartitionSensor | ||
| 163 | Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: EBCF Type: DimmableLoad | ||
| 164 | Load: Load60367 Added | ||
| 165 | Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: 3CC1 Type: DimmableLoad | ||
| 166 | Load: Load15553 Added | ||
| 167 | Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: F94A Type: DimmableLoad | ||
| 168 | Load: Load63818 Added | ||
| 169 | NETBIRDGE: NewLoads: 3 ModifiedLoads: 0 RemovedLoads: 0 | ||
| 170 | Device: ZUM Netbridge 30:05 at 30:05 discovery result: . | ||
| 171 | RF Gateways: 0 | ||
| 172 | RF Devices: 3 | ||
| 173 | New Loads: 6 | ||
| 174 | Modified Loads: 0 | ||
| 175 | Removed Loads: 0 | ||
| 176 | Zum Discovery Finished}}} | ||
| 177 | |||
| 178 | === Claim All Example === | ||
| 179 | |||
| 180 | {{{MC4>sr discover zum true | ||
| 181 | Starting Zum Discovery with gateway claiming | ||
| 182 | MC4>Found 1 Gateways to check. | ||
| 183 | Claimed Gateway SN: 1720JBH04269 at IP-ID: 30 | ||
| 184 | Update request from IP-ID-30 in Program 01 | ||
| 185 | Claimed 1 Gateways. Waiting for queries to finish. | ||
| 186 | Performing Discovery on 1 Gateways. | ||
| 187 | Evaluating 3 Devices on Gateway 30 | ||
| 188 | Claiming ZUM-NETBRIDGE SN: 1726NEJ01096 from IP-ID: 30 | ||
| 189 | Dev: ZUM-NETBRIDGE addrssing to RF ID: 03 | ||
| 190 | Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 03 | ||
| 191 | Claiming ZUM-NETBRIDGE SN: 1914NEJ03096 from IP-ID: 30 | ||
| 192 | Dev: ZUM-NETBRIDGE addrssing to RF ID: 04 | ||
| 193 | Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 04 | ||
| 194 | Claiming ZUM-NETBRIDGE SN: 1914NEJ03098 from IP-ID: 30 | ||
| 195 | Dev: ZUM-NETBRIDGE addrssing to RF ID: 05 | ||
| 196 | Setting up RF Device 'ZUM-NETBRIDGE' on Gateway 30 at RF-ID 05 | ||
| 197 | Discovering Zum Loads on 1 Gateways. | ||
| 198 | Discovering Zum Loads on 3 Devices. | ||
| 199 | NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0 | ||
| 200 | Device: ZUM Netbridge 30:03 at 30:03 discovery result: . | ||
| 201 | NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0 | ||
| 202 | Device: ZUM Netbridge 30:04 at 30:04 discovery result: . | ||
| 203 | NETBIRDGE: NewLoads: 0 ModifiedLoads: 0 RemovedLoads: 0 | ||
| 204 | Device: ZUM Netbridge 30:05 at 30:05 discovery result: . | ||
| 205 | RF Gateways: 0 | ||
| 206 | RF Devices: 3 | ||
| 207 | New Loads: 0 | ||
| 208 | Modified Loads: 0 | ||
| 209 | Removed Loads: 0 | ||
| 210 | Zum Discovery Finished | ||
| 211 | MC4>sr save | ||
| 212 | Saved config | ||
| 213 | MC4>progreset | ||
| 214 | ... | ||
| 215 | CI ShowRunner startup completed successfully in 8072ms | ||
| 216 | MC4>sr discover zum false | ||
| 217 | Starting Zum Discovery without gateway claiming | ||
| 218 | MC4>Notice: SimplSharpPro[App01] # 2020-07-21 22:19:46 # Recalling startup scenes (if applicable) | ||
| 219 | Performing Discovery on 1 Gateways. | ||
| 220 | Evaluating 3 Devices on Gateway 30 | ||
| 221 | Claiming ZUM-NETBRIDGE SN: 1726NEJ01096 from IP-ID: 30 | ||
| 222 | Dev: ZUMMESH-NETBRIDGE already claimed at RF ID: 03 | ||
| 223 | Claiming ZUM-NETBRIDGE SN: 1914NEJ03096 from IP-ID: 30 | ||
| 224 | Dev: ZUMMESH-NETBRIDGE already claimed at RF ID: 04 | ||
| 225 | Claiming ZUM-NETBRIDGE SN: 1914NEJ03098 from IP-ID: 30 | ||
| 226 | Dev: ZUMMESH-NETBRIDGE already claimed at RF ID: 05 | ||
| 227 | Discovering Zum Loads on 1 Gateways. | ||
| 228 | Discovering Zum Loads on 3 Devices. | ||
| 229 | Evaluating Device: ZUM-BLE ShortAddress: FFFA Type: BLERadio | ||
| 230 | Evaluating Device: ZUM-JBOX-20A-PLUG ShortAddress: 0000 Type: PlugLoad | ||
| 231 | Evaluating Device: ZUM-KP10C-BATT ShortAddress: 52E5 Type: Keypad | ||
| 232 | Evaluating Device: ZUM-PIR-OCC-BATT ShortAddress: DAF1 Type: OccupancySensor | ||
| 233 | Evaluating Device: ZUM-JBOX-5A-LV ShortAddress: 92EF Type: DimmableLoad | ||
| 234 | Load: Load37615 Added | ||
| 235 | NETBIRDGE: NewLoads: 1 ModifiedLoads: 0 RemovedLoads: 0 | ||
| 236 | Device: ZUM Netbridge 30:03 at 30:03 discovery result: . | ||
| 237 | Evaluating Device: ZUM-BLE ShortAddress: FFFA Type: BLERadio | ||
| 238 | Evaluating Device: ZUM-DALI ShortAddress: 740D Type: Unknown | ||
| 239 | Evaluating Device: ZUM-5A-LV ShortAddress: 0482 Type: DimmableLoad | ||
| 240 | Load: Load1154 Added | ||
| 241 | Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: 0000 Type: DimmableLoad | ||
| 242 | Load: Load0 Added | ||
| 243 | Evaluating Device: ZUM-KP10C-BATT ShortAddress: D766 Type: Keypad | ||
| 244 | Evaluating Device: ZUM-OL-PHO-BATT ShortAddress: 95ED Type: Photocell | ||
| 245 | Evaluating Device: ZUM-PIR-OCC-BATT ShortAddress: 44C2 Type: OccupancySensor | ||
| 246 | Evaluating Device: ZUM-DALI-GROUP ShortAddress: 740D Type: Unknown | ||
| 247 | Evaluating Device: ZUM-DALI-GROUP ShortAddress: 740D Type: Unknown | ||
| 248 | NETBIRDGE: NewLoads: 2 ModifiedLoads: 0 RemovedLoads: 0 | ||
| 249 | Device: ZUM Netbridge 30:04 at 30:04 discovery result: . | ||
| 250 | Evaluating Device: ZUM-BLE ShortAddress: FFFA Type: BLERadio | ||
| 251 | Evaluating Device: ZUM-SIM ShortAddress: 0000 Type: OccupancySensor, PartitionSensor | ||
| 252 | Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: EBCF Type: DimmableLoad | ||
| 253 | Load: Load60367 Added | ||
| 254 | Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: 3CC1 Type: DimmableLoad | ||
| 255 | Load: Load15553 Added | ||
| 256 | Evaluating Device: ZUM-JBOX-16A-LV ShortAddress: F94A Type: DimmableLoad | ||
| 257 | Load: Load63818 Added | ||
| 258 | NETBIRDGE: NewLoads: 3 ModifiedLoads: 0 RemovedLoads: 0 | ||
| 259 | Device: ZUM Netbridge 30:05 at 30:05 discovery result: . | ||
| 260 | RF Gateways: 0 | ||
| 261 | RF Devices: 3 | ||
| 262 | New Loads: 6 | ||
| 263 | Modified Loads: 0 | ||
| 264 | Removed Loads: 0 | ||
| 265 | Zum Discovery Finished | ||
| 266 | }}} | ||
| 267 | ))) |