TSW Touchpanel Setup

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]##

3

4

5

=== TSW Touchscreens with SHOWRUNNER™ ===

6

7

TSWs touchscreens allow end users and technicians access to the SHOWRUNNER™ XPanel UI for both initial startup and daily use. Once the TSW has been configured and the SHOWRUNNER™ 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.

8

9

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 SHOWRUNNER™ 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.

10

11

=== IP Configuration ===

12

13

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:

14

15

* Put 5 fingers on the front of the TSW and hold for approximately 10 seconds until the TSW enters setup mode

16

** TSW-xx70 series or TSW-xx60 series with authentication enabled will require admin credentials

17

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

18

* Navigate to the IP Table Setup

19

* Press the "Add/Edit" button for the first IP table entry

20

** Edit the CIP ID to be the required IP ID of the TSW (e.g. 10 or 11)

21

** Edit the IP Address / Hostname to be the IP Address of the processor (e.g. 10.0.0.10)

22

** Edit the Port to be 41794 if it is not already

23

** Press the green Save button

24

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

25

* Navigate to the Ethernet Setup menu

26

** Set DHCP Enable to "Off"

27

** If desired, use the Set Hostname menu to change the TSW's hostname

28

** Enter the "Set Static IP Address Settings" menu and set the IP settings per your network requirements

29

** Press Apply Changes and then press Reboot

30

* Repeat these steps for all TSWs on the job

31

32

If operating on a network with a DHCP server (either by running DHCP server software on your computer, or if the processor has a control subnet or is running the [[SHOWRUNNER™ DHCP Server>>doc:SHOWRUNNER™ User Guide & Wiki.Troubleshooting.DHCP Server.WebHome]]), then it is possible to configure these settings via Ethernet using Text Console:

33

34

* 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

35

* 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**(%%))

36

** Disable DHCP: ##dhcp 0 off##

37

** Set IP address: ##ipa 0 (% style="color:blue" %)**10.0.0.19**(%%)##

38

** Set IP subnet mask: ##ipm 0 (% style="color:darkgoldenrod" %)**255.255.255.0**(%%)##

39

** Set default gateway: ##defr 0 **10.0.0.1**##

40

** Update IP table: ##addm (% style="color:olive" %)**10**(%%) (% style="color:orange" %)**10.0.0.10**(%%)##

41

** Set hostname: ##host (% style="color:purple" %)**TSW-L1**(%%)##

42

** Reboot the TSW: ##reboot##

43

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

44

45

=== Load the SHOWRUNNER™ Project ===

46

47

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:

48

49

* If using a TSW-770 touchscreen, download the latest version of SHOWRUNNER™ from the [[Chief Integrations Portal>>https://files.chiefintegrations.com/index.php/s/WHNzXrrZbB5jC3E]]

50

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

51

* Double-click the downloaded .puf file to open the Crestron Package Update Tool

52

* When prompted, point the Package Update Tool to the IP address of the TSW

53

* Press the Recheck button

54

* Click the checkbox next to the "Update TSW-xxx...."

55

[[image:1655143106862-645.png]]

56

* Click the Update button to begin updating the TSW

57

* Repeat for all TSWs on the job

58

59

=== Restricting Visible Areas ===

60

61

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

62

63

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:

64

[[image:1655143645596-473.png]]

65

66

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.

67

68

The ##"Id":## attribute indicates the IP-ID of the touchscreen that will be modified.

69

70

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.

71

72

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.

Wiki source code of TSW Touchpanel Setup

Navigation

author	version	line-number	content
		1	{{warning}}
		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]##
		3	{{/warning}}
		4
		5	=== TSW Touchscreens with SHOWRUNNER™ ===
		6
		7	TSWs touchscreens allow end users and technicians access to the SHOWRUNNER™ XPanel UI for both initial startup and daily use. Once the TSW has been configured and the SHOWRUNNER™ 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.
		8
		9	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 SHOWRUNNER™ 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.
		10
		11	=== IP Configuration ===
		12
		13	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:
		14
		15	* Put 5 fingers on the front of the TSW and hold for approximately 10 seconds until the TSW enters setup mode
		16	** TSW-xx70 series or TSW-xx60 series with authentication enabled will require admin credentials
		17	** 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.
		18	* Navigate to the IP Table Setup
		19	* Press the "Add/Edit" button for the first IP table entry
		20	** Edit the CIP ID to be the required IP ID of the TSW (e.g. 10 or 11)
		21	** Edit the IP Address / Hostname to be the IP Address of the processor (e.g. 10.0.0.10)
		22	** Edit the Port to be 41794 if it is not already
		23	** Press the green Save button
		24	* 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)
		25	* Navigate to the Ethernet Setup menu
		26	** Set DHCP Enable to "Off"
		27	** If desired, use the Set Hostname menu to change the TSW's hostname
		28	** Enter the "Set Static IP Address Settings" menu and set the IP settings per your network requirements
		29	** Press Apply Changes and then press Reboot
		30	* Repeat these steps for all TSWs on the job
		31
		32	If operating on a network with a DHCP server (either by running DHCP server software on your computer, or if the processor has a control subnet or is running the [[SHOWRUNNER™ DHCP Server>>doc:SHOWRUNNER™ User Guide & Wiki.Troubleshooting.DHCP Server.WebHome]]), then it is possible to configure these settings via Ethernet using Text Console:
		33
		34	* 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
		35	* 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(%%))
		36	** Disable DHCP: ##dhcp 0 off##
		37	Set IP address: ##ipa 0 (% style="color:blue" %)10.0.0.19**(%%)##
		38	Set IP subnet mask: ##ipm 0 (% style="color:darkgoldenrod" %)255.255.255.0**(%%)##
		39	Set default gateway: ##defr 0 10.0.0.1**##
		40	Update IP table: ##addm (% style="color:olive" %)10(%%) (% style="color:orange" %)10.0.0.10**(%%)##
		41	Set hostname: ##host (% style="color:purple" %)TSW-L1**(%%)##
		42	** Reboot the TSW: ##reboot##
		43	* 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.
		44
		45	=== Load the SHOWRUNNER™ Project ===
		46
		47	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:
		48
		49	* If using a TSW-770 touchscreen, download the latest version of SHOWRUNNER™ from the [[Chief Integrations Portal>>https://files.chiefintegrations.com/index.php/s/WHNzXrrZbB5jC3E]]
		50	** 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
		51	* Double-click the downloaded .puf file to open the Crestron Package Update Tool
		52	* When prompted, point the Package Update Tool to the IP address of the TSW
		53	* Press the Recheck button
		54	* Click the checkbox next to the "Update TSW-xxx...."
		55	[[image:1655143106862-645.png]]
		56	* Click the Update button to begin updating the TSW
		57	* Repeat for all TSWs on the job
		58
		59	=== Restricting Visible Areas ===
		60
		61	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).
		62
		63	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:
		64	[[image:1655143645596-473.png]]
		65
		66	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.
		67
		68	The ##"Id":## attribute indicates the IP-ID of the touchscreen that will be modified.
		69
		70	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.
		71
		72	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.