Changes for page Toolbox Basics

Last modified by Alexander Mott on 2024/03/19 21:00
From version 26.6
edited by Alexander Mott
on 2022/10/10 21:57
Change comment: (Autosaved)
To version 46.2
edited by Alexander Mott
on 2023/12/12 22:27
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.
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 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  
... ... @@ -74,31 +74,151 @@
74 74  
75 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 76  
77 -To connect to a device via Ethernet, your laptop must first be connected
77 +To connect to a device via Ethernet, your laptop must first be connected to the lighting network.
78 78  
79 -== Device Discovery Tool and Address Book ==
79 +To connect to the lighting network:
80 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 +
81 81  == Troubleshooting a Failed Connection ==
82 82  
83 83  "Device refused to identify"
84 84  
128 +* This message typically means that the device is not online or could not be connected to
129 +* This message may also occur when a device has blocked your username or IP address due to making too many incorrect login attempts
130 +** 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
131 +** 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
132 +** 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):
133 +*** ##listblockedip## and ##remblockedip## commands can be used to view/unblock an IP address
134 +*** ##listlockeduser## and ##remlockeduser## commands can be used to view/unblock specific users
135 +*** ##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
136 +*** ##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
137 +*** ##setlogoffidletime## command can be used to modify how long you can be inactive before the processor automatically logs you out
138 +
85 85  "Device not found in database"
86 86  
141 +* 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
142 +
143 +See our FAQ for additional tips:
144 +
145 +* [[I can't connect to my processor via Ethernet?>>https://wiki.chiefintegrations.com/FAQ/I%20can%27t%20connect%20to%20my%20processor%20via%20Ethernet]]
146 +* [[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]]
147 +
87 87  = Basic Tool Usage =
88 88  
150 +(% class="box warningmessage" %)
151 +(((
152 +This section is under construction: please check back at alater date for more information on using tools in Toolbox
153 +)))
154 +
155 +== Device Discovery Tool ==
156 +
157 +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:
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 +=== Export to Device Summary ===
171 +
172 +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.
173 +
174 +To generate a Device Summary in Toolbox:
175 +
176 +1. Connect to the lighting network and open Device Discovery Tool in Toolbox
177 +1. The Device Discovery tool will automatically report how many Ethernet devices have been discovered
178 +1. Verify that the expected number of Ethernet devices have been discovered, including any TSWs, GLPACs, DIN-CENCN-2s, etc.
179 +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
180 +1*. If no devices are discovered, verify that your computer is connected to the network and your IP address is compatible with the network
181 +1*. If some devices are missing, there may be an issue with your DHCP server settings or the network wiring
182 +1. Click the "Export..." button below the list of discovered devices
183 +1*. If this button says "Address Book", then Toolbox needs to be updated
184 +1. Click the Write Device Summary button and save the Device Summary to your computer
185 +1*. Though saved as a text file, the Device Summary is actually a table of comma separated values
186 +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
187 +1**. Note that this .csv will have whitespace, so it may be beneficial to "clean" it using Excel's "=TRIM()" function
188 +
189 +Below is an example of a Device Summary for a fully-configured Zūm Wired job:
190 +
191 +* DeviceSummary.txt:
192 +[[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"]]
193 +* DeviceSummary.csv:
194 +[[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"]]
195 +
196 +=== Export to Address Book ===
197 +
198 +(% class="box warningmessage" %)
199 +(((
200 +This section is under construction: please check back at a later date for more information on using the Address Book
201 +)))
202 +
203 +Address Books are useful ways of managing multiple jobs that each have many devices.
204 +
205 +Note that when exporting devices to the Address Book, it is possible to add devices by either Hostname or by IP Address. On systems with a DHCP server, it is recommended to add devices by Hostname, but only after the final hostnames have been set for all devices.
206 +
89 89  == Text Console ==
90 90  
91 -== Network Device Tree View ==
209 +== File Manager ==
92 92  
93 -= Toolbox Quirks =
211 +== Script Manager ==
94 94  
95 -Toolbox has some unique quirks that can sometimes cause issues.
213 +== Network Device Tree View ==
96 96  
215 += Miscellaneous =
216 +
97 97  == VPT COM Server ==
98 98  
99 99  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]]
100 100  
101 -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:
221 +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:
102 102  
103 103  1. Close Crestron Toolbox
104 104  1. Press CTRL+SHIFT+ESC to open Windows Task Manager
... ... @@ -108,8 +108,10 @@
108 108  1*. If the VptCOMServer process is still running after Toolbox has closed, select it in Task Manager and press End Process to stop it
109 109  1. Once VptCOMServer is stopped, open Toolbox and see if your issues have been resolved
110 110  
111 -== Text Console Alternatives ==
231 +== Alternatives to Specific Toolbox Tools ==
112 112  
113 -== File Management Alternatives ==
233 +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.
114 114  
115 -== Package Update Tool Alternatives ==
235 +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.
236 +
237 +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.
device discovery tool numbered.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +190.2 KB
Content