Wiki source code of VC-4 Setup

Last modified by Alexander Mott on 2023/10/02 16:00
Show last authors
1 (% class="box errormessage" %)
2 (((
3 This page is for VC-4 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 ShowRunnerCLC™ on VC-4 requires version 4.000.0007 or newer of VC-4
9 )))
10
11 {{box cssClass="floatinginfobox" title="**CONTENTS**"}}
12 {{toc/}}
13 {{/box}}
14
15 **Licensing tutorial:**
16
17 //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.//
18
19 [[https:~~/~~/www.youtube.com/watch?v=H8CLZ7bp0eI>>url:https://www.youtube.com/watch?v=H8CLZ7bp0eI]]
20
21 Pre-Requisites
22
23 * VC-4 must have an SSL certificate
24
25 = Program Install =
26
27 * Download //CI_ShowRunner_vx.xx.cpz// and //Redirect.zip// from the VC-4 folder on the ShowRunnerCLC™ releases site
28 * Connect to the VC-4 server [[https:~~/~~/(Your_VC-4_IPAddress)/VirtualControl/config/settings/>>https://(Your_VC-4_IPAddress)/VirtualControl/config/settings/]]
29 * Load the Program
30 ** Go to the //Settings// tab
31 ** Go to the //Program Library// section
32 ** Add Program button
33 *** Step 1 of 2
34 **** Name: showrunner
35 **** Program File: Select ShowRunnerLoadHelper.cpz
36 [[image:1663089906147-492.png||height="261" width="414"]]
37 **** Hit //Next >//
38 *** Step 2 of 2
39 **** Configuration Pages: Select Redirect.zip
40 [[image:1663090552845-124.png||height="326" width="404"]]
41 * Navigate to the "Device Info" section under the "Status Tab"
42 ** Record the serial number and MAC address
43 * Create a new room and load the ShowRunner™ License as the User File for the room
44 ** ShowRunner™ license requires the Room ID and Room Name, as well as the MAC address
45 ** Room ID is always one word, all caps and is case-sensitive for the license
46
47 == Program Updates ==
48
49 To update an existing ShowRunner™ program on VC-4:
50
51 * Download //CI_ShowRunner_vx.xx.cpz// and //Redirect.zip// from the VC-4 folder on the ShowRunnerCLC™ releases site
52 * Connect to the VC-4 server [[https:~~/~~/(Your_VC-4_IPAddress)/VirtualControl/config/settings/>>https://(Your_VC-4_IPAddress)/VirtualControl/config/settings/]]
53 * Load the Program
54 ** Go to the //Settings// tab
55 ** Go to the //Program Library// section
56 ** Click the pencil icon for the existing program associated with your ShowRunner™ Room
57 ** Click the blue "+Choose" icon, under the "Program" section and select the new ShowRunnerLoadHelper.cpz file
58 ** Once the new file is selected, click the "Update" button
59 ** Choose "Yes" when prompted to automatically restart rooms associated with the program, or select "No" and manually restart the room(s) later.
60
61 = Accessing the ShowRunner™ Console =
62
63 To access the ShowRunner™ console, connect to the VC-4 with PuTTY or another text console, log in to Linux, and then run the command ##telnet 127.0.0.1 50001##
64
65 This command will open a telnet session with the ShowRunner™ program running on the VC-4, enabling the use of typical "sr" commands. To leave the ShowRunner™ console and close the telnet application, press the escape character '^]' ('ctrl+]'), type "quit", and then press enter.
66
67 The ShowRunner™ console can be used track normal Crestron console messages to the /var/log/messages log by setting up a VC-4 API token and registering it in ShowRunner™. To do this, navigate to the VC-4 configuration page, navigate to the "Settings" tab and open the "Tokens" section. Click "Add Token" and name it "showrunner". Copy the token to your clipboard and then go into the ShowRunner™ console. Run the command "##sradmin set vc4 api token [paste the api token]##" and then run the command "##sradmin restart##"
68
69 By running the command "##sudo tail -f /var/log/messages##", the Linux console will start tracking messages that you would normally see if you connected to an ordinary processor via Text Console.
70
71 = Accessing the ShowRunner™ UIs =
72
73 == ShowRunnerHUB™ Web UI ==
74
75 The ShowRunner™ configuration should be uploaded to the processor using the ShowRunnerHUB™ Web UI. To access the ShowRunnerHUB™ Web UI, it is necessary to navigate to the following URL:
76
77 * https:~/~/**vc-4ip**/VirtualControl/Rooms/**ROOMID**/cws/showrunner/app/
78 * Bold portions should be modified with your specific IP and Room ID [the Room ID is case sensitive]
79 * **DO NOT OMIT THE LAST "/"**
80
81 Prior to logging in to the ShowRunnerHUB™ Web UI, it is necessary to create a ShowRunner™ user. Open the ShowRunner™ console as described above and run the following command:
82
83 * ##sradmin add user **username** "**name**" Administrators **password**##
84 * Replace the bolded username, name, and password portions with the your desired credentials
85 * The username and password should be one word each and are the credentials used to log in to the ShowRunnerHUB™ Web UI
86 * The name can be multiple words as long as it is in quotes, and is simply a friendly name used to identify each user
87
88 == ShowRunner™ XPanel UI ==
89
90 VC-4 Currently does not serve the XPanel over the webserver, so it is not possible to launch the XPanel interface from the ShowRunnerHUB™ Web UI. To access the XPanel:
91
92 * Extract the CI_ShowRunner_TSW-770.vtz file from the CI_ShowRunner_v3.x.puf file used to install ShowRunnerCLC™
93 ** Some applications such as 7-Zip are able to open .puf files directly using the right-click context menu to open the archive
94 ** If you do not have these programs installed, then it is necessary to change the file type from .puf to .zip so that Windows will recognize it as an archive and allow you to extract files from it
95 ** Computers with lower resolutions may find it easier to use the TSW-760 UI instead of
96 * Launch the .vtz file using Crestron XPanel
97 * Select Options>Host Settings and fill out the fields with the required information:
98 ** VC-4 IP address
99 ** XPanel IP-ID (default 12, but editable in the config)
100 ** Port 41796
101 ** Check the box for SSL
102 ** Room ID
103 * Once all fields have been filled out, click "Open"
104 * If authentication is enabled, you will also be prompted to enter a username and password

Navigation