Changes for page Toolbox Basics

Last modified by Alexander Mott on 2024/03/19 21:00
From version 50.9
edited by Alexander Mott
on 2023/12/13 20:40
Change comment: (Autosaved)
To version 26.1
edited by Alexander Mott
on 2022/09/19 23:49
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -28,7 +28,7 @@
28 28  
29 29  = Connecting to Devices =
30 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.
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 32  
33 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 34  
... ... @@ -37,7 +37,7 @@
37 37  These elements have various functions:
38 38  
39 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. 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
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 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 42  1*. [[image:1663625644870-585.png]]
43 43  1. Quick Function Menu (keyboard shortcut: ALT+F) - menu containing a few useful functions
... ... @@ -72,179 +72,29 @@
72 72  
73 73  == Ethernet Connection ==
74 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.
75 +== Device Discovery Tool and Address Book ==
76 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 124  == Troubleshooting a Failed Connection ==
125 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 128  "Device refused to identify"
129 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 141  "Device not found in database"
142 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 150  = Basic Tool Usage =
151 151  
152 -== Device Discovery Tool ==
85 +== Text Console ==
153 153  
154 -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:
155 -
156 -[[image:device discovery tool numbered.png]]
157 -
158 -1. Device Model - gives the specific model of the device type
159 -1. Device Type - gives an idea of what function the device serves ("Control System", "AV", "Lighting", etc.)
160 -1. Connection and Firmware Information
161 -1*. Ethernet connected devices give their hostname, IP address, and firmware version
162 -1*. USB connected devices give their hostname, serial number, and firmware version
163 -1. Discovery Summary - gives a summary of how long it took to discover devices and how many devices were discovered at each connection type
164 -1. Discover Devices button - press this to restart the discovery process
165 -1. Export... button - use this button to export discovered devices to either a Device Summary or Address Book (covered in more detail below)
166 -
167 -=== Export to Address Book ===
168 -
169 -Address Books 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.
170 -
171 -To create an Address Book in Toolbox:
172 -
173 -1. Connect to the lighting network and open Device Discovery Tool in Toolbox
174 -1. The Device Discovery tool will automatically report how many Ethernet devices have been discovered
175 -1. Verify that the expected number of Ethernet devices have been discovered, including any TSWs, GLPACs, DIN-CENCN-2s, etc.
176 -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
177 -1*. If no devices are discovered, verify that your computer is connected to the network and your IP address is compatible with the network
178 -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
179 -1. Click the "Export..." button below the list of discovered devices
180 -1*. If this button says "Address Book", then Toolbox needs to be updated
181 -1*. Ensure that you are not filtering out any devices or that you have only filtered out the devices you want to be filtered ou
182 -1. Select how you would like devices to be saved:
183 -1*. Hostname
184 -1*. IP Address
185 -[[image:export.png]]
186 -1. Click the "New Address Book" button to create a new Address Book with these device
187 -1*. If you want to add newly discovered devices to your current Address Book, click the "Current Address Book" button. Devices with the same name and connection method will be overwritten, while devices with new names will be added
188 -
189 -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
190 -
191 -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...
192 -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
193 -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
194 -1*. By default, newly created Address Books are saved to your "Documents\Crestron\Toolbox\AddressBook\" folder
195 -1. Click the "Open" button to make your new Address Book the active Address Book
196 -1. If desired, the "Name" or "Address" column headers can be clicked to change how devices are sorted
197 -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
198 -
199 -=== Export to Device Summary ===
200 -
201 -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.
202 -
203 -To generate a Device Summary in Toolbox:
204 -
205 -1. Connect to the lighting network and open Device Discovery Tool in Toolbox
206 -1. The Device Discovery tool will automatically report how many Ethernet devices have been discovered
207 -1. Verify that the expected number of Ethernet devices have been discovered, including any TSWs, GLPACs, DIN-CENCN-2s, etc.
208 -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
209 -1*. If no devices are discovered, verify that your computer is connected to the network and your IP address is compatible with the network
210 -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
211 -1. Click the "Export..." button below the list of discovered devices
212 -1*. If this button says "Address Book", then Toolbox needs to be updated
213 -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
214 -1. Click the Write Device Summary button and save the Device Summary to your computer
215 -1*. Though saved as a text file, the Device Summary is actually a table of comma separated values
216 -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
217 -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
218 -
219 -Below is an example of a Device Summary for a fully-configured Zūm Wired job:
220 -
221 -* DeviceSummary.txt:
222 -[[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"]]
223 -* DeviceSummary.csv:
224 -[[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"]]
225 -
226 -(% class="box warningmessage" %)
227 -(((
228 -This section is under construction: please check back at a later date for more information
229 -)))
230 -
231 -=== Text Console ===
232 -
233 -== File Manager ==
234 -
235 235  == Network Device Tree View ==
236 236  
237 -See our [[device addressing>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Device Addressing.Addressing Devices from Toolbox.WebHome||anchor="HNetworkDeviceTreeView"]] page for more specific information on how to use the Network Device Tree View for device addressing purposes.
89 += Toolbox Quirks =
238 238  
239 -== Script Manager ==
91 +Toolbox has some unique quirks that can sometimes cause issues.
240 240  
241 -= Miscellaneous =
242 -
243 243  == VPT COM Server ==
244 244  
245 245  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]]
246 246  
247 -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:
97 +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:
248 248  
249 249  1. Close Crestron Toolbox
250 250  1. Press CTRL+SHIFT+ESC to open Windows Task Manager
... ... @@ -254,10 +254,8 @@
254 254  1*. If the VptCOMServer process is still running after Toolbox has closed, select it in Task Manager and press End Process to stop it
255 255  1. Once VptCOMServer is stopped, open Toolbox and see if your issues have been resolved
256 256  
257 -== Alternatives to Specific Toolbox Tools ==
107 +== Text Console Alternatives ==
258 258  
259 -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.
109 +== File Management Alternatives ==
260 260  
261 -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.
262 -
263 -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.
111 +== Package Update Tool Alternatives ==
device discovery tool numbered.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,1 +1,0 @@
1 -190.2 KB
Content
export.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,1 +1,0 @@
1 -21.5 KB
Content