Changes for page VC-4 Setup

Last modified by Alexander Mott on 2024/10/24 15:00
From version 18.1
edited by Alexander Mott
on 2023/05/15 21:42
Change comment: There is no comment for this version
To version 25.1
edited by Alexander Mott
on 2024/10/24 15:00
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -5,7 +5,7 @@
5 5  
6 6  (% class="box warningmessage" %)
7 7  (((
8 -ShowRunnerCLC™ on VC-4 requires version 4.000.0007 of VC-4
8 +ShowRunnerCLC™ on VC-4 requires version 4.000.0007 or newer of VC-4
9 9  )))
10 10  
11 11  {{box cssClass="floatinginfobox" title="**CONTENTS**"}}
... ... @@ -12,8 +12,6 @@
12 12  {{toc/}}
13 13  {{/box}}
14 14  
15 -(% class="row" %)
16 -(((
17 17  **Licensing tutorial:**
18 18  
19 19  //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.//
... ... @@ -46,6 +46,21 @@
46 46  ** ShowRunner™ license requires the Room ID and Room Name, as well as the MAC address
47 47  ** Room ID is always one word, all caps and is case-sensitive for the license
48 48  
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 +*** If the XPanel UI has been updated between the
59 +** Once the new file is selected, click the "Update" button
60 +** Choose "Yes" when prompted to automatically restart rooms associated with the program, or select "No" and manually restart the room(s) later.
61 +
49 49  = Accessing the ShowRunner™ Console =
50 50  
51 51  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##
... ... @@ -52,14 +52,41 @@
52 52  
53 53  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.
54 54  
55 -= Accessing the ShowRunnerHUB™ Web UI =
68 +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##"
56 56  
57 -The ShowRunner™ configuration should be uploaded to the processor using the ShowRunnerHUB™ web UI. It is not possible to access the ShowRunnerHUB™ web UI by directly navigating to the IP address of the VC-4 server, instead it is necessary to navigate to the following URL: https:~/~/**vc-4ip**/VirtualControl/Rooms/**ROOMID**/cws/showrunner/app/ (Bold portions should be modified with your specific IP and Room ID, **DO NOT OMIT THE LAST "/"**)
70 +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.
58 58  
59 -Prior to logging in to the ShowRunnerHUB™ UI, it is necessary to create a ShowRunner™ user. Open the ShowRunner™ console as described above and run the following command, replacing the "username", "name" and "password" with your desired credentials: ##sradmin add user **username** "**name**" Administrators **password**##
72 += Accessing the ShowRunner™ UIs =
60 60  
61 -The username and password should be one word each and will be the credentials used to log in to the ShowRunnerHUB™ UI. The name can be multiple words as long as it is in quotes, and is simply a friendly name used to identify each user.
74 +== ShowRunnerHUB™ Web UI ==
62 62  
63 -VC-4 Currently does NOT serve the XPANEL:
64 -The XPanel does not launch from the ShowRunnerHUB webpage. To access the XPanel, extract the VTZ file from the ShowRunnerCLC™ puf file and launch. Select Options>Host Settings and input the Host IP, IPID, Port 41794, check SSL, enter the Room ID, and Open. Type in the username and password (if applicable) and wait for the XPanel to connect.
65 -)))
76 +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:
77 +
78 +* https:~/~/**vc-4ip**/VirtualControl/Rooms/**ROOMID**/cws/showrunner/app/
79 +* Bold portions should be modified with your specific IP and Room ID [the Room ID is case sensitive]
80 +* **DO NOT OMIT THE LAST "/"**
81 +
82 +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:
83 +
84 +* ##sradmin add user **username** "**name**" Administrators **password**##
85 +* Replace the bolded username, name, and password portions with the your desired credentials
86 +* The username and password should be one word each and are the credentials used to log in to the ShowRunnerHUB™ Web UI
87 +* The name can be multiple words as long as it is in quotes, and is simply a friendly name used to identify each user
88 +
89 +== ShowRunner™ XPanel UI ==
90 +
91 +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:
92 +
93 +* Extract the CI_ShowRunner_TSW-770.vtz file from the CI_ShowRunner_v3.x.puf file used to install ShowRunnerCLC™
94 +** Some applications such as 7-Zip are able to open .puf files directly using the right-click context menu to open the archive
95 +** 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
96 +** Computers with lower resolutions may find it easier to use the TSW-760 UI instead of
97 +* Launch the .vtz file using Crestron XPanel
98 +* Select Options>Host Settings and fill out the fields with the required information:
99 +** VC-4 IP address
100 +** XPanel IP-ID (default 12, but editable in the config)
101 +** Port 41796
102 +** Check the box for SSL
103 +** Room ID
104 +* Once all fields have been filled out, click "Open"
105 +* If authentication is enabled, you will also be prompted to enter a username and password