Changes for page Toolbox Basics

Last modified by Alexander Mott on 2024/03/19 21:00
From version 50.4
edited by Alexander Mott
on 2023/12/13 20:15
Change comment: (Autosaved)
To version 55.1
edited by Alexander Mott
on 2023/12/14 17:39
Change comment: There is no comment for this version

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,19 +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*. asdf
184 -1*. asdfre that you are not filtering out any devices or that you have only filtered out the devices you want to be filtered out(((
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 -)))
187 -1. (((
188 -asdf
189 -)))
188 +1. Click the "New Address Book" button to create a new Address Book with these device
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
190 190  
191 -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
192 192  
193 -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
194 194  
195 195  === Export to Device Summary ===
196 196  
... ... @@ -215,9 +215,9 @@
215 215  Below is an example of a Device Summary for a fully-configured Zūm Wired job:
216 216  
217 217  * DeviceSummary.txt:
218 -[[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"]]
219 219  * DeviceSummary.csv:
220 -[[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"]]
221 221  
222 222  (% class="box warningmessage" %)
223 223  (((
... ... @@ -224,8 +224,10 @@
224 224  This section is under construction: please check back at a later date for more information
225 225  )))
226 226  
227 -=== Text Console ===
241 +== Text Console ==
228 228  
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 +
229 229  == File Manager ==
230 230  
231 231  == Network Device Tree View ==
... ... @@ -234,8 +234,14 @@
234 234  
235 235  == Script Manager ==
236 236  
237 -= Miscellaneous =
253 +== Package Update Tool ==
238 238  
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 +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.
258 +
259 += Miscellaneous Tips =
260 +
239 239  == VPT COM Server ==
240 240  
241 241  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