Changes for page Toolbox Basics
Last modified by Alexander Mott on 2024/03/19 21:00
From version 40.1
edited by Alexander Mott
on 2023/03/28 18:05
on 2023/03/28 18:05
Change comment:
There is no comment for this version
To version 49.1
edited by Alexander Mott
on 2023/12/13 19:11
on 2023/12/13 19:11
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
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,11 +106,12 @@ 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 [[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 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 -1*1. Type in the IP address of the device you wish to connect to 112 +1*1. Type in the IP address or Hostname of the device you wish to connect to 113 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" 114 114 1*1. Leave Model, Hostname, and Serial fields blank 115 115 1*1. If the device has authentication enabled, expand the Advanced options and input the username and password 116 116 1*1. Click "OK" ... ... @@ -120,6 +120,34 @@ 120 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 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 122 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 + 123 123 == Device Discovery Tool == 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: ... ... @@ -152,6 +152,7 @@ 152 152 1. Click the Write Device Summary button and save the Device Summary to your computer 153 153 1*. Though saved as a text file, the Device Summary is actually a table of comma separated values 154 154 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 184 +1**. Note that this .csv will have whitespace, so it may be beneficial to "clean" it using Excel's "=TRIM()" function 155 155 156 156 Below is an example of a Device Summary for a fully-configured Zūm Wired job: 157 157 ... ... @@ -164,31 +164,13 @@ 164 164 165 165 (% class="box warningmessage" %) 166 166 ((( 167 -This section is under construction: please check back at a later date for more information on using the Address Book197 +This section is under construction: please check back at a later date for more information 168 168 ))) 169 169 170 -Address Books areusefulwaysofmanagingmultiplejobs thateachhave manydevices.200 +Address Books provide a convenient way to easily connect to different devices without the need to remember different IP addresses or credentials. 171 171 172 -Note that when exporting devices to the Address Book, it is possible to add devices by either 202 +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. 173 173 174 -== Troubleshooting a Failed Connection == 175 - 176 -"Device refused to identify" 177 - 178 -* This message typically means that the device is not online or could not be connected to 179 -* 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 - 181 -"Device not found in database" 182 - 183 -* 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 184 - 185 -= Basic Tool Usage = 186 - 187 -(% class="box warningmessage" %) 188 -((( 189 -This section is under construction: please check back at alater date for more information on using tools in Toolbox 190 -))) 191 - 192 192 == Text Console == 193 193 194 194 == File Manager == ... ... @@ -195,6 +195,10 @@ 195 195 196 196 == Network Device Tree View == 197 197 210 +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. 211 + 212 +== Script Manager == 213 + 198 198 = Miscellaneous = 199 199 200 200 == VPT COM Server == ... ... @@ -201,7 +201,7 @@ 201 201 202 202 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]] 203 203 204 -Occasionally, something go eswrong 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: 205 205 206 206 1. Close Crestron Toolbox 207 207 1. Press CTRL+SHIFT+ESC to open Windows Task Manager