Changes for page Toolbox Basics

Last modified by Alexander Mott on 2024/03/19 21:00
From version 31.1
edited by Alexander Mott
on 2023/02/08 22:24
Change comment: There is no comment for this version
To version 45.1
edited by Alexander Mott
on 2023/12/08 19:23
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -120,33 +120,99 @@
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  
123 -== Device Discovery Tool and Address Book ==
123 +== Device Discovery Tool ==
124 124  
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 +
127 +[[image:device discovery tool numbered.png]]
128 +
129 +1. Device Model - gives the specific model of the device type
130 +1. Device Type - gives an idea of what function the device serves ("Control System", "AV", "Lighting", etc.)
131 +1. Connection and Firmware Information
132 +1*. Ethernet connected devices give their hostname, IP address, and firmware version
133 +1*. USB connected devices give their hostname, serial number, and firmware version
134 +1. Discovery Summary - gives a summary of how long it took to discover devices and how many devices were discovered at each connection type
135 +1. Discover Devices button - press this to restart the discovery process
136 +1. Export... button - use this button to export discovered devices to either a Device Summary or Address Book (covered in more detail below)
137 +
138 +=== Export to Device Summary ===
139 +
140 +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.
141 +
142 +To generate a Device Summary in Toolbox:
143 +
144 +1. Connect to the lighting network and open Device Discovery Tool in Toolbox
145 +1. The Device Discovery tool will automatically report how many Ethernet devices have been discovered
146 +1. Verify that the expected number of Ethernet devices have been discovered, including any TSWs, GLPACs, DIN-CENCN-2s, etc.
147 +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
148 +1*. If no devices are discovered, verify that your computer is connected to the network and your IP address is compatible with the network
149 +1*. If some devices are missing, there may be an issue with your DHCP server settings or the network wiring
150 +1. Click the "Export..." button below the list of discovered devices
151 +1*. If this button says "Address Book", then Toolbox needs to be updated
152 +1. Click the Write Device Summary button and save the Device Summary to your computer
153 +1*. Though saved as a text file, the Device Summary is actually a table of comma separated values
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
155 +1**. Note that this .csv will have whitespace, so it may be beneficial to "clean" it using Excel's "=TRIM()" function
156 +
157 +Below is an example of a Device Summary for a fully-configured Zūm Wired job:
158 +
159 +* DeviceSummary.txt:
160 +[[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"]]
161 +* DeviceSummary.csv:
162 +[[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"]]
163 +
164 +=== Export to Address Book ===
165 +
166 +(% class="box warningmessage" %)
167 +(((
168 +This section is under construction: please check back at a later date for more information on using the Address Book
169 +)))
170 +
125 125  Address Books are useful ways of managing multiple jobs that each have many devices.
126 126  
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 +
127 127  == Troubleshooting a Failed Connection ==
128 128  
129 -"Device refused to identify" (also happens if too many login attempts are made with the wrong username/password)
177 +"Device refused to identify"
130 130  
179 +* This message typically means that the device is not online or could not be connected to
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
189 +
131 131  "Device not found in database"
132 132  
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
193 +
133 133  = Basic Tool Usage =
134 134  
196 +(% class="box warningmessage" %)
197 +(((
198 +This section is under construction: please check back at alater date for more information on using tools in Toolbox
199 +)))
200 +
135 135  == Text Console ==
136 136  
137 137  == File Manager ==
138 138  
205 +== Script Manager ==
206 +
139 139  == Network Device Tree View ==
140 140  
141 -= Toolbox Quirks =
209 += Miscellaneous =
142 142  
143 -Toolbox has some unique quirks that can sometimes cause issues.
144 -
145 145  == VPT COM Server ==
146 146  
147 147  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]]
148 148  
149 -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:
215 +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:
150 150  
151 151  1. Close Crestron Toolbox
152 152  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