Changes for page Toolbox Basics

Last modified by Alexander Mott on 2024/03/19 21:00
From version 38.1
edited by Alexander Mott
on 2023/03/28 18:04
Change comment: Deleted image "device discovery tool.png"
To version 45.2
edited by Alexander Mott
on 2023/12/12 22:23
Change comment: (Autosaved)

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  
... ... @@ -84,7 +84,7 @@
84 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 85  1. Use a Cat 5a or Cat 6 cable to connect your laptop to the lighting network at an open port
86 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:
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 88  11. Navigate to Control Panel>Network and Internet>Network Connections
89 89  11. Locate the network adapter that is connected to the lighting network
90 90  11. Right click the network adapter and click "Properties"
... ... @@ -106,7 +106,7 @@
106 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 107  1. Open Toolbox and then open the desired tool
108 108  1. Connect to the device:
109 -1*. If you have created an address book, then select the device from the drop down menu
109 +1*. If you have created an address book (see [[Troubleshooting a Failed Connection>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Preparation.Toolbox Basics.WebHome||anchor="HExporttoAddressBook"]] below), then select the device from the drop down menu
110 110  1*. If you have not created an address book, then you should click the Pencil Icon to open the Manual Connection Menu:
111 111  1*1. Leave the connection type as "TCP"
112 112  1*1. Type in the IP address of the device you wish to connect to
... ... @@ -124,7 +124,6 @@
124 124  
125 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 126  
127 -
128 128  [[image:device discovery tool numbered.png]]
129 129  
130 130  1. Device Model - gives the specific model of the device type
... ... @@ -153,6 +153,7 @@
153 153  1. Click the Write Device Summary button and save the Device Summary to your computer
154 154  1*. Though saved as a text file, the Device Summary is actually a table of comma separated values
155 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
155 +1**. Note that this .csv will have whitespace, so it may be beneficial to "clean" it using Excel's "=TRIM()" function
156 156  
157 157  Below is an example of a Device Summary for a fully-configured Zūm Wired job:
158 158  
... ... @@ -170,7 +170,7 @@
170 170  
171 171  Address Books are useful ways of managing multiple jobs that each have many devices.
172 172  
173 -Note that when exporting devices to the Address Book, it is possible to add devices by either
173 +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.
174 174  
175 175  == Troubleshooting a Failed Connection ==
176 176  
... ... @@ -177,12 +177,25 @@
177 177  "Device refused to identify"
178 178  
179 179  * This message typically means that the device is not online or could not be connected to
180 -* This message will also occur if too many login attempts are made with the incorrect username/password. When this happens, you either need to wait until your IP address is no longer blocked or change your IP address and attempt to login again.
180 +* This message may also occur when a device has blocked your username or IP address due to making too many incorrect login attempts
181 +** 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
182 +** 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
183 +** 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):
184 +*** ##listblockedip## and ##remblockedip## commands can be used to view/unblock an IP address
185 +*** ##listlockeduser## and ##remlockeduser## commands can be used to view/unblock specific users
186 +*** ##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
187 +*** ##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
188 +*** ##setlogoffidletime## command can be used to modify how long you can be inactive before the processor automatically logs you out
181 181  
182 182  "Device not found in database"
183 183  
184 -* 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 all Crestron components are up-to-date
192 +* 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
185 185  
194 +See our FAQ for additional tips:
195 +
196 +* [[I can't connect to my processor via Ethernet?>>https://wiki.chiefintegrations.com/FAQ/I%20can%27t%20connect%20to%20my%20processor%20via%20Ethernet]]
197 +* [[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]]
198 +
186 186  = Basic Tool Usage =
187 187  
188 188  (% class="box warningmessage" %)
... ... @@ -194,6 +194,8 @@
194 194  
195 195  == File Manager ==
196 196  
210 +== Script Manager ==
211 +
197 197  == Network Device Tree View ==
198 198  
199 199  = Miscellaneous =
... ... @@ -202,7 +202,7 @@
202 202  
203 203  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]]
204 204  
205 -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:
220 +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:
206 206  
207 207  1. Close Crestron Toolbox
208 208  1. Press CTRL+SHIFT+ESC to open Windows Task Manager
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