Wiki source code of TSW Touchpanel Setup

Version 32.1 by Alexander Mott on 2024/12/02 18:55

version	line-number	content
16.1	1	{{warning}}
17.1	2	TSW-xx70 firmware versions 2.001.0058 and above require a pingable gateway be specified in order to use static IP settings. If no default gateway is set, or the default gateway cannot be pinged, then odd network behavior and system instability may result. Pingability of a given address can be checked using the console command: ##ping [IP address]##
30.1	3
32.1	4	All TSW-xx70 touchscreens require authentication to be configured when first connecting: the Crestron Agent or Field Tech are responsible for recording these credentials. Chief Integrations cannot provide assistance unless the credentials are known. The only way to connect to a device for which the credentials have been lost is to factory reset the device.
16.1	5	{{/warning}}
	6
22.1	7	{{box cssClass="floatinginfobox" title="CONTENTS"}}
18.1	8	{{toc/}}
	9	{{/box}}
2.1	10
25.1	11	TSWs touchscreens allow end users and technicians access to the ShowRunnerCLC™ XPanel UI for both initial startup and daily use. Once the TSW has been configured and the ShowRunnerCLC™ project has been loaded to it, it is possible to restrict what features can be accessed without entering a PIN code by navigating to Settings>Security Settings on the TSW. If the User Passcode is enabled, then a PIN will be required to access any of the touchscreen's UI. If the Setup Passcode is enabled, then the main Area Overview menu will be accessible, but anything in the Settings menu and beyond will require a PIN.
2.1	12
25.1	13	For TSWs, their IP address does not matter as long as it is in the same range as the processor and does not conflict with any other devices on the network. Instead, TSWs are identified to the processor via their IP-ID. Each ShowRunnerCLC™ job ships by default with two touchscreens in the configuration, at IP-IDs 10 and 11. If a job has more than two touchscreens, then additional touchscreens will be added to the configuration, typically starting at IP-ID 14. Refer to the IP Table sheet in the provided SRTakeoff.xlsx spreadsheet, or run the ##ipt -t ##command from the processor after the configuration is loaded if no spreadsheet was provided.
2.1	14
18.1	15	= IP Configuration =
1.1	16
28.1	17	Typically, each TSW touch panel will need to be initially configured using the TSW user interface at the panel, unless their MAC addresses are already known and the lighting network has a DHCP server. If the DHCP server on the network is temporary (e.g. DHCP server software running on your computer or a processor utilizing the [[ShowRunner™ DHCP Server>>url:https://wiki.chiefintegrations.com/SHOWRUNNER%E2%84%A2%20Setup%20Guide/Troubleshooting%20Guide/Advanced%20Tools/DHCP%20Server/]]), then static IP addresses must be configured. If the DHCP server is permanent (such as a CP4N or ZUM-HUB4 Control Subnet), then only the IP table needs to be configured for the devices.
6.1	18
28.1	19	== DHCP Configuration ==
	20
	21	If the lighting network has a permanent DHCP server, then TSWs only require their IP table to be configured, though it is good practice to also record or update their hostname. If the MAC addresses for the TSWs are not known, then the best way to update their configuration is from the TSW itself by entering into setup mode:
	22
6.1	23	* Put 5 fingers on the front of the TSW and hold for approximately 10 seconds until the TSW enters setup mode
	24	** TSW-xx70 series or TSW-xx60 series with authentication enabled will require admin credentials
9.2	25	** If this is the first time entering setup on a TSW-xx70, it will prompt for a username and password in order to create an admin account. Do not lose or forget these credentials.
	26	* Navigate to the IP Table Setup
	27	* Press the "Add/Edit" button for the first IP table entry
	28	** Edit the CIP ID to be the required IP ID of the TSW (e.g. 10 or 11)
28.1	29	** Edit the IP Address / Hostname to be the IP Address of the processor (e.g. 172.22.0.1)
	30	** Edit the Port to be 41794 if it is not already
	31	** Press the green Save button
	32	* If updating the hostname:
	33	** Return to the main settings menu by pressing the Back button on the top right
	34	** Navigate to the Ethernet Setup menu
	35	** Use the Set Hostname menu to change the TSW's hostname
	36	** Press Apply Changes and then press Reboot
	37	* If leaving the hostname at the default, then exit the IP Table Setup menu using the "Save & Exit" button
	38	* At this point, it is a good idea to [[update the device firmware>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Updating Firmware.WebHome]]
	39	* Repeat these steps for all TSWs on the job
	40
29.1	41	If you are able to identify TSWs by their MAC address, then it is possible to configure these settings via Ethernet using Text Console:
28.1	42
	43	* On jobs with multiple TSWs, they can be identified using Device Discovery and matching the MAC address of the TSW to the IP address assigned by the DHCP server
	44	* Once connected, open Text Console and run the following commands to configure the TSW's IP settings (example is for a TSW IP-ID of (% style="color:olive" %)10(%%), a target processor IP address of (% style="color:orange" %)172.22.0.1(%%), and a TSW hostname of (% style="color:purple" %)TSW-L1(%%))
	45	Update IP table: ##addm (% style="color:olive" %)10(%%) (% style="color:orange" %)172.22.0.1**(%%)##
	46	Set hostname: ##host (% style="color:purple" %)TSW-L1**(%%)##
	47	** Reboot the TSW: ##reboot##
	48
	49	== Static Configuration ==
	50
	51	If the network has no permanent DHCP server, then TSWs should be configured with static IP addresses in the same range as the processor. This can be done from the TSW itself by entering into setup mode:
	52
	53	* Put 5 fingers on the front of the TSW and hold for approximately 10 seconds until the TSW enters setup mode
	54	** TSW-xx70 series or TSW-xx60 series with authentication enabled will require admin credentials
	55	** If this is the first time entering setup on a TSW-xx70, it will prompt for a username and password in order to create an admin account. Do not lose or forget these credentials.
	56	* Navigate to the IP Table Setup
	57	* Press the "Add/Edit" button for the first IP table entry
	58	** Edit the CIP ID to be the required IP ID of the TSW (e.g. 10 or 11)
9.2	59	** Edit the IP Address / Hostname to be the IP Address of the processor (e.g. 10.0.0.10)
	60	** Edit the Port to be 41794 if it is not already
	61	** Press the green Save button
	62	* Return to the main settings menu by pressing the Back button on the top right ("Save & Exit" will exit out of setup mode completely, and require using 5 fingers to re-enter setup mode)
	63	* Navigate to the Ethernet Setup menu
	64	** Set DHCP Enable to "Off"
	65	** If desired, use the Set Hostname menu to change the TSW's hostname
	66	** Enter the "Set Static IP Address Settings" menu and set the IP settings per your network requirements
	67	** Press Apply Changes and then press Reboot
27.1	68	* At this point, it is a good idea to [[update the device firmware>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Updating Firmware.WebHome]]
9.2	69	* Repeat these steps for all TSWs on the job
2.2	70
28.1	71	If operating on a network with a temporary DHCP server (either by running DHCP server software on your computer, or if the processor has a control subnet or is running the [[ShowRunnerCLC™ DHCP Server>>doc:SHOWRUNNER™ Setup Guide.Troubleshooting Guide.Advanced Tools.DHCP Server.WebHome]]) and you are able to identify TSWs by their MAC address, then it is possible to configure these settings via Ethernet using Text Console:
2.2	72
6.1	73	* On jobs with multiple TSWs, they can be identified using Device Discovery and matching the MAC address of the TSW to the IP address assigned by the DHCP server
12.1	74	* Once connected, open Text Console and run the following commands to configure the TSW's IP settings (example is for a 10.0.0.0(% style="color:darkgoldenrod" %)/24(%%) subnet, with a TSW IP address of (% style="color:blue" %)10.0.0.19(%%), a TSW IP-ID of (% style="color:olive" %)10(%%), a processor IP address of (% style="color:orange" %)10.0.0.10(%%), and a TSW hostname of (% style="color:purple" %)TSW-L1(%%))
4.1	75	Set IP address: ##ipa 0 (% style="color:blue" %)10.0.0.19**(%%)##
	76	Set IP subnet mask: ##ipm 0 (% style="color:darkgoldenrod" %)255.255.255.0**(%%)##
	77	Set default gateway: ##defr 0 10.0.0.1**##
28.1	78	** Disable DHCP: ##dhcp 0 off##
4.1	79	Update IP table: ##addm (% style="color:olive" %)10(%%) (% style="color:orange" %)10.0.0.10**(%%)##
5.1	80	Set hostname: ##host (% style="color:purple" %)TSW-L1**(%%)##
4.1	81	** Reboot the TSW: ##reboot##
16.1	82	* Note that TSW-xx70 firmware versions 2.001.0058 and above require a pingable gateway be specified for static IP settings. If no default gateway is set, or the default gateway cannot be pinged, then you are very likely to experience odd network behavior and system instability.
2.2	83
25.1	84	= Load the ShowRunnerCLC™ Project =
2.2	85
9.2	86	Once all the TSWs have been configured with the required IP settings and have had their IP tables updated, connect to the lighting network with a laptop:
2.2	87
25.1	88	* If using a TSW-770 touchscreen, download the latest version of ShowRunnerCLC™ from the [[Chief Integrations Portal>>https://files.chiefintegrations.com/index.php/s/WHNzXrrZbB5jC3E]]
9.2	89	** If using any other TSW (e.g. a TSW-1070 or TSW-xx60), download the CI_ShowRunner-UI_v3.xxx.puf file from the same link
	90	* Double-click the downloaded .puf file to open the Crestron Package Update Tool
	91	* When prompted, point the Package Update Tool to the IP address of the TSW
	92	* Press the Recheck button
	93	* Click the checkbox next to the "Update TSW-xxx...."
	94	[[image:1655143106862-645.png]]
	95	* Click the Update button to begin updating the TSW
	96	* Repeat for all TSWs on the job
	97
18.1	98	= Restricting Visible Areas =
2.2	99
9.2	100	If requested, Chief Integrations will restrict TSWs to only show certain areas. This feature is useful if there are some areas you don't want any touch screens to be able to control (e.g. an exterior area that is on a photocell), or if you want to restrict certain touchscreens to certain areas (e.g., only allow touchscreens to control areas on the same floor as the screen itself).
	101
11.1	102	If Chief Integrations has not configured touchscreens this way, or if new areas have been created or deleted, then it may be necessary to edit or update the configuration file yourself to restrict the visible areas for a touchscreen. This is done by opening the configuration file in a text editor of your choice (Notepad++ or VS Code recommended) and then navigating to the## "Touchpanels": {}## section:
10.1	103	[[image:1655143645596-473.png]]
9.2	104
10.1	105	If startup has already been begun, be sure to pull the latest configuration from the processor rather than editing the configuration that was shipped in order to avoid losing any progress.
	106
	107	The ##"Id":## attribute indicates the IP-ID of the touchscreen that will be modified.
	108
	109	Adding a comma-separated list of AreaIds to the ##"ExcludedAreas": []## attribute will exclude those areas from being visible in the Area Selection menu of the Area Overview screen, but will not exclude those areas from other settings menus (e.g. the Scheduler). Any newly created areas will be visible on the touchscreen.
	110
	111	Adding a comma-separated list of of AreaIds to the ##"AllowedAreas": []## attribute will exclude all areas not explicitly listed from the Area Selection menu of the Area Overview screen. Any newly created areas will not be visible on the touchscreen unless explicitly added to this list.