Wiki source code of Accessing the XPanel

Version 11.3 by Alexander Mott on 2021/01/13 19:08

version	line-number	content
2.1	1	= Overview =
	2
5.2	3	Prior to 2021, it has been possible to access the ShowRunner XPanel (a virtual touch panel interface) by connecting a laptop or computer to the lighting network and navigating to [[http:~~/~~/(ProcessorIpAddress)/Core3XPanel.html>>url:http://ProcessorIpAddress/Core3XPanel.html]] from a Flash-enabled Web browser (where "(ProcessorIpAddress)" is replaced with the processor's IP Address).
2.1	4
5.2	5	After December 2020, Flash will no longer function, meaning that it will no longer be possible to access the XPanel in this way. (Note, [[ShowRunner Reports and Management>>path:/get/SHOWRUNNER%E2%84%A2%20User%20Guide%20%26%20Wiki/User%20Guide/?sheet=CKEditor.ResourceDispatcher&outputSyntax=plain&language=en&type=doc&reference=SHOWRUNNER%E2%84%A2+User+Guide+%26+Wiki.Reports.WebHome&typed=true]] will still be available.) Instead, the XPanel must be accessed using an alternate method depending on which version of ShowRunner is currently running on the processor.
2.1	6
5.2	7	The UI for this XPanel is the same as the old web XPanel UI and the UI on any TSW touch panels. See the Chief Integrations [[ShowRunner UI Guide>>url:http://www.chiefintegrations.com/wp-content/uploads/2020/06/Showrunner-UI-2.178.pdf]] for more information on how to use this interface.
	8
	9	= Connect to the Lighting Network =
	10
	11	As with accessing the XPanel through a Web browser, it is necessary to be connected to the lighting network. The method used and required IP settings for the computer will vary by location, however if it was possible to access the XPanel through a Web browser before, then it will be possible to access the XPanel using one of the methods described below.
	12
3.1	13	= Accessing the XPanel =
2.1	14
5.2	15	=== ShowRunner Installations v2.201 and Newer ===
	16
	17	(% class="wikigeneratedid" id="HConnecttotheLightingNetwork" %)
	18	ShowRunner v2.201 was released December 17, 2020 and now includes a landing page when accessing the processor through a Web browser.
	19
11.2	20	1. (((
	21	Navigate to [[http:~~/~~/(ProcessorIpAddress)/index.html>>http://ProcessorIpAddress/index.html]] in a Web browser (Chrome or FireFox recommended)
	22	)))
	23	1. (((
	24	Click the "Install" button to download the CrestronXPanelSetup installer
	25	)))
	26	1. (((
	27	Once the download is finished, run the downloaded .exe or .air file to install the Crestron XPanel application (the filetype downloaded depends on whether your machine is a Windows or Mac)
	28	)))
6.1	29	1. After the XPanel software is installed, the XPanel can be accessed by clicking the "Launch - User Interface" button
	30
5.2	31	(% class="wikigeneratedid" %)
6.1	32	Steps 2 and 3 above only need to be performed the first time the XPanel is accessed from a computer through the ShowRunner landing page. Subsequent attempts to access the XPanel can be done by simply navigating to the ShowRunner landing page and clicking the "Launch - User Interface" button.
5.2	33
6.1	34	(% class="wikigeneratedid" %)
	35	The ShowRunner landing page also allows easy access to ShowRunner Reports and Management page by clicking the "Launch - ShowRunner Reporting and File Management" button.
5.2	36
6.1	37	=== ShowRunner Installations v2.200 and Older ===
	38
7.1	39	(% class="wikigeneratedid" %)
	40	Legacy installations of ShowRunner do not have the new ShowRunner landing page, and thus the XPanel installer will need to be downloaded and installed separately. Additionally, a .vtz file matching the version of ShowRunner that is installed will need to be extracted from the ShowRunner .puf file.
	41
3.1	42	===== Download the XPanel Installer =====
2.1	43
9.1	44	In order to open the .vtz file and access the XPanel, it is necessary to use the Crestron XPanel Installer.
2.1	45
9.1	46	Mac: [[https:~~/~~/www.crestron.com/MacOsXPanelDesktopInstaller>>https://www.crestron.com/MacOsXPanelDesktopInstaller]]
	47
	48	Windows: [[https:~~/~~/www.crestron.com/WindowsXPanelDesktopInstaller>>https://www.crestron.com/WindowsXPanelDesktopInstaller]]
	49
3.1	50	===== Acquire the .vtz File =====
2.1	51
3.1	52	If Chief Integrations does the on-site commissioning a job, we will provide a direct download link to the correct version of the .vtz file necessary to access the XPanel. Otherwise, it is necessary to extract the necessary .vtz file from the ShowRunner .puf file.
2.1	53
3.1	54	1. Log-in to the [[CI Customer Portal>>url:https://portal.chiefintegrations.com/]]
	55	1. Follow the link to the ShowRunner downloads page
	56	1. Download the version of ShowRunner that corresponds to the version running on the processor
	57	1*. Only the latest ShowRunner .puf is shown on this page. Older versions of ShowRunner are available in the Archives folder.
8.1	58	1. Once downloaded, use a file archiver such as winzip, winrar, or 7zip to open the CI_ShowRunner_v(X.XXX).puf file (change the .puf extension to .zip)
3.1	59	1. Once the .puf archive is opened, copy or extract the CI_ShowRunner_TSW-760.vtz file
2.1	60
3.1	61	===== Open the .vtz File =====
2.1	62
3.1	63	1. Open the CI_ShowRunner_TSW-760.vtz using the Crestron XPanel installer.
	64	1*. On Windows, this is accomplished by right-clicking the .vtz file, selecting "Open with...", and then selecting "CrestronXPanel installer.exe" from the list of programs.
	65	1. Once open, navigate to Options>Host Settings
	66	1. Under "Hostname/IP Address:" input the IP address for the lighting control processor
	67	1. Under "Port:" input 41794
	68	1. Under "IPID:" input 12
	69	1. Once these settings have been input, press Connect
	70
5.2	71	If all of these steps have been followed correctly, the flashing "CNX Connection Disconnected" error will disappear and the XPanel will be functioning.