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