Last modified by Alexander Mott on 2023/12/13 19:15
From version 29.1
edited by Alexander Mott
on 2023/03/29 23:17
Change comment: Deleted image "1680131725203-239.png"
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
... ... @@ -24,6 +24,11 @@
24 24  (% class="box warningmessage" %)
25 25  (((
26 26  steps subject to change pending finalization of chief zum wired loadscript tool
27 +
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)
30 +
31 +(also intend to have check boxes to select which scripts are desired)
27 27  )))
28 28  
29 29  The steps for configuring a networked Zūm Wired installation with SHOWRUNNER™ are:
... ... @@ -40,47 +40,46 @@
40 40  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]]
41 41  1. Add columns for hostname ("Host", J) and IP-ID ("IP-ID", K) as shown below[[image:1680131811288-423.png]]
42 42  1. Fill out these columns for each of the ZUMNET-JBOXs in the device summary
43 -1*. If there is no default gateway or DNS, use the processor's IP address instead
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"]]
44 44  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
45 45  
46 -* use crestron toolbox device discovery to create a [[Device Summary>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Preparation.Toolbox Basics.WebHome||anchor="HDeviceDiscoveryTool"]]
47 -* use chief tools tm tool to generate various zum wired load scripts
48 -** (need to determine exact process for this; will need to add IP-ID and new hostname to device summary somehow)
49 -** (will likely generate two versions of the loadscripts; one connecting by default hostname and one connecting by new hostname)
50 -** (intend to require SR license for zwired LS generator, if only to get the proc mac address)
51 -* 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
52 -** devices will reboot
53 -** per crestron, 1.0006.00012 and newer ship in primary mode (**tbd if they will ship in app mode?**)
54 -* connect to a few devices in device discovery tool to ensure that all zumlink devices were automatically readdressed and there are no conflicting cids
55 -** firmware 1.0001.00081 is new enough that this works correctly
56 -* run "fw update (def. hostname)" loadscript to update the fw for all devices
57 -** will take up to several minutes per room, but will be able to do up to 10 rooms simultaneously
58 -** devices will reboot, possibly multiple times
59 -** 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)
60 -* run device discovery again to confirm that all zumnet boxes were updated
61 -** 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
62 -* if app mode backup is desired, configure the boxes using the app now
63 -* run "ip config (def. hostname)" loadscript to update device IP-IDs and hostnames
64 -** devices will reboot
65 -** devices will now have new hostnames, so any further loadscripts should use (new hostname) versions
66 -* run "cnet mode (def. hostname)" loadscript to put devices into CNET mode
67 -** if app mode backup is desired, also run "autoswitch enable (def. hostname)" loadscript
68 -** devices will reboot
69 -* if using a processor without control subnet, run the "static ip config (new hostname)" script
70 -** 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
71 -** (**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**)
72 -* once done, commission job essentially as normal showrunner job
73 -** (**sr commissioning guide is incomplete**)
74 -** connect to each zumnet jbox and address zumlink devices per the takeoff
75 -*** if devices are not online, then troubleshoot why and update firmware through device tree view once they are online
76 -** occ timeouts can be adjusted through UI; other settings (ie reach) should be adjusted through app
77 -** photocells etc are set up through UI
78 -** loads teseted and verified through UI; can be moved around between controllers as necessary
79 -*** loads don't need to be in the same room as the zumnet that controls them
80 -** keypads can use standard SR types or be fully customized
81 -** set up schedule, etc.
82 -* once done, save and back up configuration file
83 -
84 84  = Tools for Statically Configured Lighting Networks =
85 85  
86 86  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.
... ... @@ -94,17 +94,20 @@
94 94  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
95 95  1*. If arbitrary static IP addresses are acceptable, then use the default IP address range
96 96  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
97 -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
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
98 98  1. Change the Device Summary filetype to ".csv" and open in Microsoft Excel
99 -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:1680131807403-927.png]]
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]]
100 100  1. Fill out these columns for each of the ZUMNET-JBOXs in the device summary
101 101  1*. If there is no default gateway or DNS, use the processor's IP address instead
102 102  1*. "IP-ID" column is optional
103 103  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
104 -1. Use the modified Device Summary file and Chief Integrations' Zūm Wired Loadscript Generator Tool to generate a loadscript that connects to devices by their hostname and sets their static IP settings
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
105 105  1*. Up to 10 devices can be configured simultaneously
106 106  1*. Devices will reboot once this script is run
107 -1. Verify that all devices report completing successfully in the Loadscript Manager tool
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**
108 108  1. If desired, export a new Device Summary file as a record that this step was completed successfully
109 109  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
110 110  )))