Skip to Content

Changes for page Zūm Discovery

Last modified by Austin Weygandt on 2025/05/02 20:21
From version 37.1
edited by Mark Kohlmann
on 2025/01/15 00:56
Change comment: There is no comment for this version
To version 40.1
edited by Alexander Mott
on 2025/04/03 17:35
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.mark\.kohlmann@chiefintegrations\.com
1 +XWiki.alexander\.mott@chiefintegrations\.com
Content
... ... @@ -1,6 +1,6 @@
1 1  (% class="box errormessage" %)
2 2  (((
3 -**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.
3 +ūūūūūū**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.
4 4  
5 5  **WARNING:** Cresnet Discovery is non-functional for ZUMNET-JBOXs with certain versions of Crestron Device Database.
6 6  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.
... ... @@ -59,7 +59,6 @@
59 59  1. Include addresses between 192.168.0.11 and 192.168.0.50 and 192.168.0.200 and 192.168.0.240:
60 60  (% style="font-family:Menlo,Monaco,Consolas,Courier New,monospace; white-space:pre" %)sr discover filter "Type='IPAddress' Settings='192.168.0.11-192.168.0.50,192.168.0.200-192.168.0.240'"
61 61  
62 -
63 63  === IP-ID Filter (Added in SR v3.067) ===
64 64  
65 65  The IP-ID filter will restrict discovered ZUMNET GATEWAYs or JBOXs to matching IP-IDs or IP-ID ranges.  Multiple IDs and ranges can be used.
... ... @@ -122,10 +122,16 @@
122 122  1. 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
123 123  1. Disconnect from any ZUMNET-JBOXs and then connect to the processor in Toolbox
124 124  1. 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>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Program Configuration.Zūm Discovery.WebHome||anchor="HDiscoveryFilter28ShowRunnerCLC21223.062ornewer29"]] in order to limit the devices that are brought into the ShowRunnerCLC™ configuration
125 -1. Run the command: ##sr discover zumnet true true##
126 -1*. 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
127 -1**. One area will be created per ZUMNET-JBOX, and all hardware attached to that ZUMNET-JBOX will be assigned to that area
128 -1*. 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
124 +1. Run the command: ##sr discover zumnet true true## to add ZUMNET-JBOXs, connected ZUMLINK devices, and some Cresnet devices (such as Cameo keypads) to the configuration. (Note
125 +1*. This command will update the ShowRunnerCLC™ configuration with: 
126 +1**. One area per claimed ZUMNET-JBOX based on the Room Name set in the app
127 +1**. One ZUMNET-BRIDGE load controller per claimed ZUMNET-JBOX to allow the Zūm Room to communicate its current status (scene, occupancy, etc.) to ShowRunnerCLC™
128 +1**. One entry for each ZUMLINK-KP, ZUMLINK-JBOX, and ZUMLINK occupancy sensor connected to each ZUMNET-JBOX
129 +1***. All devices and loads will be auto-labeled based on their connection information, //not// the names they are given in the Zūm App
130 +1***. Keypads will be brought in as "Remote" type and only follow the logic as defined in the Zūm App, allowing for scheduled enabling/disabling of keypads without adding any additional button functions from ShowRunnerCLC™
131 +1***. Occupancy sensors will be brought in with "Use Hardware Logic" and only follow the logic as defined in the Zūm App
132 +1*. Optionally, run ##sr discover zumnet false true## to only add new ZUMLINK devices to the configuration. **Note that previously added ZUMLINK devices will be added again if their CID has been changed**
133 +1*. Run ##sr discover zumnet true false## to add ZUMNET-JBOXs without bringing in any devices. **Note that if a ZUMNET-JBOX already has an entry in its IP Table, ShowRunnerCLC™ will not claim it.** The ZUMNET-JBOX's IP Table must be cleared in order for it to be claimed by the ShowRunnerCLC™ program
129 129  1. 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.
130 130  1. 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
131 131  
... ... @@ -152,6 +152,38 @@
152 152  1. **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.
153 153  )))
154 154  
160 +(% class="box errormessage" id="HCaution:" %)
161 +(((
162 +**Note:** Due to what is believed to be an SSL issue, ShowRunnerCLC™ will sometimes fail to acquire Zūm Wireless gateways with the ##sr discover zummesh true## or ##sr ethernet device claim [Hostname]## commands.
163 +
164 +To work around this issue, Zūm Wireless gateways need to be added to the "IpDevices" section of the SrConfig.json and then have their IP Tables manually updated using the ##addm [IP-ID] [Processor IP]## command. Once this has been done, the ##sr discover zummesh false## commands can be run as normal.
165 +
166 +Below is an example "IpDevices" section of a config with three gateways defined. Serial numbers are optional and can be deleted if not known. **Note:**  the "IpId" here is decimal, whereas the actual IP-ID that is assigned from Text Console is in hexadecimal. You will need to convert between the two: e.g. decimal "48" corresponds to hexadecimal "30", decimal "74" would correspond to hexadecimal "4A", etc.
167 +
168 +{{{ "Eiscs": [],
169 + "IpDevices": [
170 + {
171 + "Model": "CEN-GWEXER",
172 + "Name": "GW-1-1",
173 + "SerialNumber": "2402NEJ03956",
174 + "IpId": 48
175 + },
176 + {
177 + "Model": "CEN-GWEXER",
178 + "Name": "GW-1-2",
179 + "SerialNumber": "2402NEJ03862",
180 + "IpId": 49
181 + },
182 + {
183 + "Model": "CEN-GWEXER",
184 + "Name": "GW-2-1",
185 + "SerialNumber": "2402NEJ03887",
186 + "IpId": 50
187 + }
188 + ],
189 + "Keyswitches": [],}}}
190 +)))
191 +
155 155  == Manual RF Gateway Assignment Instructions ==
156 156  
157 157  Use this method if you have multiple ShowRunnerCLC™ instances on the same network or have gateways used by other Crestron systems.
... ... @@ -172,7 +172,8 @@
172 172  Use this method when you have a single ShowRunnerCLC™ instance on a local network with all gateways being used for ShowRunnerCLC™.
173 173  
174 174  * Connect to the processor's console with Toolbox or your favorite SSH client.
175 -* Type ##sr discover zummesh true## and press enter.
212 +* Type ##sr discover zummesh true## and press enter. ShowRunnerCLC™ will auto-assign an IP-ID. After all gateways have been claimed by ShowRunnerCLC™, proceed to the next step.
213 +* Type ##sr discover zummesh false## and press enter.
176 176  * Status messages and the results will be displayed on the console. The process should take about 3 minutes.
177 177  * 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.
178 178  * Type ##progreset## and press enter to restart ShowRunnerCLC™