Wiki source code of Toolbox Basics

Last modified by Alexander Mott on 2024/03/19 21:00
Show last authors
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 starting up 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 or a different USB cable.
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. See [[Troubleshooting a Failed Connection>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Preparation.Toolbox Basics.WebHome||anchor="HExporttoAddressBook"]] below for information about creating an Address Book
40 1. Known Device Dropdown - This drop down menu can also be used to connect to devices in the current Address Book. If the currently connected device is in the Address Book, it's name in the Address Book will be displayed here
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 ([[FAQ page>>https://wiki.chiefintegrations.com/FAQ/How%20do%20I%20change%20my%20computer%27s%20network%20settings]]) 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 (see [[Export to Address Book>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Preparation.Toolbox Basics.WebHome||anchor="HExporttoAddressBook"]] below), 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 or Hostname 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*. CEN-GWEXERs with Authentication enabled require manually setting the connection type to "TSL/SSL"
115 1*1. Leave Model, Hostname, and Serial fields blank
116 1*1. If the device has authentication enabled, expand the Advanced options and input the username and password
117 1*1. Click "OK"
118 1. The current connection status field should change from "Unknown" to "Connecting"
119 1. After a brief period, the connection status field should change from "Connecting" to "Connected"
120 1*. Some devices may take longer than others to connect
121 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
122 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
123
124 == Troubleshooting a Failed Connection ==
125
126 Sometimes, a connection attempt will fail and you will need to do some troubleshooting to figure out why exactly the connection could not be established. Toolbox will give different error messages, though sometimes it can be helpful to attempt to connect with another software such as PuTTY just in case the error message is more informative from the alternate software.
127
128 "Device refused to identify"
129
130 * This message typically means that the device is not online or could not be connected to
131 * This message may also occur when a device has blocked your username or IP address due to making too many incorrect login attempts
132 ** IP addresses are blocked for 24 hours by default, but you can attempt to circumvent this block by changing your IP address and trying again
133 ** Users are blocked for 30 minutes by default, and it is only possible to circumvent this if another user has already been created, otherwise you must wait for the block to expire before connecting again
134 ** The below commands are useful if you are able to connect to the processor through some other means (specific commands may vary depending on the device):
135 *** ##listblockedip## and ##remblockedip## commands can be used to view/unblock an IP address
136 *** ##listlockeduser## and ##remlockeduser## commands can be used to view/unblock specific users
137 *** ##setloginattempts## and ##setlockouttime## commands can be used to modify how many login attempts are allowed before blocking an IP address and how long an address will be blocked
138 *** ##setuserloginattempts## and ##setuserlockouttime## commands are used to modify how many login attempts are allowed before blocking a user and how long that user will be blocked
139 *** ##setlogoffidletime## command can be used to modify how long you can be inactive before the processor automatically logs you out
140
141 "Device not found in database"
142
143 * This message typically means that the version of your device database is out of date and the device being connected to is not in it. Use Crestron's MasterInstaller tool to ensure that Toolbox and all installed Crestron components are up-to-date
144
145 See our FAQ for additional tips:
146
147 * [[I can't connect to my processor via Ethernet?>>https://wiki.chiefintegrations.com/FAQ/I%20can%27t%20connect%20to%20my%20processor%20via%20Ethernet]]
148 * [[I can't connect to a 4-Series processor via USB?>>https://wiki.chiefintegrations.com/FAQ/I%20can%27t%20connect%20to%204-Series%20processor%20via%20USB]]
149
150 = Basic Tool Usage =
151
152 Crestron Toolbox has many tools that are essential for starting up or troubleshooting any ShowRunnerCLC™ installation. The tools covered here are the most commonly used in commercial lighting contexts, but it should be noted that this list is by no means exhaustive. If you have many Tool windows open at once in Toolbox, or if you have only a few Tools open but the window is maximized, then the Window dropdown menu at the top of Toolbox will be useful for navigating the open tools. The Window dropdown has options for cascading/tiling all open tools, as well as a list of open windows to allow easily switching between them:
153 [[image:window.png]]
154
155 == Device Discovery Tool ==
156
157 Crestron's Device Discovery Tool [[image:1663622362685-655.png]] 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:
158
159 [[image:device discovery tool numbered.png]]
160
161 1. Device Model - gives the specific model of the device type
162 1. Device Type - gives an idea of what function the device serves ("Control System", "AV", "Lighting", etc.)
163 1. Connection and Firmware Information
164 1*. Ethernet connected devices give their hostname, IP address, and firmware version
165 1*. USB connected devices give their hostname, serial number, and firmware version
166 1. Discovery Summary - gives a summary of how long it took to discover devices and how many devices were discovered at each connection type
167 1. Discover Devices button - press this to restart the discovery process
168 1. Export... button - use this button to export discovered devices to either a Device Summary or Address Book (covered in more detail below)
169
170 (% class="wikigeneratedid" %)
171 === Local vs Remote Search ===
172
173 When using your laptop to do a Device Discovery, the default option for where to search for Crestron devices is "Local Search". This means that you will only be able to detect devices that are directly on same network as your laptop, even if communication between your laptop and the device is allowed in the network configuration. In these cases it can be useful to do a "Remote Search", which allows the Device Discovery to be performed from a Crestron device that is on a separate network from your laptop. Remote Search can also be done when connected to a device via USB, which makes it useful in situations where there are no open Ethernet ports or where the technician's laptop is not authorized to connect to the LAN.
174
175 To do a remote search:
176
177 1. Open Device Discovery Tool as normal
178 1. Wait for the initial Local Search to conclude
179 1. Press the button at the bottom of Device Discovery Tool window to select Remote Search
180 1. In the connection bar that should appear at the bottom of the Device Discovery Tool window, use the pencil icon to input the details of the device you want to use for the search
181 1*. Any 3-Series and 4-Series processor can be used to perform a remote search, but some devices (such as CEN-GWEXERs and DIN-CENCN-2s) will not work
182 1. Wait for the Remote Search to conclude
183
184 The below screenshot compares the results of a Local Search from a laptop that is on a 10.44.2.0/24 VLAN to the results of a remote search performed by a processor that is on a 10.44.5.0/24 LAN. Even though the network is configured to allow the laptop on the 10.44.2.0/24 network to connect directly to the processor at 10.44.5.45 on the 10.44.5.0/24 network, we are not able to discover any of the devices on that network when performing a Local Search (left window). When we use the processor for the Remote Search (right window), we are able to discover all 35 devices on t he 10.44.5.0/24 network. 
185 [[image:local-remote search.png||height="513" width="1121"]]
186
187 === Export to Address Book ===
188
189 Address Books [[image:1702589379487-339.png]] provide a convenient way to easily connect to different devices without memorizing all the different IP addresses and credentials for devices on your network. When an Address Book has been created for a job, you are able to connect to specific devices using the dropdown menu on the lower left of the tool instead of manually inputting the IP address or hostname using the Pencil menu. Note that when exporting devices to the Address Book, it is possible to add devices by either Hostname or by IP Address, and if the device settings are modified then it may be necessary to update your Address Book or create a new one.
190
191 To create an Address Book in Toolbox:
192
193 1. Connect to the lighting network and open Device Discovery Tool in Toolbox
194 1. The Device Discovery tool will automatically report how many Ethernet devices have been discovered
195 1. Verify that the expected number of Ethernet devices have been discovered, including any TSWs, GLPACs, DIN-CENCN-2s, etc.
196 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
197 1*. If no devices are discovered, verify that your computer is connected to the network and your IP address is compatible with the network
198 1*. If some devices are missing and you are not filtering the results, then there may be an issue with your DHCP server settings or the network wiring
199 1. Click the "Export..." button below the list of discovered devices
200 1*. If this button says "Address Book", then Toolbox needs to be updated
201 1*. Ensure that you are not filtering out any devices or that you have only filtered out the devices you want to be filtered out
202 1. Select how you would like devices to be saved:
203 1*. Hostname - Recommended for jobs with DHCP servers, though it should be noted that the Address Book must be updated if device hostnames are changed; entries are named with the device hostname by default
204 1*. IP Address - Recommended for jobs with static IP addresses only; entries are named the form "[hostname]_ip" by default
205 [[image:export.png]]
206 1. Click the "New Address Book" button to create a new Address Book with these device
207 1*. Click the "Current Address Book" button to add devices to the currently active Address Book; note that if an Address Book has just been created but not has not yet been made the active address book, then devices will not be added to that Address Book (more likely they will be added to the "Default" address book instead)
208 1*. Devices with the same name and connection method will be overwritten, while devices with new names will be added
209
210 Once a new Address Book has been created, it must be manually selected and made the current Address Book before the new devices will appear in the connection dropdown menu
211
212 1. Open any tool and click the Address Book Menu button on the lower left, or open the Address Book dialog directly from the Tools > Manage Address Book...
213 [[image:addr.png||height="444" width="627"]]
214 1. The currently selected address book is displayed in the "Current Address Book" field, and recently opened Address Books are available in the dropdown menu
215 1. To open an Address Book that has never been open or has not recently been opened, click "Open / New..." and locate the Address Book
216 1*. By default, newly created Address Books are saved to your "Documents\Crestron\Toolbox\AddressBook\" folder
217 1. Click the "Open" button to make the selected Address Book active
218 1. If desired, the "Name" or "Address" column headers can be clicked to change the order devices are displayed in the dropdown menu
219 1*. The up and down arrows at the bottom of the menu can be used to manually re-order devices
220 1. Connection settings for individual entries in the Address Book can be modified by selecting them and then editing their attributes in the menu on the left, including:
221 1*. Connection type (TCP, USB, etc.) and method (SSH, SSL/TLS, etc.)
222 1*. Connection port
223 1*. Credentials
224 1. Right-click on an entry to rename or delete it, or select the entry and use the buttons at the bottom of the menu
225 1. Click "OK" without selecting a device from the list to close the Address Book dialog without connecting to a device, or select a device from the list and click "OK" to connect immediately
226
227 === Export to Device Summary ===
228
229 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.
230
231 To generate a Device Summary in Toolbox:
232
233 1. Connect to the lighting network and open Device Discovery Tool in Toolbox
234 1. The Device Discovery tool will automatically report how many Ethernet devices have been discovered
235 1. Verify that the expected number of Ethernet devices have been discovered, including any TSWs, GLPACs, DIN-CENCN-2s, etc.
236 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
237 1*. If no devices are discovered, verify that your computer is connected to the network and your IP address is compatible with the network
238 1*. If some devices are missing and you are not filtering the results, then there may be an issue with your DHCP server settings or the network wiring
239 1. Click the "Export..." button below the list of discovered devices
240 1*. If this button says "Address Book", then Toolbox needs to be updated
241 1*. Ensure that you are not filtering out any devices or that you have only filtered out the devices you want to be filtered out
242 1. Click the Write Device Summary button and save the Device Summary to your computer
243 1*. Though saved as a text file, the Device Summary is actually a table of comma separated values
244 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
245 1**. Note that this .csv will have whitespace, so you may want to "clean" it using Excel's "=TRIM()" function if you intend to copy/paste it into the takeoff
246
247 Below is an example of a Device Summary for a fully-configured Zūm Wired job:
248
249 * DeviceSummary.txt:
250 [[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" height="201" width="912"]]
251 * DeviceSummary.csv:
252 [[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" height="289" width="752"]]
253
254 == Text Console ==
255
256 Text Console [[image:1663622220065-810.png]] is one of the most important tools in the Crestron Toolbox. Whenever the Chief Integrations' ShowRunnerCLC™ Startup Guide mentions "sending console commands," the Text Console is the tool that is required. Below are some general tips that may come in handy when using the Text Console tool:
257
258 * It recommended to run the command ##broadcast on## as the first command when connecting to a processor, as not running this command means that you will miss important messages from the device
259 * The Text Console buffer (all commands and messages from the current Text Console session) can be saved and exported to .txt and .tblog files by using the "Logging > Save Buffer..." menu above the toolbar
260 * The Text Console buffer is not infinite, and will fill up if a large number of messages are sent and received (indicated by the percentage given in the Text Console window)
261 * Pressing alt-c or right-clicking and selecting "Clear" will clear the Text Console buffer and make it easier to navigate through recent messages
262 * Pressing the up arrow key on your keyboard will cycle through recently sent commands, and pressing tab when a specific command is highlighted will allow you to edit the command before sending it
263 * Commands are generally not case sensitive with the exception of commands relating to credentials (i.e. a user's password) and some specific commands as noted in this guide
264
265 Below are some generally useful console commands for Crestron devices. Note that while most or all Crestron devices will allow for a Text Console connection, only processors with a running and licensed copy of the ShowRunnerCLC™ software will allow the use of the ShowRunner™ specific "##sr##" commands. Text Console commands for specific tasks/functions required by ShowRunnerCLC™ are covered in more detail on the pages that cover those tasks, but the below commands are generally useful for a variety of tasks:
266
267 * It recommended to run the command ##broadcast on## as the first command when connecting to a processor, as not running this command means that you will miss important messages from the device
268 * Use the ##help all## or ##hidhelp all## commands to list all available Crestron-specific commands available (i.e. commands that are available regardless of whether the ShowRunnerCLC™ program is running on the processor)
269 * Use ##sr ?## and ##sradmin ?## commands to view all ShowRunnerCLC™ specific commands available
270 ** These help lists can be further refined by typing out more of the specific command you want to learn about, e.g. ##sr devmgr ?## will show commands related to the ShowRunnerCLC™ device manager
271 * Use ##err sys## command to show the error log (up to the last 500 entries), and use the ##clear err## command to clear the log (useful if you are about to restart the program to diagnose errors and don't want to need to sort through which errors are new and which are from the previous startup)
272 * Many commands can be shortened by typing just enough letters to make the command unique, e.g. ##sr show loads## can be shortened to ##sr sh lo## and ##setlogoffidletime## can be shortened to ##setl##
273 * See our [[frequently used commands page>>doc:SHOWRUNNER™ Setup Guide.Troubleshooting Guide.Advanced Tools.Crestron Command Line.WebHome]] and our [[debug program logic page>>doc:SHOWRUNNER™ Setup Guide.Troubleshooting Guide.Troubleshooting.Debug Program Logic.WebHome]] for some more useful information on using Text Console with ShowRunnerCLC™
274
275 == File Manager ==
276
277 File Manager [[image:1663622340028-319.png]] is an essential tool for transferring files to and from the processor. While the ShowRunnerCLC™ license and configuration files can be loaded through the ShowRunnerHUB™ Web UI, it is still sometimes necessary to use the File Manager tool in certain circumstances (e.g., an Ethernet connection to the device cannot be established or for transferring files that aren't supported through the Web UI, such as custom ShowRunner™ extensions).
278
279 To use File Manager:
280
281 * Open the File Manager tool and connect to your device
282 ** Note that not all devices have accessible storage, so File Manager tool will not always connect even if the device is online
283 [[image:fm1.png||height="155" width="478"]]
284 * Navigate your device's storage using either the navigation bar on the left or by double-clicking into folders on the right
285 ** Note that some older versions of Toolbox only allow navigation using the navigation bar on the left
286 [[image:fm2.png||height="152" width="474"]]
287 * Once you've navigated to the directory that you want to add files to or remove files from
288 ** Copy files to the current directory by either dragging the file from your computer into the File Manager tool or by right-clicking on an empty space and selecting "Copy File(s) From...":
289 [[image:fm3a.png]]
290 ** Copy files from the device ("Send File(s) To...") to your computer or modify files on the device by right-clicking on the file:
291 [[image:fm3b.png]]
292 * For normal Crestron processors (i.e. //not// VC-4 instances), ShowRunnerCLC™ files belong in the following folders (v3.10 and newer):
293 ** ShowRunnerCLC™ license goes into the "NVRAM/sr/" folder
294 ** ShowRunnerCLC™ SrConfig.json configuration file goes into the "NVRAM/sr/default" folder
295 ** Note that older releases ShowRunnerCLC™ use a different file structure
296 ** Note that the "alt-[x]" folders are for ShowRunnerCLC's "Alternate Configuration" feature and are not present in most deployments
297 [[image:fm4.png||height="146" width="456"]]
298
299 == Network Device Tree View ==
300
301 Network Device Tree View [[image:1663622313939-259.png]] is a useful tool for addressing devices and resolving certain issues with networked hardware. Below are just some general tips for using the tool; see our [[device addressing>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Device Addressing.Addressing Devices from Toolbox.WebHome||anchor="HNetworkDeviceTreeView"]] page for specific instructions on how to use the Network Device Tree View for device addressing. The below are some general tips and recommended settings for Network Device Tree View:
302
303 * When connecting to a device for the first time in Network Device Tree View, we recommend making certain changes to the type of information displayed by right-clicking and selecting the "Show Configuration Dialog" option:
304 ** Displaying the Serial Number and TSID is useful for easily identifying devices and determining whether specific devices are online or not
305 ** Displaying the Network ID is useful for easily identifying whether devices have been addressed or not
306 ** Displaying the Net Type is somewhat optional, as it should be apparent whether devices are connected via Cresnet, zummesh, etc. based on the model of device
307 ** Displaying Status is also optional, as this information is also displayed in the form of a colored icon next to the device model
308 [[image:ndtv_settings.png||height="317" width="565"]]
309 * In addition to the above settings, **it is generally recommended to right-click and ensure that "Show by Device Connection" is checked**
310 ** "Show by Device Connection" will group devices by their connection to the host device (e.g., Cresnet devices on a DIN-CENCN-2 will be sorted by the Net that they are connected to, Zūm Wireless devices will be sorted by the ZUM-NETBRIDGE they are connected to, etc.)
311 [[image:ndtv_by connection.png||height="436" width="344"]]
312 ** "Show by Category" can be useful in some situations, particularly when looking at devices on a processor where all of the devices are necessarily on the same net, but it can be confusing since you are not able to tell at a glance how a device is connected (i.e. whether it is on Net 1 or Net 2 of a DIN-CENCN-2) and may result in accidentally misaddressing devices; notice how in the below example there appear to be duplicate network IDs (e.g. a keypad and a GLXP-DIMFLV8 both at ID: 04) that aren't being flagged as duplicates because the devices are actually on different Nets, a detail that is only visible when "Show by Device Connection" is enabled as shown above.
313 [[image:ndtv_by category.png||height="442" width="349"]]
314 * These configuration changes are saved per device type, so once they are made they will not need to be made again unless you are connecting to a new type of device for the first time (e.g. changes made while connected to a DIN-AP4 will apply to all DIN-AP4s, but will not apply to any DIN-CENCN-2s you may connect to later)
315 * If Network Device Tree View has been configured as recommended above, then the interface will look similar to the below for a fully-addressed system with no issues:
316 ** Since all of the devices have been addressed and there are no issues, the Network Device Tree View shows a yellow circle next to each device indicating an "OK" status
317 [[image:ndtv_by connection.png||height="436" width="344"]]
318 ** A new system where all devices are online but have not been re-addressed may look more like the following example, with a red exclamation point indicating duplicate Network IDs
319 [[image:ndtv_all loops.png||height="423" width="339"]]
320 ** Other types of status indicator may include a black circle for "Invalid Network ID" or "Invalid/duplicate TSID or Serial Number"
321 * Right-clicking on an individual device will give many options to resolve common issues, as well as allow for identifying a specific device:
322 ** "Refresh All" use to refresh the list of actively connected devices, necessary e.g. if a Cresnet cable has been connected/disconnected from the device
323 *** F5 is the keyboard shortcut for this function, though in both cases it may be more reliable to completely close and reopen Network Device Tree View to ensure all devices are refreshed
324 ** "Change Network ID..." use to change the Network ID (CID) of a specific device (see our [[device addressing page>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Device Addressing.Addressing Devices from Toolbox.WebHome||anchor="HNetworkDeviceTreeView"]] for more information)
325 *** F2 is the keyboard shortcut for this function
326 ** "Identify This Device..." will put a specific device into "Identify" mode, the specific behavior for which depends on the individual device:
327 *** Note that entering identify mode may stop the ShowRunnerCLC™ program and restart it when exiting identify mode: **to avoid losing progress and placing strain on the processor**, it is recommended to either identify and address all hardware prior to loading the ShowRunnerCLC™ program, or temporarily suspend the program with the console command ##stopprog -p:01## and then resume the program once done identifying all devices with the command ##progreset##
328 *** Some devices will flash an LED (Cresnet keypads, GLS-SIMs, et al.)
329 *** Some devices will flash an LED and make a noise (Cresnet occupancy sensors, most room controllers, et al.)
330 *** Load controllers will typically flash all connected loads
331 ** "Change Serial Number..." is used to change the device's Serial Number (and thus its TSID); this is rarely required and is only necessary in cases where a device reports an invalid or duplicate SN/TSID, or where the reported SN does not match the SN physically printed on the device
332 ** "Open Text Console..." will open a Text Console window directly to the specific selected Cresnet/RFID device (//not// to the host device you are connected to in Network Device Tree View); only recommended for advanced users
333 [[image:ndtv_rc on device.png]]
334
335 == Script Manager ==
336
337 The Script Manager [[image:1663622272369-417.png]] is where Load Scripts can be opened and specific sets of commands executed. Load Scripts are .txt files that allow you to automate certain tasks by connecting to a device and executing a predetermined sequence of commands, and are a powerful tool to save time on-site when you need to run the same or similar set of commands on many devices.
338
339 To use a Load Script with the Load Script Manager:
340
341 * Open the Load Script Manager in Toolbox
342 * Right-click anywhere in the Load Script Manager, select "Load Script...", and locate your Load Script .txt file
343 * The window will populate with all of the different command sets defined in the Load Script
344 ** Ensure that you are connected to your devices by the method required based on the connection type listed in the "Connection" column
345 ** This example script is expecting to connect to devices over Ethernet using their hostname
346 [[image:sm1.png||height="218" width="954"]]
347 * Select the command sets you would like to execute by ctrl+clicking or shift+clicking them and then right-click and "Start Selected" to begin executing the commands
348 ** If no commands are currently running, the "Start All" option will also be available. Note that the number of concurrent command sections may be limited by the load script, so even if "Start All" is selected there may only be e.g. 10 command sets that actually start
349 ** If commands are currently running, you can cancel them using this right-click menu as well
350 [[image:sm2.png]]
351 * While commands are running, their current status and progress are displayed under the various columns displayed in the Script Manager
352 [[image:sm3.png||height="189" width="835"]]
353 * Once a command section has executed all commands, it will display the success or failure of the commands
354 ** In this example, all of the commands failed for different reasons:
355 ** ZUMNET-JBOX-16A-LV-F2D94E commands failed due to the firmware file specified by the script not being in the correct location
356 ** The commands which failed due to an "unknown error" failed because they weren't reachable at the specified connection address due to some quirks with this specific LAN configuration
357 ** The remaining command sections were manually cancelled before they could complete
358 [[image:sm4.png||height="205" width="904"]]
359
360 == Package Update Tool ==
361
362 The Package Update Tool [[image:1663622297411-164.png]] is a very convenient way of [[performing firmware updates>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Updating Firmware.WebHome||anchor="HPackageUpdateTool28.puf29"]] for networked devices and [[loading the ShowRunnerCLC™ program>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Processor Setup.WebHome||anchor="HProgramLoad"]] to processors.
363
364 While the Package Update Tool can be opened from within Toolbox, Chief Integrations does not recommend it as doing so will lock Toolbox until the .puf is finished loading to the device. Instead, we recommend to closing Toolbox (or at least closing any Toolbox connections to devices that you intend to update) and double-clicking the .puf file to open the Package Update Tool in a separate window. This allows you to open multiple instances of the Package Update Tool and load .puf files to multiple devices at once. **Exercise caution when updating firmware for multiple devices simultaneously,** as some devices will reboot as part of the update process which may disrupt connection to downstream devices.
365
366 * Locate the firmware or ShowRunner™ .puf file in Windows Explorer
367 * Double-click the .puf file to open the Package Update Tool
368 [[image:put1.png||height="386" width="416"]]
369 * Use the Address Book or the Pencil icon to connect to your processor and wait for it to connect
370 * Verify that the correct .puf and target device are selected
371 ** Verify the information under "Package Info" matches what is expected for the desired firmware, and re-select the .puf using the "Select..." button if the information is incorrect
372 ** Verify that the information under "Target" matches the device to be updated, and re-select the device using the Address Book or Pencil icon if it is incorrect
373 [[image:put2.png||height="365" width="393"]]
374 * Once you have verified all the information is correct and the Package Update Tool has run its check to see that the firmware is compatible with the device, click the "Update" button to begin the update
375 [[image:put3.png||height="340" width="366"]]
376 * The Package Update Tool will notify you of when it is safe to close, but it is recommended to stay connected if possible in order to verify that the firmware update has been completed successfully
377 [[image:put4.png||height="336" width="362"]]
378
379 = Miscellaneous Tips =
380
381 == VPT COM Server ==
382
383 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]]
384
385 Occasionally, something might go wrong with the VPT COM Server process which will prevent Toolbox from functioning correctly. To solve this problem, take the following steps:
386
387 1. Close Crestron Toolbox
388 1. Press CTRL+SHIFT+ESC to open Windows Task Manager
389 1. Click the "More Details" button to see all processes
390 1. Sort processes alphabetically and look for "VptCOMServer Module (32 bit)" under the "Background Processes" section
391 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
392 1*. If the VptCOMServer process is still running after Toolbox has closed, select it in Task Manager and press End Process to stop it
393 1. Once VptCOMServer is stopped, open Toolbox and see if your issues have been resolved
394
395 == Alternatives to Specific Toolbox Tools ==
396
397 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.
398
399 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.
400
401 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.

Navigation