ZUM-HUB4 Processor Setup

Licensing tutorial:

Note: Please use Chrome or Firefox to download the License from https://portal.chiefintegrations.com.  Edge and Internet Explorer do not work properly.

https://www.youtube.com/watch?v=H8CLZ7bp0eI

IP Configuration and Console Commands

• Connect to the ZUM-HUB4 via USB and create an admin-level CWS user
  • Input the desired username and password into the dialog box. Save this login information, as it is not possible to recover if it is lost or forgotten
  • In the event that the processor does not allow you to log in with the chosen credentials (i.e. it repeatedly prompts for credentials)
    • Attempt to log in with username "crestron" and no password
    • Once logged into Text Console, run the following commands, replacing the "username" and "password" with your desired credentials
      • adduser -N:username -P:password
      • addusertogroup -N:username -G:Administrators
• Determine whether the lighting control hardware will be connected to the ZUM-HUB4's LAN port or the Control Subnet port:
  • If the system is standalone (not integrated with building LAN), then lighting hardware can be connected to either the LAN port or the Control Subnet port:
    • If connecting lighting hardware to the LAN port, then you must configure the LAN as a static IP (example is for a 10.0.0.0/24 subnet, with a processor IP address of 10.0.0.10):
      • Disable DHCP: dhcp 0 off
      • Set IP address: ipa 0 10.0.0.10
      • Set IP subnet mask: ipm 0 255.255.255.0
      • Set default gateway: defr 0 10.0.0.1
      • Set hostname: host HUB4-CPP
      • Set secure gateway: securegateway default
      • Reboot the processor: reboot
    • If connecting lighting hardware to the Control Subnet port, then you must configure the Control Subnet:
      • Using the "Functions>Ethernet Addressing...>Control Subnet" menu of Toolbox:
        • Set routing to "Manual" with the start address and subnet size
        • E.g., a setting of "10.0.0.0/24" will have the processor at 10.0.0.1 with an IP mask of 255.255.255.0 and a default gateway and DNS server at 10.0.0.2
      • Using Text Console commands (example for a 10.0.0.0/24 subnet, with a processor IP address of 10.0.0.1)
        • Set CS IP: csrouterprefix 10.0.0.0/24
        • Reboot the processor: reboot
  • If the system is intended to connect to the building LAN:
    • The building LAN must be connected to ZUM-HUB4's LAN port
    • The ZUM-HUB4's LAN IP settings should be configured per the building requirements
    • Any connected lighting hardware must either:
      1. Be on the building LAN
         • The ZUM-HUB4 LAN should be configured with a static IP
         • Building network must be configured to allow communication between ZUM-HUB4 and all lighting devices 
      2. Be connected to the Control Subnet port
         • Control Subnet must be configured correctly (see above)
         • If lighting devices must be able to communicate with the building LAN, run the command: isolatenetworks off
• Once IP settings are configured, there are additional commands that must be run:
  • Disable CWS Anticsrf feature (case sensitive): cwsanticsrf OFF
  • Force waiting to start program: startprografterrouter on
  • Reboot the processor: reboot

Update NVRAM Folder Permissions

• Ensure that the NVRAM folder permissions are set correctly using a third party SFTP program:
  • FileZilla instructions:
    • Connect to the processor at port 22
    • Locate the "nvram" folder
    • Right click the folder and select "Change File Attributes"
    • Change "Numeric Value" to 777
    • Disconnect from the processor
  • WinSCP instructions:
    • Connect to the processor at port 22
    • Locate the "nvram" folder
    • Right click the folder and select "Properties"
    • Change "Octal Value" to 2777
    • Disconnect from the processor

Crestron License and SHOWRUNNER™ Program Load

• Connect your computer to the same network as the processor. Make sure your computer’s IP settings are compatible with the lighting network and do not conflict with any devices already on the network
• Connect to the ZUM-HUB4 in Crestron Toolbox
  • Run the "ver" and verify that the reported firmware is v2.7100.00016 or greater
  • Navigate to Functions>License Management...>Add License
  • Open Crestron's SW-HUB4-PROG licensing form in a web browser and generate the license key
    • The Customer Number and PO# must be provided by the Crestron Agent for the job
    • The Hostname and System Key can be viewed in Toolbox by navigating to Functions>License Management...>Add License
  • In Toolbox, paste the generated license key into the "License Key:" field of the Add License menu
  • Click the "Apply" button
• Download the latest build of SHOWRUNNER™ (v3.019 minimum) from the Chief Integrations Portal
  • Rename the downloaded .puf file to be a .zip file and open the archive
    • Some file archivers (such as 7-Zip) allow you to right click on the PUF file and open the archive without changing the filetype
  • Extract the "CI.Lighting.ShowRunner.cpz" file
  • In Toolbox, connect to the processor via Text Console, click the lightning bolt icon, and select "SIMPL Program..."
    • Alternatively, navigate to Functions>SIMPL Program (Program01)...
  • Under the "Send Program" section, browse your PC and select the extracted .cpz file
  • Click the "Send" button and click "Yes" to upload the program
  • Once it is done loading, you should be able to run the sr ver command and see the currently installed version of SHOWRUNNER™
• Once SHOWRUNNER™ is loaded, you can connect to the UI by navigating to the processor’s IP. A license and configuration file are still required.  

Configuration Deployment

Proceed with the SHOWRUNNER™ license and configuration deployment and setting the System Time as normal.