Wiki source code of Installation Guide

Version 13.1 by Mark Kohlmann on 2022/04/15 15:24

Hide last authors
Mark Kohlmann 9.1 1 (% class="box warningmessage" %)
2 (((
3 showrunner is tested against current Crestron firmware releases.  Please use at least the recommended firmware builds.
4 3-Series: PUF 1.8001.0146
Mark Kohlmann 11.1 5 4-Series: PUF 2.7000.00052.01
Mark Kohlmann 9.1 6 VC-4: 2.7000.00047
7 )))
8
Mark Kohlmann 13.1 9 (% class="box infomessage" id="HNotes" %)
10 (((
11 Notes
Mark Kohlmann 1.1 12 Static IP or properly setup DHCP/DNS implementation required.
13 Auto-Assigned/Link-Local IP address range of 169.254.x.x not supported (Crestron xPanel issue)
Mark Kohlmann 13.1 14 )))
Mark Kohlmann 1.1 15
16 **ShowRunner Installation Tutorial:**
17
18 [[https:~~/~~/www.youtube.com/watch?v=xuJ94cMCCa8>>url:https://www.youtube.com/watch?v=xuJ94cMCCa8]]
19
20 **Licensing tutorial:**
21
Mark Kohlmann 2.1 22 //Note: Please use Chrome or Firefox to download the License from [[https:~~/~~/portal.chiefintegrations.com>>https://portal.chiefintegrations.com]].  Edge and Internet Explorer do not work properly.//
23
Mark Kohlmann 1.1 24 [[https:~~/~~/www.youtube.com/watch?v=H8CLZ7bp0eI>>url:https://www.youtube.com/watch?v=H8CLZ7bp0eI]]
25
26 === Processor Setup and Program Load (Per Processor) ===
27
28 * Obtain the latest build of ShowRunner [[https:~~/~~/files.chiefintegrations.com/s/WHNzXrrZbB5jC3E>>url:https://files.chiefintegrations.com/s/WHNzXrrZbB5jC3E]]
29 * Set the processor’s IP Address per your network requirements
Mark Kohlmann 12.1 30 * For processors with a Control Subnet (CP3N/AV3/PRO3/CP4N/AV4/PRO4/ZUM-HUB4): 
Alexander Mott 7.1 31 ** Connect to the processor via Text Console and type "startprogafterrouter on"
32 *** This will force the processor to wait until the router has started before attempting to load the showrunner™ program, avoiding potential license validation issues after a power loss.
33 ** Networked lighting hardware should be landed on the Control Subnet
34 ** The processor acts as a DHCP server on the Control Subnet, with addresses that are determined automatically based on the LAN configuration
35 ** The Control Subnet can be configured manually in the "Functions>Ethernet Addressing...>Control Subnet" menu of Toolbox
36 *** Set routing to "Manual" with the start address and subnet size
37 *** 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
Mark Kohlmann 12.1 38 *** 100.64.0.0/10 is a recommended range as it is unlikely to be used on any corporate network.  Processor IP will be 100.64.0.1 and default gateway/DNS will be 100.64.0.2.  Console command is: ##csrouterprefix 100.64.0.0/10##
Mark Kohlmann 1.1 39 * Connect your computer to the same network as the processor. Make sure your computer’s IP settings are compatible with the lighting hardware.
40 * Double click the PUF to install ShowRunner (works best with Toolbox closed)
41 * Select the PUF file again if needed, connect to the processor using the pencil, and select Recheck (This verifies the need to install the program, the XPanel UI, and the Crestron App UI)
42 * Click Update when prompted to install ShowRunner
Scott Kohlmann 5.1 43 * After loading, you can connect to the UI by navigating to the processor’s IP.  
Scott Kohlmann 6.1 44 ** **3-Series processors require authentication enabled** (SSL self can be used but steps will need to be repeated).
Scott Kohlmann 5.1 45 ** If stuck on "Connecting to Processor" you will need to accept the certificate.
46 * Showrunner™ will be loaded but a configuration and license are still needed.  Please proceed with the next section.
Mark Kohlmann 1.1 47
48 === License and Configuration Deployment ===
49
50 * Download the configuration file from the link provided by Chief Integrations
51 * Obtain and download the license from [[https:~~/~~/portal.chiefintegrations.com>>url:https://portal.chiefintegrations.com]]
Alexander Mott 7.1 52 ** Processors with a Control Subnet should use the LAN MAC address, **not** the Control Subnet MAC address
Scott Kohlmann 5.1 53 * Navigate to the showrunner™ management page
54 * Login to the showrunnerHUB™
Scott Kohlmann 6.1 55 ** 4-Series processor: The login created by the processor will work
56 ** 3-Series processor: Using Toolbox Text Console - type "sradmin [username] [name] administrators [password]"  (not needed if processor authentication is setup)
Scott Kohlmann 5.1 57 * Click Setup then File Management
58 * [[image:MicrosoftTeams-image7c355557d0a3ae410e72498ee667de2df50226f3e3940c2df4b51bb7137e176b.png||height="240" width="250"]]
Mark Kohlmann 1.1 59 ** Under “Upload New License File”
Scott Kohlmann 5.1 60 *** Leave restart unchecked after transfer
Mark Kohlmann 1.1 61 *** Select “Choose File” find the license file you downloaded from the portal
62 *** Select “Upload”
Mark Kohlmann 8.1 63 ** Loading Configuration
64 *** From Configuration File
65 **** Under “Upload New Config File”
66 ***** Select “Choose File” and find the provided SrConfig.json for this processor from the project link that was sent at project delivery.
67 ***** Select “Upload”
68 ***** Alternatively, you can drop the License.lic using Toolbox’s File Manager or your SFTP client into the NVRAM/sr folder of the processor, the SrConfig.json into NVRAM/sr/default and perform “progreset” from the processor’s console
69 ***** The program will restart
70 *** From Backup
71 **** Select "Restore"
72 **** Select "Choose Backup" and find the "SRBackup.zip" of the backup you wish to restore
73 **** Enter the secret used to create the backup.  Showrunner will upload the file and verify the secret.
74 **** Select "Restart" to load the new configuration
Mark Kohlmann 1.1 75 * Wait about 45 seconds after loading the configuration for the program to restart completely
76
77 === TSW Setup (Per Panel) ===
78
Mark Kohlmann 12.1 79 * Set the TS/TSWs IP Address per your network requirements (If using a panel other than TSW-770 you will need the CI_ShowRunner-UI_v3.xx PUF)
Scott Kohlmann 5.1 80 * Connect the PUF (CI_ShowRunner_v3.xx) to the TSW to load the UI
Scott Kohlmann 6.1 81 ** Only add CI_ShowRunner-UI_v3.xx if using touch panel other than TSW-770.  
Mark Kohlmann 1.1 82 * When finished, connect to the TSW with Text Console and type “addm 10 x.x.x.x” to link the panel to the processor (where x.x.x.x is the processor’s IP or hostname [DHCP/DNS])
83 ** You can also edit the IP table from Toolbox or the touchpanel’s setup screen.  IP-IDs 10 and 11 are reserved for TSWs by default.  If you have more than 2 touchpanels the additional IP-IDs will be provided.
84
85 === GLPAC Setup ===
86
87 * When GLPACs are deployed Chief Integrations will provide a load script that loads and configures the GLPAC hardware.  The script includes Chief Integrations chosen IP addresses unless otherwise requested.
88 * Set the IP addresses on all GLPACs per your network requirements.  The script will need to be updated if IP Addresses are changed from Chief Integrations chosen IP Addresses.
89 * Using Toolbox -> Script Manager, select the Scripting dropdown or right click and select “Load Script”.  Find the text file provided.
Scott Kohlmann 6.1 90 * Provided the given IPs can be seen on the network, double or right clicking an entry will load the program and link the IP table, enabling control through showrunner™
Mark Kohlmann 1.1 91 * Say yes to the dialog warning the hardware does not match (if prompted), and yes to overwrite the IP table (if prompted)