Changes for page Toolbox Basics

Last modified by Alexander Mott on 2024/03/19 21:00
From version 50.2
edited by Alexander Mott
on 2023/12/13 20:05
Change comment: (Autosaved)
To version 45.3
edited by Alexander Mott
on 2023/12/12 22:26
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -121,34 +121,6 @@
121 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 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 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 152  == Device Discovery Tool ==
153 153  
154 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:
... ... @@ -164,30 +164,6 @@
164 164  1. Discover Devices button - press this to restart the discovery process
165 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 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 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.
170 -
171 -
172 -To generate an Address Book in Toolbox:
173 -
174 -1. Connect to the lighting network and open Device Discovery Tool in Toolbox
175 -1. The Device Discovery tool will automatically report how many Ethernet devices have been discovered
176 -1. Verify that the expected number of Ethernet devices have been discovered, including any TSWs, GLPACs, DIN-CENCN-2s, etc.
177 -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
178 -1*. If no devices are discovered, verify that your computer is connected to the network and your IP address is compatible with the network
179 -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
180 -1. Click the "Export..." button below the list of discovered devices
181 -1*. If this button says "Address Book", then Toolbox needs to be updated
182 -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
183 -[[image:export.png]]
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 -To edit a previously created Address Book:
190 -
191 191  === Export to Device Summary ===
192 192  
193 193  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.
... ... @@ -199,11 +199,9 @@
199 199  1. Verify that the expected number of Ethernet devices have been discovered, including any TSWs, GLPACs, DIN-CENCN-2s, etc.
200 200  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
201 201  1*. If no devices are discovered, verify that your computer is connected to the network and your IP address is compatible with the network
202 -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
150 +1*. If some devices are missing, there may be an issue with your DHCP server settings or the network wiring
203 203  1. Click the "Export..." button below the list of discovered devices
204 204  1*. If this button says "Address Book", then Toolbox needs to be updated
205 -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
206 -[[image:export.png]]
207 207  1. Click the Write Device Summary button and save the Device Summary to your computer
208 208  1*. Though saved as a text file, the Device Summary is actually a table of comma separated values
209 209  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
... ... @@ -216,21 +216,56 @@
216 216  * DeviceSummary.csv:
217 217  [[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"]]
218 218  
165 +=== Export to Address Book ===
166 +
219 219  (% class="box warningmessage" %)
220 220  (((
221 -This section is under construction: please check back at a later date for more information
169 +This section is under construction: please check back at a later date for more information on using the Address Book
222 222  )))
223 223  
224 -=== Text Console ===
172 +Address Books are useful ways of managing multiple jobs that each have many devices.
225 225  
226 -== File Manager ==
174 +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.
227 227  
228 -== Network Device Tree View ==
176 +== Troubleshooting a Failed Connection ==
229 229  
230 -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.
178 +"Device refused to identify"
231 231  
180 +* This message typically means that the device is not online or could not be connected to
181 +* This message may also occur when a device has blocked your username or IP address due to making too many incorrect login attempts
182 +** 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
183 +** 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
184 +** 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):
185 +*** ##listblockedip## and ##remblockedip## commands can be used to view/unblock an IP address
186 +*** ##listlockeduser## and ##remlockeduser## commands can be used to view/unblock specific users
187 +*** ##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
188 +*** ##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
189 +*** ##setlogoffidletime## command can be used to modify how long you can be inactive before the processor automatically logs you out
190 +
191 +"Device not found in database"
192 +
193 +* 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
194 +
195 +See our FAQ for additional tips:
196 +
197 +* [[I can't connect to my processor via Ethernet?>>https://wiki.chiefintegrations.com/FAQ/I%20can%27t%20connect%20to%20my%20processor%20via%20Ethernet]]
198 +* [[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]]
199 +
200 += Basic Tool Usage =
201 +
202 +(% class="box warningmessage" %)
203 +(((
204 +This section is under construction: please check back at alater date for more information on using tools in Toolbox
205 +)))
206 +
207 +== Text Console ==
208 +
209 +== File Manager ==
210 +
232 232  == Script Manager ==
233 233  
213 +== Network Device Tree View ==
214 +
234 234  = Miscellaneous =
235 235  
236 236  == VPT COM Server ==
export.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,1 +1,0 @@
1 -21.5 KB
Content