Wiki source code of *Starting Up Zūm Wired with SHOWRUNNER™
Version 31.1 by Alexander Mott on 2023/03/29 23:36
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
8.1 | 1 | {{box cssClass="floatinginfobox" title="**CONTENTS**"}} |
| |
1.1 | 2 | {{toc/}} |
| 3 | {{/box}} | ||
| |
2.1 | 4 | |
| |
1.1 | 5 | (% class="row" %) |
| 6 | ((( | ||
| |
7.1 | 7 | SHOWRUNNER™ provides a number of benefits over using the default program. These benefits are covered in detail on our [[Crestron Zūm Wired and SHOWRUNNER™>>doc:Design Guide.Hardware Design Guide.Crestron Zum Wired.Crestron Zum Wired Overview.WebHome]], but one of the largest benefits are the tools included with SHOWRUNNER™ to make Zūm Wired start-ups go as smoothly as possible. |
| |
2.1 | 8 | |
| |
9.1 | 9 | = App Mode (Zūm Discovery) = |
| |
8.1 | 10 | |
| |
6.3 | 11 | (% class="box errormessage" %) |
| 12 | ((( | ||
| 13 | WARNING: Cresnet Discovery is not currently working on ZUMNET-JBOXs. Crestron has acknowledged a fix has been sent to QE. Discovery must be fixed before SHOWRUNNER™ can auto-discover hardware. | ||
| 14 | ))) | ||
| |
8.1 | 15 | |
| |
6.4 | 16 | SHOWRUNNER™ includes a Zūm Wired Discovery feature that makes it easy to import Zūm Rooms that have been configured in App Mode into an existing SHOWRUNNER™ configuration. The process for starting up a system using this method is the same as starting up any other networked installation in App Mode, but with the added steps of installing SHOWRUNNER and importing Zūm Rooms into the configuration. |
| |
21.1 | 17 | |
| |
6.4 | 18 | Installing SHOWRUNNER™ on different processors is covered in our [[startup pages>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.WebHome]], while importing Zūm Rooms is covered in the [[Zūm Wired Discovery>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Device Addressing.Zūm Discovery.WebHome]] page. |
| |
6.2 | 19 | |
| |
10.1 | 20 | = CNET Mode (SHOWRUNNER™ Total Control) = |
| |
8.2 | 21 | |
| |
21.1 | 22 | Using SHOWRUNNER™ to control a networked Zūm Wired installation with ZUMNET-JBOXs running in CNET mode is the recommended way of using SHOWRUNNER™ with Zūm Wired. This is also the only way to gain control of legacy Cresnet devices (such as GL-EXP-DIMU-CN, C2N-IO, and GLS-PART-CN) that are connected to a ZUMNET-JBOX, as these Cresnet devices are not recognized or supported by the Crestron Zūm App. |
| |
10.1 | 23 | |
| |
3.1 | 24 | (% class="box warningmessage" %) |
| 25 | ((( | ||
| |
21.1 | 26 | steps subject to change pending finalization of chief zum wired loadscript tool |
| |
31.1 | 27 | (i intend for the loadscript tool to require the showrunner license to function; the license contains the processor MAC address, which will be used to determine the IP address for the ip table entries; user will be prompted to confirm/correct IP address for IP table entries) |
| 28 | |||
| 29 | (also intend to have check boxes to select which scripts are desired) | ||
| |
21.1 | 30 | ))) |
| |
3.1 | 31 | |
| |
21.1 | 32 | The steps for configuring a networked Zūm Wired installation with SHOWRUNNER™ are: |
| |
5.1 | 33 | |
| |
21.1 | 34 | 1. Install SHOWRUNNER™ and configure the processor per our [[startup guides>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.WebHome]] |
| 35 | 1*. If using a processor without a dedicated Control Subnet, follow the [[additional steps detailed below>>doc:Design Guide.Hardware Design Guide.Crestron Zum Wired.Starting Up Zum Wired with SHOWRUNNER.WebHome||anchor="HToolsforStaticallyConfiguredLightingNetworks"]] | ||
| 36 | 1. Verify that all expected ZUMNET-JBOX-* devices are reporting online using the Device Discovery tool in Toolbox | ||
| 37 | 1*. Your laptop and the ZUMNET-JBOXs should all be connected to the Control Subnet | ||
| 38 | 1*. If there are missing ZUMNET-JBOXs, verify with the EC that the devices are powered and that the Zūm Net cabling is correct | ||
| 39 | 1*. Recall that any ZUMNET-JBOX that is unpowered or disconnected will prevent downstream ZUMNET-JBOXs from coming online | ||
| 40 | 1. Once all hardware is online, use the [[Device Discovery Tool>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Preparation.Toolbox Basics.WebHome||anchor="HDeviceDiscoveryTool"]] in Toolbox to [[export a Device Summary>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Preparation.Toolbox Basics.WebHome||anchor="HExporttoDeviceSummary"]] file | ||
| 41 | 1*. These steps can still be followed even if not all the hardware is online | ||
| 42 | 1*. If not all the hardware is online, then these steps will need to be repeated and the loadscripts run just for the previously offline devices | ||
| 43 | 1*. Alternatively, if there are only a few previously offline devices, then they can be [[configured and updated manually>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.ZUMNET-JBOX Setup.WebHome]] | ||
| 44 | 1. Add columns for hostname ("Host", J) and IP-ID ("IP-ID", K) as shown below[[image:1680131811288-423.png]] | ||
| 45 | 1. Fill out these columns for each of the ZUMNET-JBOXs in the device summary | ||
| |
31.1 | 46 | 1*. Columns L through O are optional unless static IP addresses are required, as covered [[below>>doc:Design Guide.Hardware Design Guide.Crestron Zum Wired.Starting Up Zum Wired with SHOWRUNNER.WebHome||anchor="HToolsforStaticallyConfiguredLightingNetworks"]] |
| |
21.1 | 47 | 1*. If this information has already been filled out in the SHOWRUNNER™ Takeoff IP Table sheet, then it is easy to copy/paste from the takeoff into the Device Summary .csv by sorting and filtering the two documents by MAC address |
| |
31.1 | 48 | 1. Use the modified Device Summary file and Chief Integrations' Zūm Wired Loadscript Tool to generate loadscripts for: |
| 49 | 1*. Convert to Primary & App Mode | ||
| 50 | 1*. Update FW | ||
| 51 | 1*. Convert to CNET Mode | ||
| 52 | 1**. Optionally, generate Convert to CNET + Autoswitch On if automatic switching between CNET and App mode is desired | ||
| 53 | 1*. IP Config (DHCP) | ||
| 54 | 1. Run the "Convert to Primary & App Mode" loadscript | ||
| 55 | 1*. This loadscript connects to each ZUMNET-JBOX by their default hostname and updates their "zwmode" settings | ||
| 56 | 1*. Devices will reboot | ||
| 57 | 1*. **Verify that all devices report completing successfully in the Loadscript Manager tool before proceeding to the next step; re-run the loadscript for specific devices as necessary** | ||
| 58 | 1. Connect to a handful of ZUMNET-JBOXs to verify that all ZUMLINK-* devices have been given unique CIDs | ||
| 59 | 1. Run the "Update FW" loadscript | ||
| 60 | 1*. This loadscript connects to each ZUMNET-JBOX by their default hostname and updates their firmware | ||
| 61 | 1*. This loadscript must be located in the same folder as the firmware .puf file | ||
| 62 | 1*. Devices will reboot | ||
| 63 | 1*. **Verify that all devices report completing successfully in the Loadscript Manager tool before proceeding to the next step; re-run the loadscript for specific devices as necessary** | ||
| 64 | 1**. If the script has been re-run multiple times and has failed each time, connect to the ZUMNET-JBOX and verify that all the ZUMLINK-* hardware appears correctly | ||
| 65 | 1**. Attempt to run the .puf file separately without a load script | ||
| 66 | 1**. If you encounter devices that report as "UNDEFINED" model types, see our FAQ on this topic (link) | ||
| 67 | 1. Once FW updates are complete, verify all ZUMNET-JBOX actually took the FW update by using Device Discovery Tool to export a Device Summary and observe that the reported FW for all devices matches the FW version in the .puf file | ||
| 68 | 1*. Because ZUMNET-JBOX update their own firmware after attached ZUMLINK-* devices, if a ZUMNET-JBOX is up-to-date then all ZUMLINK-* devices should also be updated | ||
| 69 | 1*. If ZUMLINK-* devices have conflicting CIDs or are not online, then they will not update | ||
| 70 | 1. If using | ||
| |
21.1 | 71 | |
| |
31.1 | 72 | |
| 73 | |||
| 74 | |||
| |
3.1 | 75 | * use chief tools tm tool to generate various zum wired load scripts |
| 76 | * if firmware is old, run "zwms master/zum (def. hostname)" loadscript to make all ZUMNET JBOX primary and in app mode in order to enable discovery of devices on zumlink | ||
| 77 | ** devices will reboot | ||
| 78 | ** per crestron, 1.0006.00012 and newer ship in primary mode (**tbd if they will ship in app mode?**) | ||
| 79 | * connect to a few devices in device discovery tool to ensure that all zumlink devices were automatically readdressed and there are no conflicting cids | ||
| 80 | ** firmware 1.0001.00081 is new enough that this works correctly | ||
| 81 | * run "fw update (def. hostname)" loadscript to update the fw for all devices | ||
| 82 | ** will take up to several minutes per room, but will be able to do up to 10 rooms simultaneously | ||
| 83 | ** devices will reboot, possibly multiple times | ||
| 84 | ** check loadscript manager for any failures and re-run script for those devices if necessary (a rebooting zumnet box will temporarily disrupt online status for downstream zumnet jboxs and potentially interrupt the firmware update) | ||
| |
6.1 | 85 | * run device discovery again to confirm that all zumnet boxes were updated |
| 86 | * if app mode backup is desired, configure the boxes using the app now | ||
| |
3.1 | 87 | * run "ip config (def. hostname)" loadscript to update device IP-IDs and hostnames |
| 88 | ** devices will reboot | ||
| 89 | ** devices will now have new hostnames, so any further loadscripts should use (new hostname) versions | ||
| |
6.1 | 90 | * run "cnet mode (def. hostname)" loadscript to put devices into CNET mode |
| 91 | ** if app mode backup is desired, also run "autoswitch enable (def. hostname)" loadscript | ||
| 92 | ** devices will reboot | ||
| |
3.1 | 93 | * if using a processor without control subnet, run the "static ip config (new hostname)" script |
| 94 | ** this loadscript is necessary, as the showrunner DHCP server is only intended for commissioning. It must always be manually started after program restart and should not be used in production | ||
| 95 | ** (**will probably need a lot of extra steps + alterations to how we make configs since static IPs require a lot more information as well as corresponding modifications to SrConfig.json**) | ||
| |
5.1 | 96 | * once done, commission job essentially as normal showrunner job |
| 97 | ** (**sr commissioning guide is incomplete**) | ||
| |
6.1 | 98 | ** connect to each zumnet jbox and address zumlink devices per the takeoff |
| 99 | *** if devices are not online, then troubleshoot why and update firmware through device tree view once they are online | ||
| |
5.1 | 100 | ** occ timeouts can be adjusted through UI; other settings (ie reach) should be adjusted through app |
| 101 | ** photocells etc are set up through UI | ||
| 102 | ** loads teseted and verified through UI; can be moved around between controllers as necessary | ||
| 103 | *** loads don't need to be in the same room as the zumnet that controls them | ||
| 104 | ** keypads can use standard SR types or be fully customized | ||
| 105 | ** set up schedule, etc. | ||
| |
6.1 | 106 | * once done, save and back up configuration file |
| |
9.1 | 107 | |
| |
10.1 | 108 | = Tools for Statically Configured Lighting Networks = |
| |
9.1 | 109 | |
| |
10.1 | 110 | Unlike installations using the default program, SHOWRUNNER™ offers the opportunity to reduce the cost of hardware by enabling the use of any 3 or 4-Series processor, rather than being restricted to using the ZUM-HUB4 exclusively. Some of these other processors (DIN-AP4, RMC4, etc.) do not include a Control Subnet with built-in router, which requires the use of static IP addresses if the lighting network is to remain independent and there is no router specified to manage traffic on the lighting network. SHOWRUNNER™ includes several built-in features to assist with these sort of startups without requiring a Technician to bring their own router. |
| |
9.1 | 111 | |
| |
10.1 | 112 | This section does not apply to processors with a built in Control Subnet (CP4N, AV4, PRO4, ZUM-HUB4, etc.) or lighting networks that are fully integrated with a managed building LAN. |
| 113 | |||
| 114 | The steps for statically configuring a networked Zūm Wired installation with SHOWRUNNER™ are: | ||
| 115 | |||
| |
11.1 | 116 | 1. [[Configure the static IP address>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Processor Setup.WebHome||anchor="HIPConfiguration"]] for the processor and [[install SHOWRUNNER™>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Processor Setup.WebHome||anchor="HProgramLoad"]] |
| |
11.2 | 117 | 1. Use SHOWRUNNER™'s built in [[DHCP server>>doc:SHOWRUNNER™ Setup Guide.Troubleshooting Guide.Advanced Tools.DHCP Server.WebHome]] |
| |
21.1 | 118 | 1*. If you want to use specific static IP addresses for specific ZUMNET-JBOXs, use the SHOWRUNNER™ UI and set the DHCP range outside of the range you intend to use for the ZUMNET-JBOXs |
| 119 | 1*. If arbitrary static IP addresses are acceptable, then use the default IP address range | ||
| 120 | 1. Proceed with the standard [[CNET Mode>>doc:Design Guide.Hardware Design Guide.Crestron Zum Wired.Starting Up Zum Wired with SHOWRUNNER.WebHome||anchor="HCNETMode28SHOWRUNNER2122TotalControl29"]] start-up procedure from step 2 | ||
| 121 | 1. Once the standard start-up procedure has been completed, [[export a new Device Summary>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Preparation.Toolbox Basics.WebHome||anchor="HExporttoDeviceSummary"]] file | ||
| 122 | 1. Change the Device Summary filetype to ".csv" and open in Microsoft Excel | ||
| |
30.1 | 123 | 1. Add columns for hostname ("Host", J), IP-ID ("IP-ID", K), static IP address ("IPA", L), static IP subnet mask ("IPM", M), default gateway ("DEFR", N), and domain name server ("DNS", O) as shown below[[image:1680131811288-423.png]] |
| |
21.1 | 124 | 1. Fill out these columns for each of the ZUMNET-JBOXs in the device summary |
| 125 | 1*. If there is no default gateway or DNS, use the processor's IP address instead | ||
| 126 | 1*. "IP-ID" column is optional | ||
| 127 | 1*. If this information has already been filled out in the SHOWRUNNER™ Takeoff IP Table sheet, then it is easy to copy/paste from the takeoff into the Device Summary .csv by sorting and filtering the two documents by MAC address | ||
| |
31.1 | 128 | 1. Use the modified Device Summary file and Chief Integrations' Zūm Wired Loadscript Tool to generate a loadscript that connects to devices by their hostname and sets their static IP settings |
| |
21.1 | 129 | 1*. Up to 10 devices can be configured simultaneously |
| 130 | 1*. Devices will reboot once this script is run | ||
| |
31.1 | 131 | 1*. **Verify that all devices report completing successfully in the Loadscript Manager tool before proceeding to the next step; re-run the loadscript for specific devices as necessary** |
| |
21.1 | 132 | 1. If desired, export a new Device Summary file as a record that this step was completed successfully |
| 133 | 1. If desired, disable the processor's DHCP service (the service will not resume if the processor reboots or the program restarts) | ||
| |
3.1 | 134 | ))) |