Skip to Content

Changes for page Zūm Discovery

Last modified by Alexander Mott on 2025/04/03 17:35
From version 40.1
edited by Alexander Mott
on 2025/04/03 17:35
Change comment: There is no comment for this version
To version 31.1
edited by Craig Lewis
on 2024/09/30 17:35
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
1 +XWiki.craig\.lewis@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.
... ... @@ -20,58 +20,6 @@
20 20  
21 21  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.
22 22  
23 -= Discovery Filter (ShowRunnerCLC™ 3.062 or newer) =
24 -
25 -Discovered ethernet devices may be filtered using either a hostname or IP Address filter.  The filter is configured from the command line interface.
26 -
27 -##+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-+
28 -~| Command | Help |
29 -~|~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-|~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-|
30 -~| SR discover clear filter | Remove Discovery Filter |
31 -~| SR discover filter | Show Discovery Filter |
32 -~| SR discover filter (X:S) | Set Discovery Filter |
33 -~| - | (X):S:Filter String |
34 -~|~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-|~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-~-|##
35 -
36 -=== Hostname Filter ===
37 -
38 -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.
39 -
40 -Command Syntax: ##"Type='Hostname' Settings='Expr1[,Expr2]'"##
41 -
42 -Examples:
43 -
44 -1. Only include hostnames that start with ZUMNET-06:
45 -(% style="font-family:Menlo,Monaco,Consolas,Courier New,monospace; white-space:pre" %)sr discover filter "Type='Hostname' Settings='^ZUMNET-06'"
46 -1. Include hostnames that start with ZUMNET-FL01 or contain FL03:
47 -(% style="font-family:Menlo,Monaco,Consolas,Courier New,monospace; white-space:pre" %)sr discover filter "Type='Hostname' Settings='^ZUMNET-FL01,FL03'"
48 -
49 -=== IP Address Filter ===
50 -
51 -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.
52 -
53 -Command Syntax: ##"Type='IPAddress' Settings='Address[,AddressStart-AddressEnd]'"##
54 -
55 -Examples:
56 -
57 -1. Only include a device with an address of 192.168.0.10 or 192.168.0.50:
58 -(% style="font-family:Menlo,Monaco,Consolas,Courier New,monospace; white-space:pre" %)sr discover filter "Type='IPAddress' Settings='192.168.0.10,192.168.0.50'"
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 -(% 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 -
62 -=== IP-ID Filter (Added in SR v3.067) ===
63 -
64 -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.
65 -
66 -Command Syntax: ##"Type='IPID' Settings='IPID[,IPIDStart-IPIDEnd]'"##
67 -
68 -Examples:
69 -
70 -1. Only include a device with an IP-ID of 10 or 5A:
71 -(% style="font-family:Menlo,Monaco,Consolas,Courier New,monospace; white-space:pre" %)sr discover filter "Type='IPID' Settings='10,5A'"
72 -1. Include addresses between 11 and 4F and A0 and BF:
73 -(% style="font-family:Menlo,Monaco,Consolas,Courier New,monospace; white-space:pre" %)sr discover filter "Type='IPID' Settings='11-4F,A0-BF'"
74 -
75 75  = Zūm Wired Discovery =
76 76  
77 77  == Notes and Limitations ==
... ... @@ -83,7 +83,7 @@
83 83  * 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
84 84  * Cresnet devices landed on Zūm Link will not be discovered (Crestron bug expected to be corrected in a future firmware release)
85 85  * ZUMLINK-IOs will not be discovered (Expected to be discoverable in future ShowRunnerCLC™ release)
86 -* ZUMLINK-KPs will not be discovered on older versions of ShowRunnerCLC™ (v3.058 or newer will discover keypads and set as remote type)
34 +* ZUMLINK-KPs will not be discovered on older versions of ShowRunnerCLC™ (v3.058 or newer)
87 87  * One area will be created per ZUMNET-JBOX; if there are more areas than ZUMNET-JBOXs, additional areas must be created manually
88 88  )))
89 89  
... ... @@ -120,19 +120,13 @@
120 120  1*. 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
121 121  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
122 122  1. Disconnect from any ZUMNET-JBOXs and then connect to the processor in Toolbox
123 -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
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
71 +1. Run the command: ##sr discover zumnet true false##
72 +1*. This command tells ShowRunnerCLC™ to discover all ZUMMNET-JBOXs on the network, configure their IP tables, and then add corresponding IP Devices to the configuration
73 +1. Run the command: ##sr discover zumnet true true##
74 +1*. This command tells ShowRunnerCLC™ to 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
75 +1**. One area will be created per ZUMNET-JBOX, and all hardware attached to that ZUMNET-JBOX will be assigned to that area
76 +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
134 134  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.
135 -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
136 136  
137 137  = Zūm Wireless Discovery =
138 138  
... ... @@ -157,38 +157,6 @@
157 157  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.
158 158  )))
159 159  
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 -
192 192  == Manual RF Gateway Assignment Instructions ==
193 193  
194 194  Use this method if you have multiple ShowRunnerCLC™ instances on the same network or have gateways used by other Crestron systems.
... ... @@ -209,8 +209,7 @@
209 209  Use this method when you have a single ShowRunnerCLC™ instance on a local network with all gateways being used for ShowRunnerCLC™.
210 210  
211 211  * Connect to the processor's console with Toolbox or your favorite SSH client.
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.
122 +* Type ##sr discover zummesh true## and press enter.
214 214  * Status messages and the results will be displayed on the console. The process should take about 3 minutes.
215 215  * 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.
216 216  * Type ##progreset## and press enter to restart ShowRunnerCLC™