ZUM-HUB4 Processor Setup

(% class="box errormessage" %)

(((

This page is for ZUM-HUB4 deployments. For other processors, see our [[normal processor setup page>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Processor Setup.WebHome]].

4

)))

5

6

(% class="box warningmessage" %)

7

(((

8

ZUM-HUB4 requires firmware version 2.005.0056 or greater for third party software to be loaded.

9

(Once installed, running the "##ver##" command should report a FW version of 2.7100.00016 or greater.)

10

)))

11

12

**ShowRunner Installation Tutorial:**

13

14

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

15

16

**Licensing tutorial:**

17

18

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

19

20

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

21

22

=== IP Configuration ===

23

24

* Connect to the ZUM-HUB4 via USB and create an admin-level CWS user

25

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

26

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

27

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

28

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

29

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

30

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

31

* Determine whether the lighting control hardware will be connected to the ZUM-HUB4's LAN port or the Control Subnet port:

32

** If the system is standalone (not integrated with building LAN), then lighting hardware can be connected to either the LAN port or the Control Subnet port:

33

*** If connecting lighting hardware to the LAN port, then you must configure the LAN as a static IP (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 HUB4-CPP##

39

**** Set secure gateway: ##securegateway default##

40

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

41

*** If connecting lighting hardware to the Control Subnet port, then you must configure the Control Subnet:

42

**** Using the "Functions>Ethernet Addressing...>Control Subnet" menu of Toolbox:

43

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

44

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

45

**** Using Text Console commands (example for a **10.0.0.0(% style="color:darkgoldenrod" %)/24(%%)** subnet, with a processor IP address of (% style="color:blue" %)**10.0.0.1**(%%))

46

***** Set CS IP: ##csrouterprefix **10.0.0.0/24**##

47

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

48

** If the system is intended to connect to the building LAN:

49

*** The building LAN must be connected to ZUM-HUB4's LAN port

50

*** The ZUM-HUB4's LAN IP settings should be configured per the building requirements

51

*** Any connected lighting hardware must either:

52

***1. Be on the building LAN

53

***1*. The ZUM-HUB4 LAN should be configured with a static IP

54

***1*. Building network must be configured to allow communication between ZUM-HUB4 and all lighting devices

55

***1. Be connected to the Control Subnet port

56

***1*. Control Subnet must be configured correctly (see above)

57

***1*. If lighting devices must be able to communicate with the building LAN, run the command: ##isolatenetworks off##

58

* Once IP settings are configured, there are additional commands that must be run:

59

** Force waiting to start program: ##startprografterrouter on##

60

** Disable CWS Anticsrf feature (case sensitive): ##cwsanticsrf OFF##

61

** Reboot the processor: ##reboot##

62

63

=== Crestron License and Program Load ===

64

65

* Verify that the installed firmware is new enough to allow for third party software to be installed on the processor:

66

** The ##ver## command should report firmware version 2.7100.00016 or greater

67

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

68

* 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

69

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

70

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

71

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

72

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

73

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

74

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

75

** Press the "Recheck" button

76

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

77

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

78

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

79

** Connect to the processor via Text Console

80

** Run the command ##sr ver##

81

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

82

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

83

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

84

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

85

*** Extract the "CI.Lighting.ShowRunner.cpz" file

86

*** In Toolbox, connect to the processor via Text Console and click the lightning bolt icon and select "SIMPL Program..."

87

*** Under the "Send" section, browse your PC and select the extracted .cpz file

88

*** Click the "Send" button and click "Yes" to upload the program

89

*** Once it is done loading, you should be able to run the ##sr ver## command and see the currently installed version of SHOWRUNNER™

90

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

91

92

=== License and Configuration Deployment ===

93

94

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

95

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

96

** When generating the license, use the LAN MAC address, **not** the Control Subnet MAC address

97

** If taking the MAC from the sticker on the ZUM-HUB4, the correct MAC is the one on the sticker that just says "MAC", not the sticker that says "MAC1"

98

* The license and configuration can be loaded with Toolbox using Text Console and File Management, or through the showrunnerHUB™ web interface

99

** Using Toolbox:

100

*** Connect to the processor via Text Console and via File Management

101

*** In File management, navigate to the "NVRAM>sr" folder from the left-hand menu

102

*** Right-click on the right-hand side and select "Copy File(s) From..." and select the downloaded License.lic file

103

**** Alternatively, drag and drop the file from your computer to the File Management tool

104

*** Using the left-hand menu, navigate to the "NVRAM>sr>default" folder

105

*** Right-click on the right-hand side and select "Copy File(s) From..." and select the downloaded SrConfig.json file

106

**** Alternatively, drag and drop the file from your computer to the File Management tool

107

**** If you downloaded a CiLightingConfig.json file, it must be renamed to "SrConfig.json"

108

** Using the showrunnerHUB™ UI:

109

*** Using Chrome or Firefox, navigate to the processor's IP address

110

*** When prompted, input your credentials and log in

111

**** 4-Series processor or 3-Series processor with authentication enabled: Log in using the same admin credentials used to connect to the processor

112

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

113

***** ##sradmin username "name" administrators password##

114

***** The username and password should be one word each and are the credentials used to log in to the showrunnerHUB™

115

***** The name can be multiple words as long as it is in quotes, and is simply a friendly name used to identify each user.

116

*** Once logged in to the showrunnerHUB™ UI, you should be automatically redirected to the File Management page

117

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

118

**** [[image:1654807593390-193.png]]

119

**** Under “Upload New License File”

120

***** Leave "Restart after transfer" unchecked

121

***** Select “Choose File” and browse for the license file you downloaded from the portal

122

***** Select “Upload”

123

**** Load the configuration file either directly (if you have an SrConfig.json file) or from a backup (if you have an SRBackup.zip)

124

***** Direct upload:

125

****** Under “Upload New Config File”

126

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

127

****** Select “Upload”

128

***** From a Backup:

129

****** Select "Restore"

130

****** Select "Choose Backup" and find the SRBackup.zip of the backup you wish to restore

131

****** Enter the secret used to create the backup. ShowRunner will upload the file and verify the secret.

132

**** Once both the license and either a configuration file or backup have been loaded, click "Restart"

133

**** Wait for the processor to finish restarting and then reload the page.

134

***** 3-Series processors will take 45 to 90 restart

135

***** 4-Series processors should restart considerably faster

136

137

=== Set System Time ===

138

139

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:

140

141

* Connect to the processor via Text Console

142

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

143

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

144

** The Timezone and Device Time should synchronize automatically

145

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

146

* Press the Apply button

147

148

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

149

150

* SHOWRUNNER™ XPanel UI:

151

** Navigate to Settings>Location and System Clock

152

** Press the Lock icon to enable editing

153

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

154

** Press Set System Clock to save the changes

155