Skip to Content

Changes for page Processor Setup

Last modified by Alexander Mott on 2024/12/02 19:04
From version 3.1
edited by Alexander Mott
on 2022/06/09 17:21
Change comment: There is no comment for this version
To version 7.1
edited by Alexander Mott
on 2022/06/09 21:41
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -23,55 +23,108 @@
23 23  
24 24  [[https:~~/~~/www.youtube.com/watch?v=H8CLZ7bp0eI>>url:https://www.youtube.com/watch?v=H8CLZ7bp0eI]]
25 25  
26 -=== IP Configuration and Program Load (Per Processor) ===
26 +=== IP Configuration ===
27 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
30 -* For processors with a Control Subnet (CP3N/AV3/PRO3/CP4N/AV4/PRO4/ZUM-HUB4): 
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
28 +* Connect to the processor via USB and set the processor’s IP Address per your network requirements
29 +** 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
30 +*** 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
31 +*** In the event that the processor does not allow you to log in with the chosen credentials (i.e. it repeatedly prompts for credentials)
32 +**** Attempt to log in with username "crestron" and no password
33 +**** Once logged into Text Console, run the following commands, replacing the "username" and "password" with your desired credentials
34 +***** ##adduser -N:username -P:password##
35 +***** ##addusertogroup -N:username -G:Administrators##
36 +** 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)
37 +*** Disable DHCP: ##dhcp 0 off##
38 +*** Set IP address: ##ipa 0 10.0.0.10##
39 +*** Set IP subnet mask: ##ipm 0 255.255.255.0##
40 +*** Set default gateway: ##defr 0 10.0.0.1##
41 +*** Set hostname: ##host AP3-CPP##
42 +** It is also possible to configure a processor over Ethernet by using a DHCP server software on your laptop to assign an IP address
43 +*** Configure your DHCP server software to assign IP addresses in the desired range
44 +*** Once the processor is assigned an IP address, connect to it via Text Console at the assigned IP address
45 +*** Run the above commands to disable DHCP and assign a static IP address to the processor
46 +* For processors with a Control Subnet (CP3N/AV3/PRO3/CP4N/AV4/PRO4/ZUM-HUB4), additional setup is required
47 +** Connect to the processor via Text Console and run the command: ##startprogafterrouter on##
48 +*** 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.
49 +** 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.
50 +** 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.
35 35  ** The Control Subnet can be configured manually in the "Functions>Ethernet Addressing...>Control Subnet" menu of Toolbox
36 36  *** Set routing to "Manual" with the start address and subnet size
37 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
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##
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
43 -* After loading, you can connect to the UI by navigating to the processor’s IP.  
54 +** The Control Subnet can also be configured using Text Console command: ##csrouterprefix 10.0.0.0/24##
55 +* If the job has multiple processors, then these steps must be repeated for all processors on the job
56 +** For jobs with Central Control, the IP addresses of the processors matters
57 +** Chief Integrations will provide an SRTakeoff.xlsx spreadsheet with an IP Table tab that lists the IP address for each processor. If these IP addresses must be changed during startup, then it will be necessary to also change the IP addresses in the Remote System Definition in the configuration file
58 +** See the[[ CoAP Setup Guide for details>>doc:SHOWRUNNER™ Integrations Guide.Integration Options.CoAP with Crestron S# Library and Modules.CoAP ShowRunner to ShowRunner Setup Instructions.WebHome]]
59 +
60 +=== Program Load ===
61 +
62 +* Download the latest build of SHOWRUNNER™ [[https:~~/~~/files.chiefintegrations.com/s/WHNzXrrZbB5jC3E>>url:https://files.chiefintegrations.com/s/WHNzXrrZbB5jC3E]]
63 +* 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.
64 +* Double click the PUF to open the Package Update Tool and install SHOWRUNNER™ (works best with Toolbox closed)
65 +** The Package Update Tool will automatically open your Address Book and prompt you to select a device
66 +*** If you have not created an Address Book for this job, close the Address Book window and press the pencil icon
67 +*** Type in the IP address of your processor and click "OK"
68 +** Double check that the correct PUF file is listed under the "Package Info" section and that the correct IP address is listed under "Target"
69 +** Press the "Recheck" button
70 +** Make sure that all three tasks are selected ("Load ShowRunner Program", "Update Crestron App", and "Update XPanel")
71 +** Press the "Update" button to begin loading SHOWRUNNER™
72 +* Sometimes the PUF tool will falsely report a failure to load the program
73 +** Connect to the processor via Text Console
74 +** Run the command ##sr ver##
75 +** If the console returns with the newly installed version of SHOWRUNNER™, then the installation was successful
76 +** If the console returns with "Bad or Incomplete Command (sr)" then the installation was not successful
77 +*** Right click on the PUF file and open the archive with your file archiver of choice (e.g. 7-Zip)
78 +*** Extract the "CI.Lighting.ShowRunner.cpz" file
79 +*** In Toolbox, connect to the processor via Text Console and click the lightning bolt icon and select "SIMPL Program..."
80 +*** Under the "Send" section, browse your PC and select the extracted .cpz file
81 +*** Click the "Send" button and click "Yes" to upload the program
82 +*** Once it is done loading, you should be able to run the ##sr ver## command and see the currently installed version of SHOWRUNNER™
83 +* 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.  
44 44  ** **3-Series processors require authentication enabled** (SSL self can be used but steps will need to be repeated).
45 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.
86 +* For jobs with multiple processors, SHOWRUNNER™ will need to be loaded to each processor.
47 47  
48 48  === License and Configuration Deployment ===
49 49  
50 -* Download the configuration file from the link provided by Chief Integrations
90 +* Download the SrConfig.json or CiLightingConfig.json configuration file from the link provided by Chief Integrations
51 51  * Obtain and download the license from [[https:~~/~~/portal.chiefintegrations.com>>url:https://portal.chiefintegrations.com]]
52 52  ** Processors with a Control Subnet should use the LAN MAC address, **not** the Control Subnet MAC address
53 -* Navigate to the showrunner™ management page
54 -* Login to the showrunnerHUB™
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)
57 -* Click Setup then File Management
58 -** [[image:MicrosoftTeams-image7c355557d0a3ae410e72498ee667de2df50226f3e3940c2df4b51bb7137e176b.png||height="240" width="250"]]
59 -** Under “Upload New License File”
60 -*** Leave restart unchecked after transfer
61 -*** Select “Choose File” find the license file you downloaded from the portal
62 -*** Select “Upload”
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.
93 +* The license and configuration can be loaded with Toolbox using Text Console and File Management, or through the showrunnerHUB™ web interface
94 +** Using Toolbox:
95 +*** Connect to the processor via Text Console and via File Management
96 +*** In File management, navigate to the "NVRAM>sr" folder from the left-hand menu
97 +*** Right-click on the right-hand side and select "Copy File(s) From..." and select the downloaded License.lic file
98 +**** Alternatively, drag and drop the file from your computer to the File Management tool
99 +*** Using the left-hand menu, navigate to the "NVRAM>sr>default" folder
100 +*** Right-click on the right-hand side and select "Copy File(s) From..." and select the downloaded SrConfig.json file
101 +**** Alternatively, drag and drop the file from your computer to the File Management tool
102 +**** If you downloaded a CiLightingConfig.json file, it must be renamed to "SrConfig.json"
103 +** Using the showrunnerHUB™ UI:
104 +*** Using Chrome or Firefox, navigate to the processor's IP address
105 +*** When prompted, input your credentials and log in
106 +**** 4-Series processor or 3-Series processor with authentication enabled: Log in using the same admin credentials used to connect to the processor
107 +**** 3-Series processor without authentication enabled: Connect to the processor via Text Console and run the following command, replacing the "username", "name" and "password" with your desired credentials.
108 +***** ##sradmin username "name" administrators password##
109 +***** The username and password should be one word each and are the credentials used to log in to the showrunnerHUB™
110 +***** The name can be multiple words as long as it is in quotes, and is simply a friendly name used to identify each user.
111 +*** Once logged in to the showrunnerHUB™ UI, you should be automatically redirected to the File Management page.
112 +**** If you are not automatically redirected, then you can navigate to this page by clicking "Setup" in the top right and then selecting "File Management" from the list on the left
113 +**** [[image:1654807593390-193.png]]
114 +**** Under “Upload New License File”
115 +***** Leave "Restart after transfer" unchecked
116 +***** Select “Choose File” and browse for the license file you downloaded from the portal
67 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
75 -** Wait about 45 seconds after loading the configuration for the program to restart completely(((
76 -
77 -)))
118 +**** Load the configuration file either directly (if you have an SrConfig.json file) or from a backup (if you have an SRBackup.zip)
119 +***** Direct upload:
120 +****** Under “Upload New Config File”
121 +****** Select “Choose File” and find the provided CiLightingConfig.json or SrConfig.json file for this processor from the project link that was sent at project delivery.
122 +****** Select “Upload”
123 +***** From a Backup:
124 +****** Select "Restore"
125 +****** Select "Choose Backup" and find the SRBackup.zip of the backup you wish to restore
126 +****** Enter the secret used to create the backup. ShowRunner will upload the file and verify the secret.
127 +**** Once both the license and either a configuration file or backup have been loaded, click "Restart"
128 +**** Wait for the processor to finish restarting and then reload the page.
129 +***** 3-Series processors will take 45 to 90 restart
130 +***** 4-Series processors should restart considerably faster
1654807593390-193.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +35.2 KB
Content