Last modified by Alexander Mott on 2023/12/13 19:15
From version 7.1
edited by Alexander Mott
on 2023/03/29 21:26
Change comment: There is no comment for this version
To version 33.1
edited by Alexander Mott
on 2023/03/30 00:54
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,4 +1,4 @@
1 -({{box cssClass="floatinginfobox" title="**CONTENTS**"}}
1 +{{box cssClass="floatinginfobox" title="**CONTENTS**"}}
2 2  {{toc/}}
3 3  {{/box}}
4 4  
... ... @@ -6,67 +6,112 @@
6 6  (((
7 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.
8 8  
9 -= App Mode Zūm Discovery =
9 += App Mode (Zūm Discovery) =
10 +
10 10  (% class="box errormessage" %)
11 11  (((
12 12  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.
13 13  )))
15 +
14 14  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.
17 +
15 15  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.
16 16  
17 -= (SHOWRUNNER™ Complete Control) =
20 += CNET Mode (SHOWRUNNER™ Total Control) =
18 18  
19 -= Start-Up Guide =
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.
20 20  
21 -Lorem
22 -
23 23  (% class="box warningmessage" %)
24 24  (((
25 -cross reference/update to old [[zumnet startup>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.ZUMNET-JBOX Setup.WebHome]]?
26 +steps subject to change pending finalization of chief zum wired loadscript tool
26 26  
27 -basic steps:
28 +our regular commissioning guide is still incomplete, and it is referenced below
29 +(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 28  
29 -* configure your processor per chief's startup guide
30 -* get all zumnet jbox online
31 -** use built in dhcp from processor control subnet
32 -** if using proc without control subnet, use showrunner [[dhcp>>doc:SHOWRUNNER™ Setup Guide.Troubleshooting Guide.Advanced Tools.DHCP Server.WebHome]]
33 -** (**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**)
34 -* use crestron toolbox device discovery to create a [[Device Summary>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Preparation.Toolbox Basics.WebHome||anchor="HExporttoDeviceSummary"]]
35 -* use chief tools tm tool to generate various zum wired load scripts
36 -** (need to determine exact process for this; will need to add IP-ID and new hostname to device summary somehow)
37 -** (will likely generate two versions of the loadscripts; one connecting by default hostname and one connecting by new hostname)
38 -** (intend to require SR license for zwired LS generator, if only to get the proc mac address)
39 -* 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
40 -** devices will reboot
41 -** per crestron, 1.0006.00012 and newer ship in primary mode (**tbd if they will ship in app mode?**)
42 -* connect to a few devices in device discovery tool to ensure that all zumlink devices were automatically readdressed and there are no conflicting cids
43 -** firmware 1.0001.00081 is new enough that this works correctly
44 -* run "fw update (def. hostname)" loadscript to update the fw for all devices
45 -** will take up to several minutes per room, but will be able to do up to 10 rooms simultaneously
46 -** devices will reboot, possibly multiple times
47 -** 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)
48 -* run device discovery again to confirm that all zumnet boxes were updated
49 -** zumnet boxes update last, so if a zumnet jbox is updated then this means that all of the zumlink devices that were online have also been updated
50 -* if app mode backup is desired, configure the boxes using the app now
51 -* run "ip config (def. hostname)" loadscript to update device IP-IDs and hostnames
52 -** devices will reboot
53 -** devices will now have new hostnames, so any further loadscripts should use (new hostname) versions
54 -* run "cnet mode (def. hostname)" loadscript to put devices into CNET mode
55 -** if app mode backup is desired, also run "autoswitch enable (def. hostname)" loadscript
56 -** devices will reboot
57 -* if using a processor without control subnet, run the "static ip config (new hostname)" script
58 -** 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
59 -** (**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**)
60 -* once done, commission job essentially as normal showrunner job
61 -** (**sr commissioning guide is incomplete**)
62 -** connect to each zumnet jbox and address zumlink devices per the takeoff
63 -*** if devices are not online, then troubleshoot why and update firmware through device tree view once they are online
64 -** occ timeouts can be adjusted through UI; other settings (ie reach) should be adjusted through app
65 -** photocells etc are set up through UI
66 -** loads teseted and verified through UI; can be moved around between controllers as necessary
67 -*** loads don't need to be in the same room as the zumnet that controls them
68 -** keypads can use standard SR types or be fully customized
69 -** set up schedule, etc.
70 -* once done, save and back up configuration file
31 +(also intend to have check boxes to select which scripts are desired)
71 71  )))
33 +
34 +The steps for configuring a networked Zūm Wired installation with SHOWRUNNER™ are:
35 +
36 +1. Install SHOWRUNNER™ and configure the processor per our [[startup guides>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.WebHome]]
37 +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"]]
38 +1. Verify that all expected ZUMNET-JBOX-* devices are reporting online using the Device Discovery tool in Toolbox
39 +1*. Your laptop and the ZUMNET-JBOXs should all be connected to the Control Subnet
40 +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
41 +1*. Recall that any ZUMNET-JBOX that is unpowered or disconnected will prevent downstream ZUMNET-JBOXs from coming online
42 +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
43 +1*. These steps can still be followed even if not all the hardware is online
44 +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
45 +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]]
46 +1. Add columns for hostname ("Host", J) and IP-ID ("IP-ID", K) as shown below[[image:1680131811288-423.png]]
47 +1. Fill out these columns for each of the ZUMNET-JBOXs in the device summary
48 +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"]]
49 +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
50 +1. Use the modified Device Summary file and Chief Integrations' Zūm Wired Loadscript Tool to generate loadscripts for:
51 +1*. Convert to Primary & App Mode
52 +1*. Update FW
53 +1*. Convert to CNET Mode
54 +1**. Optionally, generate Convert to CNET + Autoswitch On if automatic switching between CNET and App mode is desired
55 +1*. IP Config (DHCP)
56 +1. Run the "Convert to Primary & App Mode" loadscript
57 +1*. This loadscript connects to each ZUMNET-JBOX by their default hostname and updates their "zwmode" settings
58 +1*. Devices will reboot
59 +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**
60 +1. Connect to a handful of ZUMNET-JBOXs to verify that all ZUMLINK-* devices have been given unique CIDs
61 +1. Run the "Update FW" loadscript
62 +1*. This loadscript connects to each ZUMNET-JBOX by their default hostname and updates their firmware
63 +1*. This loadscript must be located in the same folder as the firmware .puf file
64 +1*. Devices will reboot
65 +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**
66 +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
67 +1**. Attempt to run the .puf file separately without a load script
68 +1**. If you encounter devices that report as "UNDEFINED" model types, see our [[FAQ on this topic>>doc:FAQ.My ZUMNET-JBOX or ZUMLINK device reports as an UNDEFINED model type?.WebHome]]
69 +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
70 +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
71 +1*. If ZUMLINK-* devices have conflicting CIDs or are not online, then they will not update
72 +1. Perform any Zūm App specific configurations (such as occupancy sensor reach) at this time.
73 +1*. If using the App Mode Autoswitch function and you do not want to use the factory room logic, configure all the Zūm Rooms using the Zūm App
74 +1*. Note that some functions such as occupancy sensor timeouts can be done later through the SHOWRUNNER™ UI
75 +1. Run the "Convert to CNET Mode" or "Convert to CNET Mode + Autoswitch On" loadscript
76 +1*. These loadscripts connect to each ZUMNET-JBOX by their default hostname and put them into CNET Mode (optionally enables the Autoswitch function)
77 +1*. Devices will reboot
78 +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**
79 +1. Run the "IP Config (DHCP)" loadscript
80 +1*. This loadscript will update the device IP-IDs and hostnames
81 +1*. Devices will reboot
82 +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**
83 +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"]] starting with step 4. If not, proceed to the next step
84 +1. Connect to each ZUMNET-JBOX to identify and address ZUMLINK devices per the SRTakeoff
85 +1. Verify loads and start-up the job as an ordinary SHOWRUNNER start-up™
86 +1. Once done, save and back up the configuration file for your records
87 +
88 += Tools for Statically Configured Lighting Networks =
89 +
90 +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.
91 +
92 +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.
93 +
94 +The steps for statically configuring a networked Zūm Wired installation with SHOWRUNNER™ are:
95 +
96 +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"]]
97 +1. Use SHOWRUNNER™'s built in [[DHCP server>>doc:SHOWRUNNER™ Setup Guide.Troubleshooting Guide.Advanced Tools.DHCP Server.WebHome]]
98 +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
99 +1*. If arbitrary static IP addresses are acceptable, then use the default IP address range
100 +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
101 +1. Once the standard start-up procedure has been completed through step 14, [[export a new Device Summary>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Preparation.Toolbox Basics.WebHome||anchor="HExporttoDeviceSummary"]] file
102 +1. Change the Device Summary filetype to ".csv" and open in Microsoft Excel
103 +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]]
104 +1. Fill out these columns for each of the ZUMNET-JBOXs in the device summary
105 +1*. If there is no default gateway or DNS, use the processor's IP address instead
106 +1*. "IP-ID" column is optional
107 +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
108 +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
109 +1*. Up to 10 devices can be configured simultaneously
110 +1*. Devices will reboot once this script is run
111 +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**
112 +1. If desired, export a new Device Summary file as a record that this step was completed successfully
113 +1. If desired, disable the processor's DHCP service (the service will not resume if the processor reboots or the program restarts)
114 +1. Connect to each ZUMNET-JBOX to identify and address ZUMLINK devices per the SRTakeoff
115 +1. Verify loads and start-up the job as an ordinary SHOWRUNNER start-up™
116 +1. Once done, save and back up the configuration file for your records
72 72  )))
1680131811288-423.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +6.8 KB
Content