Wiki source code of Processor Setup

Version 5.1 by Alexander Mott on 2022/06/09 20:16

Show last authors
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
5 4-Series: PUF 2.7000.00052.01
6 VC-4: 2.7000.00047
7 )))
8
9 (% class="box infomessage" id="HNotes" %)
10 (((
11 Notes
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)
14 )))
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
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
24 [[https:~~/~~/www.youtube.com/watch?v=H8CLZ7bp0eI>>url:https://www.youtube.com/watch?v=H8CLZ7bp0eI]]
25
26 === IP Configuration 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 * Connect to the processor via USB and set the processor’s IP Address per your network requirements
30 ** When connecting to a 4-series processor or a 3-series processor with authentication enabled for the first time, it will prompt for the creation of an admin-level CWS user
31 *** 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
32 *** In the event that the processor does not allow you to log in with the chosen credentials (i.e. it repeatedly prompts for credentials)
33 **** Attempt to log in with username "crestron" and no password
34 **** Once logged into Text Console, run the following commands, replacing the "username" and "password" with your desired credentials
35 ***** ##adduser -N:username -P:password##
36 ***** ##addusertogroup -N:username -G:Administrators##
37 ** Once connected, open Text Console and run the following commands to configure the processor's IP settings (example is for a 10.0.0.0/24 subnet, with a processor IP address of 10.0.0.10)
38 *** Disable DHCP: ##dhcp 0 off##
39 *** Set IP address: ##ipa 0 10.0.0.10##
40 *** Set IP subnet mask: ##ipm 0 255.255.255.0##
41 *** Set default gateway: ##defr 0 10.0.0.1##
42 *** Set hostname: ##host AP3-CPP##
43 ** It is also possible to configure a processor over Ethernet by using a DHCP server software on your laptop to assign an IP address
44 *** Configure your DHCP server software to assign IP addresses in the desired range
45 *** Once the processor is assigned an IP address, connect to it via Text Console at the assigned IP address
46 *** Run the above commands to disable DHCP and assign a static IP address to the processor
47 * For processors with a Control Subnet (CP3N/AV3/PRO3/CP4N/AV4/PRO4/ZUM-HUB4), additional setup is required
48 ** Connect to the processor via Text Console and run the command: ##startprogafterrouter on##
49 *** This will force the processor to wait until the router has started before attempting to load the showrunner™ program, avoiding potential license validation issues if the processor boots up before the router.
50 ** The previously listed "ipa," "ipm," etc. commands will configure settings for the processor's LAN port, which should be connected to the building LAN or third party network.
51 ** Lighting control hardware (e.g. TSWs, DIN-CENCN-2s, etc.) should be connected to the Control Subnet port. The processor acts as a DHCP server on the Control Subnet, with addresses that are determined automatically based on the LAN configuration.
52 ** The Control Subnet can be configured manually in the "Functions>Ethernet Addressing...>Control Subnet" menu of Toolbox
53 *** Set routing to "Manual" with the start address and subnet size
54 *** 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
55 ** The Control Subnet can also be configured using Text Console command: ##csrouterprefix 10.0.0.0/24##
56 * 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.
57 * Double click the PUF to open the Package Update Tool and install SHOWRUNNER™ (works best with Toolbox closed)
58 ** The Package Update Tool will automatically open your Address Book
59 * 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)
60 * Click Update when prompted to install ShowRunner
61 * After loading, you can connect to the UI by navigating to the processor’s IP.  
62 ** **3-Series processors require authentication enabled** (SSL self can be used but steps will need to be repeated).
63 ** If stuck on "Connecting to Processor" you will need to accept the certificate.
64 * Showrunner™ will be loaded but a configuration and license are still needed.  Please proceed with the next section.
65
66 === License and Configuration Deployment ===
67
68 * Download the configuration file from the link provided by Chief Integrations
69 * Obtain and download the license from [[https:~~/~~/portal.chiefintegrations.com>>url:https://portal.chiefintegrations.com]]
70 ** Processors with a Control Subnet should use the LAN MAC address, **not** the Control Subnet MAC address
71 * Navigate to the showrunner™ management page
72 * Login to the showrunnerHUB™
73 ** 4-Series processor: The login created by the processor will work
74 ** 3-Series processor: Using Toolbox Text Console - type "sradmin [username] [name] administrators [password]"  (not needed if processor authentication is setup)
75 * Click Setup then File Management
76 ** [[image:MicrosoftTeams-image7c355557d0a3ae410e72498ee667de2df50226f3e3940c2df4b51bb7137e176b.png||height="240" width="250"]]
77 ** Under “Upload New License File”
78 *** Leave restart unchecked after transfer
79 *** Select “Choose File” find the license file you downloaded from the portal
80 *** Select “Upload”
81 ** Loading Configuration
82 *** From Configuration File
83 **** Under “Upload New Config File”
84 ***** Select “Choose File” and find the provided SrConfig.json for this processor from the project link that was sent at project delivery.
85 ***** Select “Upload”
86 ***** 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
87 ***** The program will restart
88 *** From Backup
89 **** Select "Restore"
90 **** Select "Choose Backup" and find the "SRBackup.zip" of the backup you wish to restore
91 **** Enter the secret used to create the backup.  Showrunner will upload the file and verify the secret.
92 **** Select "Restart" to load the new configuration
93 ** Wait about 45 seconds after loading the configuration for the program to restart completely(((
94
95 )))