Skip to Content

Changes for page Processor Setup

Last modified by Alexander Mott on 2024/12/02 19:04
From version 40.1
edited by Alexander Mott
on 2023/05/12 20:01
Change comment: There is no comment for this version
To version 56.1
edited by Alexander Mott
on 2024/12/02 19:04
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,28 +1,28 @@
1 -(% class="box errormessage" %)
2 -(((
1 +{{info}}
3 3  This page is for typical processor setup; for ZUM-HUB4 deployments, see our [[dedicated ZUM-HUB4 page>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.ZUM-HUB4 Processor Setup.WebHome]].
4 -)))
3 +{{/info}}
5 5  
6 -(% class="box warningmessage" %)
7 -(((
5 +{{error}}
6 +All 4-Series processors require authentication to be configured when first connecting: **the Crestron Agent or Field Tech are responsible for recording these credentials. Chief Integrations cannot provide assistance unless the credentials are known. The only way to connect to a device for which the credentials have been lost is to factory reset the device, which may require redoing the start-up from scratch if the latest configuration was not saved and backed up. **
7 +{{/error}}
8 +
9 +{{warning}}
8 8  ShowRunnerCLC™™ is tested against current Crestron firmware releases. **Please use at least the recommended firmware builds.**
9 9  
10 -* 3-Series: PUF 1.8001.0146
11 -* 4-Series: PUF 2.7000.00052.01
12 -* VC-4: 2.7000.00047
12 +* 3-Series: PUF 1.8001.0214
13 +* 4-Series: PUF 2.8003.00037.01
14 +* VC-4: 4.0003.00016
13 13  
14 14  **Notes:**
15 15  
16 16  * Static IP or properly setup DHCP/DNS implementation required.
17 17  * Auto-Assigned/Link-Local IP address range of 169.254.x.x not supported (Crestron xPanel issue)
18 -)))
20 +{{/warning}}
19 19  
20 20  {{box cssClass="floatinginfobox" title="**CONTENTS**"}}
21 21  {{toc/}}
22 22  {{/box}}
23 23  
24 -(% class="row" %)
25 -(((
26 26  **ShowRunnerCLC™ Installation Tutorial:**
27 27  
28 28  [[https:~~/~~/www.youtube.com/watch?v=xuJ94cMCCa8>>url:https://www.youtube.com/watch?v=xuJ94cMCCa8]]
... ... @@ -33,6 +33,20 @@
33 33  
34 34  [[https:~~/~~/www.youtube.com/watch?v=H8CLZ7bp0eI>>url:https://www.youtube.com/watch?v=H8CLZ7bp0eI]]
35 35  
36 += Error Broadcasting =
37 +
38 +The first thing that should be done after connecting to a processor is to open the Text Console and run the command: ##broadcast on##
39 +
40 +Running the ##broadcast on## command tells the processor to begin logging useful messages to the text console and error log. These messages typically begin with an indication of their severity:
41 +
42 +1. Error: Most errors indicate a major issue that should be investigated and remedied. Some errors will prevent the ShowRunner™ program from starting up or functioning as expected, and may be the result of a configuration issue (e.g. errors registering devices), a network issue (e.g. errors connecting to other devices), or authentication issues (e.g. errors related to connection attempts from clients not providing correct username/password information), among other possible causes.
43 +1. Warning: Warnings indicate issues that are less severe than errors and do not usually prevent the ShowRunner™ program from running, but may result in some unexpected behaviors.
44 +1. Notice: Notices are not a problem, and just give useful information during program startup (e.g. devices registered) and while the program is running (e.g. the times at which scheduled events are triggered)
45 +
46 +Running the ##err sys## command will print the most recent 500 messages to the console. Running the ##clear err## command will clear the log, which is sometimes useful to run  before doing a ##progreset## in order to troubleshoot configuration issues on startup.
47 +
48 +To view more than the last 500 messages, connect to the processor with the File Manager tool and navigate to the "Internal Storage > logs" folder. Logs since the last time the processor rebooted are stored in the "CurrentBoot" folder, with a new log started every time the current log reaches ~~1 MB in size. When the processor reboots, the logs in the "PreviousBoot" folder are zipped and moved to the "ZippedLogs" folder, logs in the "CurrentBoot" folder are moved to the "PreviousBoot" folder, and a new log is started in the "CurrentBoot" folder.
49 +
36 36  = IP Configuration =
37 37  
38 38  * Connect to the processor via USB and set the processor’s IP Address per your network requirements
... ... @@ -54,13 +54,17 @@
54 54  *** Configure your DHCP server software to assign IP addresses in the desired range
55 55  *** Once the processor is assigned an IP address, connect to it via Text Console at the assigned IP address
56 56  *** Run the above commands to disable DHCP and assign a static IP address to the processor
57 -* For processors with a Control Subnet (CP3N/AV3/PRO3/CP4N/AV4/PRO4), additional setup is required
71 +* For processors with a Control Subnet (CP3N/AV3/PRO3/CP4N/AV4/PRO4), there are some additional considerations and setup that must be performed: 
72 +** Never connect an external router to the Control Subnet, as doing so will cause the internal DHCP server to shut down.
58 58  ** Connect to the processor via Text Console and run the command: ##startprogafterrouter on##
59 59  *** This will force the processor to wait until the router has started before attempting to load the ShowRunnerCLC™ program, avoiding potential license validation issues if the processor boots up before the router.
75 +*** ShowRunnerCLC™ .puf versions 3.042 and newer automatically run this command when the "Configure Processor with Router" option is selected.
60 60  ** 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.
61 -** 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. 
62 -*** Lighting hardware can be connected via the LAN port, however for proper functionality you must run the command: ##securegateway default##
63 -** The Control Subnet will automatically configure itself based on the LAN configuration, but it can optionally be configured manually:
77 +** Lighting control hardware (e.g. TSWs, DIN-CENCN-2s, etc.) should be left in DHCP mode and connected to the Control Subnet port.
78 +*** The processor acts as a DHCP server on the Control Subnet, with addresses that are determined automatically based on the LAN configuration.
79 +*** If lighting hardware is to be connected via the LAN anyway, then you must run the command: ##securegateway default##
80 +*** Note: this setting enables unsecure connections to the processor from the LAN. This is necessary if ZUMNET-JBOXs or other non-secure Crestron devices (such as 3-Series EISC) will be connected via the LAN port of the processor
81 +** The Control Subnet will automatically configure itself based on the LAN configuration, but it should be configured manually if the processor is to be connected to building LAN as the default scheme may cause networking issues:
64 64  *** Using the "Functions>Ethernet Addressing...>Control Subnet" menu of Toolbox:
65 65  **** Set routing to "Manual" with the start address and subnet size
66 66  **** E.g., a setting of "100.64.0.0/20" will have the processor at 10.64.0.1 with an IP mask of 255.255.240.0 and a default gateway and DNS server at 100.64.0.2
... ... @@ -71,6 +71,7 @@
71 71  ** For jobs with Central Control, the IP addresses of the processors matters
72 72  ** 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
73 73  ** See the[[ CoAP Setup Guide>>doc:SHOWRUNNER™ Integrations Guide.Integration Options.CoAP with Crestron S# Library and Modules.CoAP ShowRunner to ShowRunner Setup Instructions.WebHome]] for details
92 +* At this point, it is a good idea to [[update the device firmware>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Updating Firmware.WebHome]]
74 74  
75 75  = Program Load =
76 76  
... ... @@ -84,6 +84,14 @@
84 84  ** Double check that the correct PUF file is listed under the "Package Info" section and that the correct IP address is listed under "Target"
85 85  ** Press the "Recheck" button
86 86  ** Make sure that all three tasks are selected ("Load ShowRunner Program", "Update Crestron App", and "Update XPanel")
106 +** Additional tasks are available for certain processors:
107 +*** ZUM-HUB4:
108 +**** "Configure ZUM-HUB4" will automatically run commands: ##cwsanticsrf OFF## and ##startprogafterrouter on##
109 +**** "Configure ZUM-HUB4 Subnet" will automatically reconfigure the control subnet to a 100.64.0.0/20 configuration to avoid potential conflicts with corporate networks
110 +***** **NOTE: If you are connected to the Control Subnet and select this option, you will need to reconnect to the processor and run the .puf again in order to finish loading ShowRunnerCLC™ as this option will interrupt your connection to the processor.**
111 +**** "Configure ZUM-HUB4 SecureGateway" will automatically run command: ##securegateway default##
112 +*** Processors with Routers (AV3, CP3N, PRO3, AV4, CP4N, and PRO4)
113 +**** "Configure Processor with Router" will automatically run command: ##startprogafterrouter on##
87 87  ** Press the "Update" button to begin loading ShowRunnerCLC™
88 88  * Sometimes the PUF tool will falsely report a failure to load the program
89 89  ** Connect to the processor via Text Console
... ... @@ -125,9 +125,9 @@
125 125  *** When prompted, input your credentials and log in
126 126  **** 4-Series processor or 3-Series processor with authentication enabled: Log in using the same admin credentials used to connect to the processor
127 127  **** 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.
128 -***** ##sradmin username "name" administrators password##
155 +***** ##sradmin add user **username **"**name**" Administrators **password**##
129 129  ***** The username and password should be one word each and are the credentials used to log in to the ShowRunnerHUB™
130 -***** The name can be multiple words as long as it is in quotes, and is simply a friendly name used to identify each user.
157 +***** The name can be multiple words as long as it is in quotes, and is simply a friendly name used to identify each user
131 131  *** Once logged in to the ShowRunnerHUB™ UI, you should be automatically redirected to the File Management page
132 132  **** 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
133 133  **** [[image:1654807593390-193.png]]
... ... @@ -148,6 +148,8 @@
148 148  **** Wait for the processor to finish restarting and then reload the page.
149 149  ***** 3-Series processors will take 45 to 90 seconds to restart, possibly longer depending on the size and complexity of the configuration
150 150  ***** 4-Series processors will restart considerably faster
178 +**** If licensed for SR-BNI, you will need to generate a [[free Crestron BACnet License>>https://www.crestron.com/Support/Tools/Licensing-Registration/Bacnet-License-Registration]]
179 +**** If licensed for SR-BNI50, you will need to generate a [[paid Crestron 50+ BACnet Point License>>https://www.crestron.com/Support/Tools/Licensing-Registration/Bacnet-License-Registration]]
151 151  
152 152  = Set System Time =
153 153  
... ... @@ -171,4 +171,3 @@
171 171  ** Navigate to Setup>System Settings>Location and System Clock
172 172  ** Adjust the time, timezone, and location as necessary
173 173  ** Click Apply to save the changes
174 -)))