Changes for page Toolbox Basics

Last modified by Alexander Mott on 2024/03/19 21:00
From version 50.8
edited by Alexander Mott
on 2023/12/13 20:35
Change comment: (Autosaved)
To version 56.1
edited by Alexander Mott
on 2023/12/14 17:42
Change comment: Upload new image "put1.png", version 1.1

Summary

Details

Page properties
Content
... ... @@ -149,6 +149,8 @@
149 149  
150 150  = Basic Tool Usage =
151 151  
152 +Crestron Toolbox has many tools that are essential for starting up or troubleshooting any ShowRunnerCLC™ installation. The tools covered here are the most commonly used in commercial lighting contexts, but it should be noted that this list is by no means exhaustive.
153 +
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:
... ... @@ -178,23 +178,31 @@
178 178  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
179 179  1. Click the "Export..." button below the list of discovered devices
180 180  1*. If this button says "Address Book", then Toolbox needs to be updated
181 -1*. Ensure that you are not filtering out any devices or that you have only filtered out the devices you want to be filtered ou
183 +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
182 182  1. Select how you would like devices to be saved:
183 -1*. Hostname
184 -1*. IP Address
185 +1*. Hostname - Recommended for jobs with DHCP servers, though it should be noted that the Address Book must be updated if device hostnames are changed; entries are named with the device hostname by default
186 +1*. IP Address - Recommended for jobs with static IP addresses only; entries are named the form "[hostname]_ip" by default
185 185  [[image:export.png]]
186 186  1. Click the "New Address Book" button to create a new Address Book with these device
187 -1*. If you want to add newly discovered devices to your current Address Book, click the "Current Address Book" button. Devices with the same name and connection method will be overwritten, while devices with new names will be added
188 -1. Once a new Address Book has been created, it must be manually selected before the new devices will appear in the connection dropdown menu
189 -1*. Open a tool and click the Address Book Menu button on the lower left
190 -1*. In the Address Book dialog menu, click "Open / New..." and locate your new Address Book
191 -1*. Click the "Open" button to make your new Address Book the active Address Book
192 -1*. If desired, the "Name" or "Address" column headers can be clicked to change how devices are sorted
193 -1*. Click "OK" without selecting a device from the list to close the Address Book dialog without connecting to a device, or select a device from the list and click "OK" to connect immediately
189 +1*. Click the "Current Address Book" button to add devices to the currently active Address Book; note that if an Address Book has just been created but not has not yet been made the active address book, then devices will not be added to that Address Book (more likely they will be added to the "Default" address book instead)
190 +1*. Devices with the same name and connection method will be overwritten, while devices with new names will be added
194 194  
195 -To edit a previously created Address Book:
192 +Once a new Address Book has been created, it must be manually selected and made the current Address Book before the new devices will appear in the connection dropdown menu
196 196  
197 -1.
194 +1. Open any tool and click the Address Book Menu button on the lower left, or open the Address Book dialog directly from the Tools > Manage Address Book...
195 +[[image:addr.png||height="444" width="627"]]
196 +1. The currently selected address book is displayed in the "Current Address Book" field, and recently opened Address Books are available in the dropdown menu
197 +1. To open an Address Book that has never been open or has not recently been opened, click "Open / New..." and locate the Address Book
198 +1*. By default, newly created Address Books are saved to your "Documents\Crestron\Toolbox\AddressBook\" folder
199 +1. Click the "Open" button to make the selected Address Book active
200 +1. If desired, the "Name" or "Address" column headers can be clicked to change the order devices are displayed in the dropdown menu
201 +1*. The up and down arrows at the bottom of the menu can be used to manually re-order devices
202 +1. Connection settings for individual entries in the Address Book can be modified by selecting them and then editing their attributes in the menu on the left, including:
203 +1*. Connection type (TCP, USB, etc.) and method (SSH, SSL/TLS, etc.)
204 +1*. Connection port
205 +1*. Credentials
206 +1. Right-click on an entry to rename or delete it, or select the entry and use the buttons at the bottom of the menu
207 +1. Click "OK" without selecting a device from the list to close the Address Book dialog without connecting to a device, or select a device from the list and click "OK" to connect immediately
198 198  
199 199  === Export to Device Summary ===
200 200  
... ... @@ -219,9 +219,9 @@
219 219  Below is an example of a Device Summary for a fully-configured Zūm Wired job:
220 220  
221 221  * DeviceSummary.txt:
222 -[[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"]]
232 +[[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" height="201" width="912"]]
223 223  * DeviceSummary.csv:
224 -[[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"]]
234 +[[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" height="289" width="752"]]
225 225  
226 226  (% class="box warningmessage" %)
227 227  (((
... ... @@ -228,8 +228,10 @@
228 228  This section is under construction: please check back at a later date for more information
229 229  )))
230 230  
231 -=== Text Console ===
241 +== Text Console ==
232 232  
243 +Text Console is one of the most important tools in the Crestron Toolbox. Throughout the Chief Integrations' ShowRunnerCLC™ Startup Guide, you will see references to sending "console commands"
244 +
233 233  == File Manager ==
234 234  
235 235  == Network Device Tree View ==
... ... @@ -238,8 +238,29 @@
238 238  
239 239  == Script Manager ==
240 240  
241 -= Miscellaneous =
253 +== Package Update Tool ==
242 242  
255 +The Package Update Tool can be used to load .puf files to devices, typically in order to [[update firmware>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Updating Firmware.WebHome||anchor="HPackageUpdateTool28.puf29"]] or [[load the ShowRunnerCLC™ program>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Processor Setup.WebHome||anchor="HProgramLoad"]] to processors. While the Package Update Tool can be opened from within Toolbox, Chief Integrations does not recommend it as loading a .puf file this way will lock Toolbox until the .puf is finished loading to the device. Instead, we recommend to closing Toolbox (or at least closing any Toolbox connections to devices that you intend to update) and double-clicking the .puf file to open the Package Update Tool. This allows you to open multiple instances of the Package Update Tool and load .puf files to multiple devices at once.
256 +
257 +Crestron's Package Update Tool is the most convenient way of performing firmware updates for devices that use .puf files for firmware. The Package Update Tool can be opened from Toolbox, but doing this will lock Toolbox and only allow updating one device at a time, so we recommend instead that you double-click the .puf file directly. Double-clicking a .puf file will allow you to open multiple instance of the Package Update Tool and enable updating multiple devices simultaneously. Once again, **be careful when updating multiple devices simultaneously not to do anything that would disrupt your connection to a device while transferring the .puf file, nor should you do anything that could result in the device rebooting while it is mid-update**.
258 +
259 +* Locate the firmware .puf file in Windows Explorer
260 +* Double-click the .puf file to open the Package Update Tool
261 +[[image:put1.png||height="386" width="416"]]
262 +* Use the Address Book or the Pencil icon to connect to your processor and wait for it to connect
263 +* Verify that the correct .puf and target device are selected
264 +** Verify the information under "Package Info" matches what is expected for the desired firmware, and re-select the .puf using the "Select..." button if the information is incorrect
265 +** Verify that the information under "Target" matches the device to be updated, and re-select the device using the Address Book or Pencil icon if it is incorrect
266 +[[image:put2.png||height="365" width="393"]]
267 +* Once you have verified all the information is correct and the Package Update Tool has run its check to see that the firmware is compatible with the device, click the "Update" button to begin the update
268 +[[image:put3.png||height="340" width="366"]]
269 +* The Package Update Tool will notify you of when it is safe to close, but it is recommended to stay connected if possible in order to verify that the firmware update has been completed successfully
270 +[[image:put4.png||height="336" width="362"]]
271 +
272 +Please see our other pages on [[firmware updates>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Updating Firmware.WebHome||anchor="HPackageUpdateTool28.puf29"]] and [[loading the ShowRunnerCLC™ program>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Processor Setup.WebHome||anchor="HProgramLoad"]] for more detailed information on how to use the Package Update Tool.
273 +
274 += Miscellaneous Tips =
275 +
243 243  == VPT COM Server ==
244 244  
245 245  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]]
addr.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +26.4 KB
Content
put1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +9.5 KB
Content