ZUM-HUB4 Processor Setup

//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.//

20

21

[[https:~~/~~/www.youtube.com/watch?v=H8CLZ7bp0eI>>url:https://www.youtube.com/watch?v=H8CLZ7bp0eI]]

22

23

=== IP Configuration ===

24

25

* Connect to the processor via USB and set the processor’s IP Address per your network requirements

26

** 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

27

*** 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

28

*** In the event that the processor does not allow you to log in with the chosen credentials (i.e. it repeatedly prompts for credentials)

29

**** Attempt to log in with username "crestron" and no password

30

**** Once logged into Text Console, run the following commands, replacing the "username" and "password" with your desired credentials

31

***** ##adduser -N:username -P:password##

32

***** ##addusertogroup -N:username -G:Administrators##

33

** 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(% style="color:darkgoldenrod" %)/24(%%)** subnet, with a processor IP address of (% style="color:blue" %)**10.0.0.10**(%%))

34

*** Disable DHCP: ##dhcp 0 off##

35

*** Set IP address: ##ipa 0 (% style="color:blue" %)**10.0.0.10**(%%)##

36

*** Set IP subnet mask: ##ipm 0 (% style="color:darkgoldenrod" %)**255.255.255.0**(%%)##

37

*** Set default gateway: ##defr 0 **10.0.0.1**##

38

*** Set hostname: ##host AP3-CPP##

39

*** Reboot the processor: ##reboot##

40

** It is also possible to configure a processor over Ethernet by using a DHCP server software on your laptop to assign an IP address

41

*** Configure your DHCP server software to assign IP addresses in the desired range

42

*** Once the processor is assigned an IP address, connect to it via Text Console at the assigned IP address

43

*** Run the above commands to disable DHCP and assign a static IP address to the processor

44

* For processors with a Control Subnet (CP3N/AV3/PRO3/CP4N/AV4/PRO4/ZUM-HUB4), additional setup is required

45

** Connect to the processor via Text Console and run the command: ##startprogafterrouter on##

46

*** 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.

47

** 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.

48

** 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.

49

** The Control Subnet can be configured manually in the "Functions>Ethernet Addressing...>Control Subnet" menu of Toolbox

50

*** Set routing to "Manual" with the start address and subnet size

51

*** 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

52

** The Control Subnet can also be configured to e.g. **10.0.0.0/24** using Text Console command: ##csrouterprefix **10.0.0.0/24**##

53

* If the job has multiple processors, then these steps must be repeated for all processors on the job

54

** For jobs with Central Control, the IP addresses of the processors matters

55

** 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

56

** 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

=== Program Load ===

* Download the latest build of SHOWRUNNER™ from the[[ Chief Integrations Portal>>https://files.chiefintegrations.com/index.php/s/WHNzXrrZbB5jC3E]]

61

* 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

62

** While it is possible to load the program via USB, it is not recommended because the transfer speed is significantly slower than loading via Ethernet

63

* Double click the PUF to open the Package Update Tool and install SHOWRUNNER™ (works best with Toolbox closed)

64

** The Package Update Tool will automatically open your Address Book and prompt you to select a device

65

*** If you have not created an Address Book for this job, close the Address Book window and press the pencil icon

66

*** Type in the IP address of your processor and click "OK"

67

** Double check that the correct PUF file is listed under the "Package Info" section and that the correct IP address is listed under "Target"

68

** Press the "Recheck" button

69

** Make sure that all three tasks are selected ("Load ShowRunner Program", "Update Crestron App", and "Update XPanel")

70

** Press the "Update" button to begin loading SHOWRUNNER™

71

* Sometimes the PUF tool will falsely report a failure to load the program

72

** Connect to the processor via Text Console

73

** Run the command ##sr ver##

74

** If the console returns with the newly installed version of SHOWRUNNER™, then the installation was successful

75

** If the console returns with "Bad or Incomplete Command (sr)" then the installation was not successful

76

*** Rename the .puf file to be a .zip file and open the archive

77

**** Some file archivers (such as 7-Zip) allow you to right click on the PUF file and open the archive without changing the filetype

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.

84

** **3-Series processors require authentication enabled** (SSL self can be used but steps will need to be repeated)

85

** If stuck on "Connecting to Processor" you will need to accept the certificate

86

* For jobs with multiple processors, SHOWRUNNER™ will need to be loaded to each processor

87

88

=== License and Configuration Deployment ===

89

90

* Download the SrConfig.json or CiLightingConfig.json configuration file from the link provided by Chief Integrations

91

* Obtain and download the license from [[https:~~/~~/portal.chiefintegrations.com>>url:https://portal.chiefintegrations.com]]

92

** Processors with a Control Subnet should use the LAN MAC address, **not** the Control Subnet MAC address

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

117

***** Select “Upload”

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

131

132

=== Set System Time ===

133

134

It is important for the device clock to be accurate in order for scheduled events to trigger at the appropriate time. If Toolbox is still open, this can be done easily:

135

136

* Connect to the processor via Text Console

137

* At the top of the Toolbox window, navigate to Functions>System Clock...

138

* If your computer is in the correct timezone, click Synchronize Device Time with PC

139

** The Timezone and Device Time should synchronize automatically

140

** If your PC is in the incorrect Timezone or the time did not synchronize properly, then manually adjust the Time, Date, and Timezone

141

* Press the Apply button

142

143

Note that the Location given in the System Clock... menu of Toolbox is not used by SHOWRUNNER™. Instead, the location used for sunrise/sunset calculations is stored in the configuration and will typically be set by Chief Integrations prior to delivery of the configuration. Both the location and time can be viewed and edited using the SHOWRUNNER™ UI

144

145

* SHOWRUNNER™ XPanel UI:

146

** Navigate to Settings>Location and System Clock

147

** Press the Lock icon to enable editing

148

** Adjust the time, timezone, and location as necessary

149

** Press Set System Clock to save the changes

150