Skip to Content

Changes for page Zūm Discovery

Last modified by Alexander Mott on 2025/04/03 17:35
From version 13.1
edited by Alexander Mott
on 2022/10/10 23:33
Change comment: There is no comment for this version
To version 24.3
edited by Craig Lewis
on 2024/05/22 21:47
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,1 +1,1 @@
1 -SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Device Addressing.WebHome
1 +SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Program Configuration.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
1 +XWiki.craig\.lewis@chiefintegrations\.com
Content
... ... @@ -1,6 +1,14 @@
1 +(% class="box errormessage" %)
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.
4 +
5 +**WARNING:** Cresnet Discovery is non-functional for ZUMNET-JBOXs with certain versions of Crestron Device Database.
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.
7 +)))
8 +
1 1  (% class="box warningmessage" %)
2 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]].
11 +This article is about automatically building a ShowRunnerCLC™ configuration using the Zūm Discovery feature of ShowRunnerCLC™. For instructions on configuring Zūm Wired rooms using the Crestron Zūm App, see [[this page>>SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Preparation.Zūm App Overview.WebHome]].
4 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 5  )))
6 6  
... ... @@ -8,17 +8,17 @@
8 8  {{toc/}}
9 9  {{/box}}
10 10  
11 -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™.
19 +If Zūm Wired or Wireless devices have been configured using Crestron's Zūm App, then it is possible to automatically build a ShowRunnerCLC™ configuration file using the Zūm Discovery feature that is built into ShowRunnerCLC™.
12 12  
13 -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.
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.
14 14  
15 15  = Zūm Wired Discovery =
16 16  
17 17  == Notes and Limitations ==
18 18  
19 -(% class="box errormessage" %)
27 +(% class="box warningmessage" %)
20 20  (((
21 -* SHOWRUNNER™ version 3.014 or newer required
29 +* ShowRunnerCLC™ version 3.014 or newer required
22 22  * Zūm Wired firmware .puf version 1.02.10 or greater required (ZUMNET-JBOX installed minimum version 1.001.00081)
23 23  * Disconnect from any ZUMNET devices you may be connected to in Toolbox prior to running the discovery commands
24 24  * Cresnet devices landed on Zūm Link will not be discovered (Crestron bug expected to be corrected in a future firmware release)
... ... @@ -27,86 +27,93 @@
27 27  
28 28  == Steps ==
29 29  
30 -1. [[Install SHOWRUNNER™>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.WebHome]] on the processor and configure the processor as necessary
38 +1. [[Install ShowRunner™>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.WebHome]] on the processor and configure the processor as necessary
31 31  1*. 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.
32 32  1. 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: 
33 33  1*. Connect to the first ZUMNET-JBOX in Toolbox
34 34  1*. Configure a static IP address for the ZUMNET-JBOX if there is no DHCP server on the network 
35 -1**. Note: The SHOWRUNNER™ built-in DHCP server is not meant to be used in production
36 -1**. 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
43 +1**. Note: The ShowRunnerCLC™ built-in DHCP server is not meant to be used in production
44 +1**. If the ShowRunnerCLC™ built-in DHCP server was used to assign IP addresses to devices, it is still necessary to give those devices static IP addresses
37 37  1*. Set unique Connection IDs for each device hosted on the ZUMNET-JBOX so that their firmware can be updated
38 38  1*. Load the Zūm Wired firmware to the ZUMNET-JBOX
39 39  1*. Repeat the above steps for all ZUMNET-JBOXs
40 40  1*. 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
41 -1. Connect to first ZUMNET-JBOX in the Crestron Zūm App
49 +1. Connect to each ZUMNET-JBOX in the Crestron Zūm App
50 +1*. Commission room through the app
51 +1**. configure keypad logic
52 +1**. configure occupancy sensor settings
53 +1**. calibrate photocell(s)
54 +1*. Set hostnames for the ZUMNETs.
55 +1**. Zūm discovery will bring in hostnames.
42 42  1. Unique Connection IDs should be automatically assigned to any Zūm Link and Cresnet devices on the ZUMNET-JBOX
43 43  1*. If firmware was out-of-date, then this step should have already been completed
44 44  1*. If unique CIDs are not automatically assigned, connect to the JBOX in Toolbox and give the devices unique CIDs
45 45  1. Configure a static IP address for the ZUMNET-JBOX if there is no DHCP server on the network 
46 46  1*. If firmware was out-of-date, then this step should have already been completed
47 -1*. Note: The SHOWRUNNER™ built-in DHCP server is not meant to be used in production
48 -1*. 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
61 +1*. Note: The ShowRunnerCLC™ built-in DHCP server is not meant to be used in production
62 +1*. If the ShowRunnerCLC™ built-in DHCP server was used to assign IP addresses to devices, it is still necessary to give those devices static IP addresses
49 49  1. 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
50 50  1*. If you do not manually configure the IP table, then SHOWRUNNER™ will automatically configure the IP-ID for each ZUMNET-JBOX during discovery
51 51  1. Set the ZUMNET-JBOX into either Zūm ("App") mode or CNET mode as required for the program
52 -1*. Full control from SHOWRUNNER™ is only possible if all ZUMNET-JBOXs are in CNET mode. Odd behavior may result from conflicts between SHOWRUNNER™ and internal logic if the ZUMNET-JBOXs are not put into CNET mode
53 -1. 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
66 +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
67 +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
54 54  1. Disconnect from any ZUMNET-JBOXs and then connect to the processor in Toolbox
55 55  1. Run the command: ##sr discover zumnet true false##
56 -1*. This command tells SHOWRUNNER™ to discover all ZUMMNET-JBOXs on the network, configure their IP tables, and then add corresponding IP Devices to the configuration
70 +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
57 57  1. Run the command: ##sr discover zumnet true true##
58 -1*. This command tells SHOWRUNNER™ 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
72 +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
59 59  1**. One area will be created per ZUMNET-JBOX, and all hardware attached to that ZUMNET-JBOX will be assigned to that area
60 60  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
75 +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.
61 61  
62 62  = Zūm Wireless Discovery =
63 63  
64 64  == Notes and Limitations ==
65 65  
66 -(% class="box errormessage" %)
81 +(% class="box warningmessage" %)
67 67  (((
68 -* Processor with SHOWRUNNER™ version 2.190 or newer must be running on the same network as the gateway(s) to be acquired
69 -** For SHOWRUNNER™ versions prior to 3.014 and newer, replace **##sr discover zummesh##** commands with **##sr discover zum##**
83 +* Processor with ShowRunnerCLC™ version 2.190 or newer must be running on the same network as the gateway(s) to be acquired
84 +** For ShowRunnerCLC™ versions prior to 3.014 and newer, replace **##sr discover zummesh##** commands with **##sr discover zum##**
70 70  * ZUM-NETBRIDGES must already be acquired to their respective gateway
71 -* SHOWRUNNER™ will automatically address any ZUM-NETBRIDGES that do not need have addresses assigned, but will still honor any already addressed devices
86 +* ShowRunnerCLC™ will automatically address any ZUM-NETBRIDGES that do not need have addresses assigned, but will still honor any already addressed devices
72 72  * Disconnect from any RF gateways you may be connected to in Toolbox prior to running the discovery command
73 -* Plug loads will not appear in the SHOWRUNNER™ UI
88 +* Plug loads will not appear in the ShowRunnerCLC™ UI
74 74  )))
75 75  
76 -(% class="box warningmessage" id="HCaution:" %)
91 +(% class="box infomessage" id="HCaution:" %)
77 77  (((
78 -**Note:** SHOWRUNNER™ has two different approaches for Zūm Wireless Discovery
93 +**Note:** ShowRunnerCLC™ has two different approaches for Zūm Wireless Discovery
79 79  
80 -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.
81 -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.
95 +1. **Manual RF Gateway Assignment** - ShowRunnerCLC™ 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.
96 +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.
82 82  )))
83 83  
84 84  == Manual RF Gateway Assignment Instructions ==
85 85  
86 -Use this method if you have multiple SHOWRUNNER™ instances on the same network or have gateways used by other Crestron systems.
101 +Use this method if you have multiple ShowRunnerCLC™ instances on the same network or have gateways used by other Crestron systems.
87 87  
88 88  * Connect to the processor's console with Toolbox or your favorite SSH client.
89 89  * Type ##sr devmgr ethernet query## and press enter. This queries the local network for RF Gateways.
90 90  * Type ##sr devmgr ethernet show devices## and press enter. This displays all found Crestron ethernet devices.
91 -* 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.
106 +* 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##. ShowRunnerCLC™ will auto-assign an IP-ID. After all gateways have been claimed by ShowRunnerCLC™, proceed to the next step.
92 92  * Type ##sr discover zummesh false## and press enter.
93 93  * Status messages and the results will be displayed on the console. The process should take about 3 minutes.
94 -* 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.
95 -* Type ##progreset## and press enter to restart SHOWRUNNER™
96 -* 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.
109 +* 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.
110 +* Type ##progreset## and press enter to restart ShowRunnerCLC™
111 +* Once SHOWRUNNER™ has finished restarting type ##sr discover zummesh false## and press enter. ShowRunnerCLC™ will be able to acquire the loads attached to the Zūm rooms at this point.
97 97  * Once completed SHOWRUNNER™ is now ready for full Zūm control
98 98  
99 99  == Claim All RF Gateways Instructions ==
100 100  
101 -Use this method when you have a single SHOWRUNNER™ instance on a local network with all gateways being used for SHOWRUNNER™.
116 +Use this method when you have a single ShowRunnerCLC™ instance on a local network with all gateways being used for ShowRunnerCLC™.
102 102  
103 103  * Connect to the processor's console with Toolbox or your favorite SSH client.
104 104  * Type ##sr discover zummesh true## and press enter.
105 105  * Status messages and the results will be displayed on the console. The process should take about 3 minutes.
106 -* 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.
107 -* Type ##progreset## and press enter to restart SHOWRUNNER™
108 -* 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.
109 -* Once completed SHOWRUNNER™ is now ready for full Zūm control
121 +* 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.
122 +* Type ##progreset## and press enter to restart ShowRunnerCLC™
123 +* Once ShowRunnerCLC™ has finished restarting type ##sr discover zummesh false## and press enter. ShowRunnerCLC™ will be able to acquire the loads attached to the Zūm rooms at this point.
124 +* Once completed ShowRunnerCLC™ is now ready for full Zūm control
110 110  
111 111  == Examples ==
112 112