Toolbox Basics

[[Crestron's Toolbox>>url:https://www.crestron.com/Products/Control-Hardware-Software/Software/Development-Software/SW-TB]] software is vital to being able to startup any Crestron lighting control job. The intent of this article is to familiarize a new lighting control tech with the very basics of the various Tools available within the Crestron Toolbox software; detailed information can be access anytime from within Toolbox by pressing the F1 function key to open the Crestron Toolbox Help Menu. If a tool window is the active window, pressing F1 will open the Crestron Toolbox Help Menu to the specific page for that tool.

6

7

= Initial Toolbox Configuration =

8

9

When you first open Toolbox, there are several settings and preferences that Chief Integrations recommends making:

10

11

* From the list of options at the top, navigate to "File>Preferences..."

12

** For "Load Workspace on startup?" select "None"

13

** For "Save Workspace on exit?" select "Never"

14

** For "Automatically Connect to:" select "Nothing"

15

* From the list of options at the top, navigate to "Tools>Manage Tools..."

16

** We recommend selecting the most commonly used tools and familiarizing yourself with their icons:

17

*** [[image:1663622192322-441.png]]System Info

18

*** [[image:1663622220065-810.png]]Text Console

19

*** [[image:1663622252305-602.png]]SIMPL Debugger

20

*** [[image:1663622272369-417.png]]Script Manager

21

*** [[image:1663622297411-164.png]]Package Update Tool

22

*** [[image:1663622313939-259.png]]Network Device Tree View

23

*** [[image:1663622340028-319.png]]File Manager

24

*** [[image:1663622362685-655.png]]Device Discovery Tool

25

*** [[image:1663622375782-444.png]]DALI Commissioning Tool

26

*** [[image:1663622400865-394.png]]Network Analyzer

27

** Once checked, these icons appear as shortcuts below the "File/View/Tools/etc." menus

28

29

= Connecting to Devices =

30

31

In order to connect to any lighting devices, your computer must be physically connected to the lighting device or the lighting network. Typically, this is achieved via TCP (i.e. Ethernet or WiFi) or USB (usually a USB-A to USB-B cable), though some older devices may require an RS-232 serial connection.

32

33

Any Toolbox tool which requires connecting to a device has several buttons and fields at the lower left which relate to device connection:

34

35

[[image:Untitled.png]]

36

37

These elements have various functions:

38

39

1. Address Book Menu - Used to view and edit the current address book, or to change the active Address Book to a different Address Book

40

1. Current Connected Device - If the currently connected device is in the Address Book, it's name in the Address Book will be displayed here. This drop down menu can also be used to connect to a different device within the current Address Book

41

1. Manual Connection Menu - This menu is used to manually connect to a device that is not in the current Address Book. It can be used regardless of the connection type or device being connected to:

42

1*. [[image:1663625644870-585.png]]

43

1. Quick Function Menu (keyboard shortcut: ALT+F) - menu containing a few useful functions

44

1*. Firmware (keyboard shortcut: ALT+O) - menu for loading firmware

45

1*. SIMPL Program (keyboard shortcut: ALT+P) - menu for loading a SIMPL or SIMPL# Program

46

1*. Project (keyboard shortcut: ALT+T) - menu for loading an XPanel UI

47

1. Current connection status ("Connecting", "Connected", "Disconnected", or "Unknown")

48

1. Current connection type and address (e.g. "usb" or "ssh 10.44.5.71")

== USB Connection ==

Connecting to a device via USB is only recommended during initial configuration of the device's IP settings or if there is an issue with connecting via Ethernet/TCP. The data transfer rate over USB is very low relative to Ethernet, and so any activities that require data transfer (such as updating firmware, updating showrunner™, or loading a UI) will take much longer than necessary. Additionally, when connecting via USB, only the device you are plugged in to will be connectable in Toolbox, rather than being able to connect to any device on the lighting network as would be possible when connected by Ethernet.

To connect via USB:

1. Determine the necessary USB cable

57

1*. Most devices (DIN-AP3, DIN-AP4, DIN-CENCN-2, etc.) will require a USB-B connection, but some devices may require a Mini USB-B or Micro USB-B connection

58

1. Plug the USB cable in to both the device and your computer

59

1. Open Toolbox and then open the desired tool

60

1. Connect to the device

61

1*. If you are using the Default Address Book, there is already an entry for "Local-USB"

62

1*. If you are not using an Address Book, then you should click the Pencil Icon to open the Manual Connection Menu:

63

1*1. Change the connection type from "TCP" to "USB"

64

1*1. Leave Model, Hostname, and Serial fields blank

65

1*1. If the device has authentication enabled, expand the Advanced options and input the username and password

66

1*1. Click "OK"

67

1. The current connection status field should change from "Unknown" to "Connecting"

68

1. After a brief period, the connection status field should change from "Connecting" to "Connected"

69

1*. Some devices may take longer than others to connect

70

1*. If the device has just recently powered up, it may take a few minutes to completely wake up before it can be connected to

71

1*. If you have issues connecting, see [[Troubleshooting a Failed Connection>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Preparation.Toolbox Basics.WebHome||anchor="HTroubleshootingaFailedConnection"]] below

72

73

== Ethernet Connection ==

74

75

Plugging in to the lighting network and connecting to devices via Ethernet is the most useful way to connect to lighting control hardware. When your laptop is connected to the lighting network, you are able to connect to any device that is on the network, as well as connect to multiple devices simultaneously. Unlike with a USB connection, connecting to a device via Ethernet does not require physical proximity to the device. Wireless connection to the lighting network is possible if the lighting network has properly configured a wireless router on it.

76

77

To connect to a device via Ethernet, your laptop must first be connected to the lighting network.

78

79

To connect to the lighting network:

80

81

1. Identify an open where you are able to plug in to the lighting network

82

1*. Many Crestron processor and HUB panels will have one or more CEN-SW-POE-5 or CEN-SWPOE-16 ethernet switches. Any open port on these Ethernet switches should be able to be used to connect a laptop to the network.

83

1*. Laptops do not require power over Ethernet, so it is acceptable to use the "Uplink" port if necessary.

84

1*. If the lighting network is on the building LAN, then you may need to reach out to the building's IT department for instructions on how to access the lighting network or VLAN.

85

1. Use a Cat 5a or Cat 6 cable to connect your laptop to the lighting network at an open port

86

1*. Most newer laptops will require some sort of adapter in order to connect to a Cat 5a/6 cable

87

1. Configure your laptop's network settings to be compatible with the lighting network:

88

11. Navigate to Control Panel>Network and Internet>Network Connections

89

11. Locate the network adapter that is connected to the lighting network

90

11. Right click the network adapter and click "Properties"

91

11. In the Networking tab of the adapter Properties menu, select "Internet Protocol Version 4 (TCP/IPv4)" from the list

92

11. Click the "Properties" button

93

11*. If the lighting network uses static IP addresses:

94

11*1. Click "Use the following IP address:"

95

11*1. For the IP Address, give your laptop an address that is in the range of the lighting devices but that does not conflict with any addresses on the network

96

11*1. For the Subnet mask, give your laptop the same subnet mask as the lighting devices

97

11*1. The Default gateway can be left blank

98

11*1. Once all settings have been configured, press "OK" to close the IP configuration dialog

99

11*1*. E.g., if there is a lighting network with a processor at 10.0.0.10, a DIN-CENCN-2 at 10.0.0.11, and a TSW at 10.0.0.12 and all devices have a subnet mask of 255.255.255.0, then your laptop can have any address in the range 10.0.0.2 through 10.0.0.9 or 10.0.0.13 through 10.0.0.254, since these addresses are all in the subnetwork range and are not being used by other devices.

100

11*1. Press "OK" again to close the Ethernet Properties dialog

101

11*. If the lighting network has a DHCP server (such as a CP4N control subnet):

102

11*1. Use the "Obtain an IP address automatically" option

103

11*1. Press "OK" to close the IP Configuration dialog

104

11*1. Press "OK" again to close the Ethernet Properties dialog

105

11*1. Your laptop will automatically be assigned an IP address in the correct range by the DHCP server on the network.

106

11*1*. You can verify this by opening the Windows Command Line tool and running "ipconfig" command to view your current adapter settings

107

1. Open Toolbox and then open the desired tool

108

1. Connect to the device:

109

1*. If you have created an address book, then select the device from the drop down menu

110

1*. If you have not created an address book, then you should click the Pencil Icon to open the Manual Connection Menu:

111

1*1. Leave the connection type as "TCP"

112

1*1. Type in the IP address of the device you wish to connect to

113

1*1. Generally, the "Auto Detect" box should be left at "Auto Detect", though if you know what type of connection you need then you can manually change it

114

1*1. Leave Model, Hostname, and Serial fields blank

115

1*1. If the device has authentication enabled, expand the Advanced options and input the username and password

116

1*1. Click "OK"

117

1. The current connection status field should change from "Unknown" to "Connecting"

118

1. After a brief period, the connection status field should change from "Connecting" to "Connected"

119

1*. Some devices may take longer than others to connect

120

1*. If the device has just recently powered up, it may take a few minutes to completely wake up before it can be connected to

121

1*. If you have issues connecting, see [[Troubleshooting a Failed Connection>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Preparation.Toolbox Basics.WebHome||anchor="HTroubleshootingaFailedConnection"]] below

122

123

== Device Discovery Tool ==

124

125

Crestron's Device Discovery Tool is used to "discover" any Crestron devices which are connected to your laptop. The most useful feature of the Device Discovery Tool is the ability to export all discovered devices to either a "Device Summary" text file or an Address Book. Discovered devices are listed in a scrollable list on the left side of the menu, and double clicking a discovered device will bring up additional configuration options on the right side. Below is an overview of the Device Discovery Tool UI:

126

127

128

[[image:device discovery tool numbered.png]]

129

130

1. Device Model - gives the specific model of the device type

131

1. Device Type - gives an idea of what function the device serves ("Control System", "AV", "Lighting", etc.)

132

1. Connection and Firmware Information

133

1*. Ethernet connected devices give their hostname, IP address, and firmware version

134

1*. USB connected devices give their hostname, serial number, and firmware version

135

1. Discovery Summary - gives a summary of how long it took to discover devices and how many devices were discovered at each connection type

136

1. Discover Devices button - press this to restart the discovery process

137

1. Export... button - use this button to export discovered devices to either a Device Summary or Address Book (covered in more detail below)

138

139

=== Export to Device Summary ===

140

141

The Device Summary is an important documentation tool provided by Crestron. It is a .txt file containing a comma-separated-values of all networked devices, and is useful to capture which devices are online, what their current IP and hostname settings are, what version of firmware they are on, and their MAC address and serial number.

142

143

To generate a Device Summary in Toolbox:

144

145

1. Connect to the lighting network and open Device Discovery Tool in Toolbox

146

1. The Device Discovery tool will automatically report how many Ethernet devices have been discovered

147

1. Verify that the expected number of Ethernet devices have been discovered, including any TSWs, GLPACs, DIN-CENCN-2s, etc.

148

1*. Note that only Crestron devices will appear in Device Discovery; non-Crestron devices (such as Pharos or Enttec DMX controllers) will not appear in Device Discovery Tool

149

1*. If no devices are discovered, verify that your computer is connected to the network and your IP address is compatible with the network

150

1*. If some devices are missing, there may be an issue with your DHCP server settings or the network wiring

151

1. Click the "Export..." button below the list of discovered devices

152

1*. If this button says "Address Book", then Toolbox needs to be updated

153

1. Click the Write Device Summary button and save the Device Summary to your computer

154

1*. Though saved as a text file, the Device Summary is actually a table of comma separated values

155

1*. Renaming DeviceSummary.txt to DeviceSummary.csv will allow it to be opened and manipulated in common spreadsheet software such as Microsoft Excel or LibreOffice Calc

156

157

Below is an example of a Device Summary for a fully-configured Zūm Wired job:

158

159

* DeviceSummary.txt:

160

[[image:https://wiki.chiefintegrations.com/download/SHOWRUNNER%E2%84%A2%20Setup%20Guide/SHOWRUNNER%E2%84%A2%20Installation%20Guide/SHOWRUNNER%E2%84%A2%20Installation%20and%20Network%20Setup/ZUMNET-JBOX%20Setup/WebHome/1655487020590-542.png?rev=1.1||alt="1655487020590-542.png"]]

161

* DeviceSummary.csv:

162

[[image:https://wiki.chiefintegrations.com/download/SHOWRUNNER%E2%84%A2%20Setup%20Guide/SHOWRUNNER%E2%84%A2%20Installation%20Guide/SHOWRUNNER%E2%84%A2%20Installation%20and%20Network%20Setup/ZUMNET-JBOX%20Setup/WebHome/1655487132138-904.png?rev=1.1||alt="1655487132138-904.png"]]

163

164

=== Export to Address Book ===

165

166

Address Books are useful ways of managing multiple jobs that each have many devices.

167

168

== Troubleshooting a Failed Connection ==

169

170

"Device refused to identify" (also happens if too many login attempts are made with the wrong username/password)

171

172

"Device not found in database"

= Basic Tool Usage =

== Text Console ==

== File Manager ==

== Network Device Tree View ==

= Miscellaneous =

== VPT COM Server ==

Whenever Toolbox is open, Toolbox also starts a separate process called the Crestron Toolbox VPT COM server. This process appears in the system tray with the following icon when active: [[image:1663630447432-699.png]]

187

188

Occasionally, something goes wrong with the VPT COM Server process which will prevent Toolbox from functioning correctly. To solve this problem, take the following steps:

189

190

1. Close Crestron Toolbox

191

1. Press CTRL+SHIFT+ESC to open Windows Task Manager

192

1. Click the "More Details" button to see all processes

193

1. Sort processes alphabetically and look for "VptCOMServer Module (32 bit)" under the "Background Processes" section

194

1*. If you do not see the VptCOMServer process in Task Manager and the icon is not in the system tray, then it is not running

195

1*. If the VptCOMServer process is still running after Toolbox has closed, select it in Task Manager and press End Process to stop it

196

1. Once VptCOMServer is stopped, open Toolbox and see if your issues have been resolved

197

198

== Alternatives to Specific Toolbox Tools ==

199

200

Sometimes it is necessary to connect to a Crestron device for troubleshooting using a computer that either does not or cannot have Toolbox installed on it. In these instances, third-party software can be used to replace some of the Tools in Toolbox in order to allow immediate troubleshooting of the lighting control system.

201

202

The Text Console tool can be substituted with [[PuTTY>>https://www.putty.org/]], a free and open-source Telnet and SSH client/terminal emulator. [[SecureCRT>>https://www.vandyke.com/products/securecrt/]] is another option with some more capability than PuTTY, but note that it is a paid software which requires a license to use. The File Management tool can be substituted with [[WinSCP>>https://winscp.net/eng/index.php]], [[FileZilla>>https://filezilla-project.org/]], or [[CyberDuck>>https://cyberduck.io/]]. These are all free FTP/SFTP clients that do not require any license to use.

203

204

Note that any Text Console or File Management alternatives are only suitable when connecting to Crestron devices over TCP/IP (Ethernet). When connecting to a Crestron device using these third-party programs, use port 22. Connecting to Crestron devices over USB is only possible using Toolbox because these devices do not use a standard communications protocol for USB communications.

Wiki source code of Toolbox Basics

Navigation

author	version	line-number	content
		1	{{box cssClass="floatinginfobox" title="CONTENTS"}}
		2	{{toc/}}
		3	{{/box}}
		4
		5	[[Crestron's Toolbox>>url:https://www.crestron.com/Products/Control-Hardware-Software/Software/Development-Software/SW-TB]] software is vital to being able to startup any Crestron lighting control job. The intent of this article is to familiarize a new lighting control tech with the very basics of the various Tools available within the Crestron Toolbox software; detailed information can be access anytime from within Toolbox by pressing the F1 function key to open the Crestron Toolbox Help Menu. If a tool window is the active window, pressing F1 will open the Crestron Toolbox Help Menu to the specific page for that tool.
		6
		7	= Initial Toolbox Configuration =
		8
		9	When you first open Toolbox, there are several settings and preferences that Chief Integrations recommends making:
		10
		11	* From the list of options at the top, navigate to "File>Preferences..."
		12	** For "Load Workspace on startup?" select "None"
		13	** For "Save Workspace on exit?" select "Never"
		14	** For "Automatically Connect to:" select "Nothing"
		15	* From the list of options at the top, navigate to "Tools>Manage Tools..."
		16	** We recommend selecting the most commonly used tools and familiarizing yourself with their icons:
		17	*** [[image:1663622192322-441.png]]System Info
		18	*** [[image:1663622220065-810.png]]Text Console
		19	*** [[image:1663622252305-602.png]]SIMPL Debugger
		20	*** [[image:1663622272369-417.png]]Script Manager
		21	*** [[image:1663622297411-164.png]]Package Update Tool
		22	*** [[image:1663622313939-259.png]]Network Device Tree View
		23	*** [[image:1663622340028-319.png]]File Manager
		24	*** [[image:1663622362685-655.png]]Device Discovery Tool
		25	*** [[image:1663622375782-444.png]]DALI Commissioning Tool
		26	*** [[image:1663622400865-394.png]]Network Analyzer
		27	** Once checked, these icons appear as shortcuts below the "File/View/Tools/etc." menus
		28
		29	= Connecting to Devices =
		30
		31	In order to connect to any lighting devices, your computer must be physically connected to the lighting device or the lighting network. Typically, this is achieved via TCP (i.e. Ethernet or WiFi) or USB (usually a USB-A to USB-B cable), though some older devices may require an RS-232 serial connection.
		32
		33	Any Toolbox tool which requires connecting to a device has several buttons and fields at the lower left which relate to device connection:
		34
		35	[[image:Untitled.png]]
		36
		37	These elements have various functions:
		38
		39	1. Address Book Menu - Used to view and edit the current address book, or to change the active Address Book to a different Address Book
		40	1. Current Connected Device - If the currently connected device is in the Address Book, it's name in the Address Book will be displayed here. This drop down menu can also be used to connect to a different device within the current Address Book
		41	1. Manual Connection Menu - This menu is used to manually connect to a device that is not in the current Address Book. It can be used regardless of the connection type or device being connected to:
		42	1*. [[image:1663625644870-585.png]]
		43	1. Quick Function Menu (keyboard shortcut: ALT+F) - menu containing a few useful functions
		44	1*. Firmware (keyboard shortcut: ALT+O) - menu for loading firmware
		45	1*. SIMPL Program (keyboard shortcut: ALT+P) - menu for loading a SIMPL or SIMPL# Program
		46	1*. Project (keyboard shortcut: ALT+T) - menu for loading an XPanel UI
		47	1. Current connection status ("Connecting", "Connected", "Disconnected", or "Unknown")
		48	1. Current connection type and address (e.g. "usb" or "ssh 10.44.5.71")
		49
		50	== USB Connection ==
		51
		52	Connecting to a device via USB is only recommended during initial configuration of the device's IP settings or if there is an issue with connecting via Ethernet/TCP. The data transfer rate over USB is very low relative to Ethernet, and so any activities that require data transfer (such as updating firmware, updating showrunner™, or loading a UI) will take much longer than necessary. Additionally, when connecting via USB, only the device you are plugged in to will be connectable in Toolbox, rather than being able to connect to any device on the lighting network as would be possible when connected by Ethernet.
		53
		54	To connect via USB:
		55
		56	1. Determine the necessary USB cable
		57	1*. Most devices (DIN-AP3, DIN-AP4, DIN-CENCN-2, etc.) will require a USB-B connection, but some devices may require a Mini USB-B or Micro USB-B connection
		58	1. Plug the USB cable in to both the device and your computer
		59	1. Open Toolbox and then open the desired tool
		60	1. Connect to the device
		61	1*. If you are using the Default Address Book, there is already an entry for "Local-USB"
		62	1*. If you are not using an Address Book, then you should click the Pencil Icon to open the Manual Connection Menu:
		63	1*1. Change the connection type from "TCP" to "USB"
		64	1*1. Leave Model, Hostname, and Serial fields blank
		65	1*1. If the device has authentication enabled, expand the Advanced options and input the username and password
		66	1*1. Click "OK"
		67	1. The current connection status field should change from "Unknown" to "Connecting"
		68	1. After a brief period, the connection status field should change from "Connecting" to "Connected"
		69	1*. Some devices may take longer than others to connect
		70	1*. If the device has just recently powered up, it may take a few minutes to completely wake up before it can be connected to
		71	1*. If you have issues connecting, see [[Troubleshooting a Failed Connection>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Preparation.Toolbox Basics.WebHome\|\|anchor="HTroubleshootingaFailedConnection"]] below
		72
		73	== Ethernet Connection ==
		74
		75	Plugging in to the lighting network and connecting to devices via Ethernet is the most useful way to connect to lighting control hardware. When your laptop is connected to the lighting network, you are able to connect to any device that is on the network, as well as connect to multiple devices simultaneously. Unlike with a USB connection, connecting to a device via Ethernet does not require physical proximity to the device. Wireless connection to the lighting network is possible if the lighting network has properly configured a wireless router on it.
		76
		77	To connect to a device via Ethernet, your laptop must first be connected to the lighting network.
		78
		79	To connect to the lighting network:
		80
		81	1. Identify an open where you are able to plug in to the lighting network
		82	1*. Many Crestron processor and HUB panels will have one or more CEN-SW-POE-5 or CEN-SWPOE-16 ethernet switches. Any open port on these Ethernet switches should be able to be used to connect a laptop to the network.
		83	1*. Laptops do not require power over Ethernet, so it is acceptable to use the "Uplink" port if necessary.
		84	1*. If the lighting network is on the building LAN, then you may need to reach out to the building's IT department for instructions on how to access the lighting network or VLAN.
		85	1. Use a Cat 5a or Cat 6 cable to connect your laptop to the lighting network at an open port
		86	1*. Most newer laptops will require some sort of adapter in order to connect to a Cat 5a/6 cable
		87	1. Configure your laptop's network settings to be compatible with the lighting network:
		88	11. Navigate to Control Panel>Network and Internet>Network Connections
		89	11. Locate the network adapter that is connected to the lighting network
		90	11. Right click the network adapter and click "Properties"
		91	11. In the Networking tab of the adapter Properties menu, select "Internet Protocol Version 4 (TCP/IPv4)" from the list
		92	11. Click the "Properties" button
		93	11*. If the lighting network uses static IP addresses:
		94	11*1. Click "Use the following IP address:"
		95	11*1. For the IP Address, give your laptop an address that is in the range of the lighting devices but that does not conflict with any addresses on the network
		96	11*1. For the Subnet mask, give your laptop the same subnet mask as the lighting devices
		97	11*1. The Default gateway can be left blank
		98	11*1. Once all settings have been configured, press "OK" to close the IP configuration dialog
		99	111. E.g., if there is a lighting network with a processor at 10.0.0.10, a DIN-CENCN-2 at 10.0.0.11, and a TSW at 10.0.0.12 and all devices have a subnet mask of 255.255.255.0, then your laptop can have any address in the range 10.0.0.2 through 10.0.0.9 or 10.0.0.13 through 10.0.0.254, since these addresses are all in the subnetwork range and are not being used by other devices.
		100	11*1. Press "OK" again to close the Ethernet Properties dialog
		101	11*. If the lighting network has a DHCP server (such as a CP4N control subnet):
		102	11*1. Use the "Obtain an IP address automatically" option
		103	11*1. Press "OK" to close the IP Configuration dialog
		104	11*1. Press "OK" again to close the Ethernet Properties dialog
		105	11*1. Your laptop will automatically be assigned an IP address in the correct range by the DHCP server on the network.
		106	111. You can verify this by opening the Windows Command Line tool and running "ipconfig" command to view your current adapter settings
		107	1. Open Toolbox and then open the desired tool
		108	1. Connect to the device:
		109	1*. If you have created an address book, then select the device from the drop down menu
		110	1*. If you have not created an address book, then you should click the Pencil Icon to open the Manual Connection Menu:
		111	1*1. Leave the connection type as "TCP"
		112	1*1. Type in the IP address of the device you wish to connect to
		113	1*1. Generally, the "Auto Detect" box should be left at "Auto Detect", though if you know what type of connection you need then you can manually change it
		114	1*1. Leave Model, Hostname, and Serial fields blank
		115	1*1. If the device has authentication enabled, expand the Advanced options and input the username and password
		116	1*1. Click "OK"
		117	1. The current connection status field should change from "Unknown" to "Connecting"
		118	1. After a brief period, the connection status field should change from "Connecting" to "Connected"
		119	1*. Some devices may take longer than others to connect
		120	1*. If the device has just recently powered up, it may take a few minutes to completely wake up before it can be connected to
		121	1*. If you have issues connecting, see [[Troubleshooting a Failed Connection>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Preparation.Toolbox Basics.WebHome\|\|anchor="HTroubleshootingaFailedConnection"]] below
		122
		123	== Device Discovery Tool ==
		124
		125	Crestron's Device Discovery Tool is used to "discover" any Crestron devices which are connected to your laptop. The most useful feature of the Device Discovery Tool is the ability to export all discovered devices to either a "Device Summary" text file or an Address Book. Discovered devices are listed in a scrollable list on the left side of the menu, and double clicking a discovered device will bring up additional configuration options on the right side. Below is an overview of the Device Discovery Tool UI:
		126
		127
		128	[[image:device discovery tool numbered.png]]
		129
		130	1. Device Model - gives the specific model of the device type
		131	1. Device Type - gives an idea of what function the device serves ("Control System", "AV", "Lighting", etc.)
		132	1. Connection and Firmware Information
		133	1*. Ethernet connected devices give their hostname, IP address, and firmware version
		134	1*. USB connected devices give their hostname, serial number, and firmware version
		135	1. Discovery Summary - gives a summary of how long it took to discover devices and how many devices were discovered at each connection type
		136	1. Discover Devices button - press this to restart the discovery process
		137	1. Export... button - use this button to export discovered devices to either a Device Summary or Address Book (covered in more detail below)
		138
		139	=== Export to Device Summary ===
		140
		141	The Device Summary is an important documentation tool provided by Crestron. It is a .txt file containing a comma-separated-values of all networked devices, and is useful to capture which devices are online, what their current IP and hostname settings are, what version of firmware they are on, and their MAC address and serial number.
		142
		143	To generate a Device Summary in Toolbox:
		144
		145	1. Connect to the lighting network and open Device Discovery Tool in Toolbox
		146	1. The Device Discovery tool will automatically report how many Ethernet devices have been discovered
		147	1. Verify that the expected number of Ethernet devices have been discovered, including any TSWs, GLPACs, DIN-CENCN-2s, etc.
		148	1*. Note that only Crestron devices will appear in Device Discovery; non-Crestron devices (such as Pharos or Enttec DMX controllers) will not appear in Device Discovery Tool
		149	1*. If no devices are discovered, verify that your computer is connected to the network and your IP address is compatible with the network
		150	1*. If some devices are missing, there may be an issue with your DHCP server settings or the network wiring
		151	1. Click the "Export..." button below the list of discovered devices
		152	1*. If this button says "Address Book", then Toolbox needs to be updated
		153	1. Click the Write Device Summary button and save the Device Summary to your computer
		154	1*. Though saved as a text file, the Device Summary is actually a table of comma separated values
		155	1*. Renaming DeviceSummary.txt to DeviceSummary.csv will allow it to be opened and manipulated in common spreadsheet software such as Microsoft Excel or LibreOffice Calc
		156
		157	Below is an example of a Device Summary for a fully-configured Zūm Wired job:
		158
		159	* DeviceSummary.txt:
		160	[[image:https://wiki.chiefintegrations.com/download/SHOWRUNNER%E2%84%A2%20Setup%20Guide/SHOWRUNNER%E2%84%A2%20Installation%20Guide/SHOWRUNNER%E2%84%A2%20Installation%20and%20Network%20Setup/ZUMNET-JBOX%20Setup/WebHome/1655487020590-542.png?rev=1.1\|\|alt="1655487020590-542.png"]]
		161	* DeviceSummary.csv:
		162	[[image:https://wiki.chiefintegrations.com/download/SHOWRUNNER%E2%84%A2%20Setup%20Guide/SHOWRUNNER%E2%84%A2%20Installation%20Guide/SHOWRUNNER%E2%84%A2%20Installation%20and%20Network%20Setup/ZUMNET-JBOX%20Setup/WebHome/1655487132138-904.png?rev=1.1\|\|alt="1655487132138-904.png"]]
		163
		164	=== Export to Address Book ===
		165
		166	Address Books are useful ways of managing multiple jobs that each have many devices.
		167
		168	== Troubleshooting a Failed Connection ==
		169
		170	"Device refused to identify" (also happens if too many login attempts are made with the wrong username/password)
		171
		172	"Device not found in database"
		173
		174	= Basic Tool Usage =
		175
		176	== Text Console ==
		177
		178	== File Manager ==
		179
		180	== Network Device Tree View ==
		181
		182	= Miscellaneous =
		183
		184	== VPT COM Server ==
		185
		186	Whenever Toolbox is open, Toolbox also starts a separate process called the Crestron Toolbox VPT COM server. This process appears in the system tray with the following icon when active: [[image:1663630447432-699.png]]
		187
		188	Occasionally, something goes wrong with the VPT COM Server process which will prevent Toolbox from functioning correctly. To solve this problem, take the following steps:
		189
		190	1. Close Crestron Toolbox
		191	1. Press CTRL+SHIFT+ESC to open Windows Task Manager
		192	1. Click the "More Details" button to see all processes
		193	1. Sort processes alphabetically and look for "VptCOMServer Module (32 bit)" under the "Background Processes" section
		194	1*. If you do not see the VptCOMServer process in Task Manager and the icon is not in the system tray, then it is not running
		195	1*. If the VptCOMServer process is still running after Toolbox has closed, select it in Task Manager and press End Process to stop it
		196	1. Once VptCOMServer is stopped, open Toolbox and see if your issues have been resolved
		197
		198	== Alternatives to Specific Toolbox Tools ==
		199
		200	Sometimes it is necessary to connect to a Crestron device for troubleshooting using a computer that either does not or cannot have Toolbox installed on it. In these instances, third-party software can be used to replace some of the Tools in Toolbox in order to allow immediate troubleshooting of the lighting control system.
		201
		202	The Text Console tool can be substituted with [[PuTTY>>https://www.putty.org/]], a free and open-source Telnet and SSH client/terminal emulator. [[SecureCRT>>https://www.vandyke.com/products/securecrt/]] is another option with some more capability than PuTTY, but note that it is a paid software which requires a license to use. The File Management tool can be substituted with [[WinSCP>>https://winscp.net/eng/index.php]], [[FileZilla>>https://filezilla-project.org/]], or [[CyberDuck>>https://cyberduck.io/]]. These are all free FTP/SFTP clients that do not require any license to use.
		203
		204	Note that any Text Console or File Management alternatives are only suitable when connecting to Crestron devices over TCP/IP (Ethernet). When connecting to a Crestron device using these third-party programs, use port 22. Connecting to Crestron devices over USB is only possible using Toolbox because these devices do not use a standard communications protocol for USB communications.