Changes for page Toolbox Basics

Last modified by Alexander Mott on 2024/03/19 21:00
From version 50.9
edited by Alexander Mott
on 2023/12/13 20:40
Change comment: (Autosaved)
To version 65.1
edited by Alexander Mott
on 2023/12/14 21:30
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -36,7 +36,7 @@
36 36  
37 37  These elements have various functions:
38 38  
39 -1. Address Book Menu - Used to view and edit the current address book, or to change the active Address Book to a different Address Book
39 +1. Address Book Menu - Used to view and edit the current address book, or to change the active Address Book to a different Address Book. See [[Troubleshooting a Failed Connection>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Preparation.Toolbox Basics.WebHome||anchor="HExporttoAddressBook"]] below for information about creating an Address Book
40 40  1. Known Device Dropdown - This drop down menu can also be used to connect to devices in the current Address Book. If the currently connected device is in the Address Book, it's name in the Address Book will be displayed here
41 41  1. Manual Connection Menu - This menu is used to manually connect to a device that is not in the current Address Book. It can be used regardless of the connection type or device being connected to:
42 42  1*. [[image:1663625644870-585.png]]
... ... @@ -149,9 +149,12 @@
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. If you have many Tool windows open at once in Toolbox, or if you have only a few Tools open but the window is maximized, then the Window dropdown menu at the top of Toolbox will be useful for navigating the open tools. The Window dropdown has options for cascading/tiling all open tools, as well as a list of open windows to allow easily switching between them:
153 +[[image:window.png]]
154 +
152 152  == Device Discovery Tool ==
153 153  
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:
157 +Crestron's Device Discovery Tool [[image:1663622362685-655.png]] 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:
155 155  
156 156  [[image:device discovery tool numbered.png]]
157 157  
... ... @@ -166,7 +166,7 @@
166 166  
167 167  === Export to Address Book ===
168 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 dropdown menu on the lower left of the tool instead of manually inputting the IP address or hostname using the Pencil menu. Note that when exporting devices to the Address Book, it is possible to add devices by either Hostname or by IP Address, and if the device settings are modified then it may be necessary to update your Address Book or create a new one.
172 +Address Books [[image:1702589379487-339.png]] 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 dropdown menu on the lower left of the tool instead of manually inputting the IP address or hostname using the Pencil menu. Note that when exporting devices to the Address Book, it is possible to add devices by either Hostname or by IP Address, and if the device settings are modified then it may be necessary to update your Address Book or create a new one.
170 170  
171 171  To create an Address Book in Toolbox:
172 172  
... ... @@ -178,22 +178,30 @@
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
184 +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
186 +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
187 +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
190 +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)
191 +1*. Devices with the same name and connection method will be overwritten, while devices with new names will be added
188 188  
189 189  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
190 190  
191 191  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...
196 +[[image:addr.png||height="444" width="627"]]
192 192  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
193 193  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
194 194  1*. By default, newly created Address Books are saved to your "Documents\Crestron\Toolbox\AddressBook\" folder
195 -1. Click the "Open" button to make your new Address Book the active Address Book
196 -1. If desired, the "Name" or "Address" column headers can be clicked to change how devices are sorted
200 +1. Click the "Open" button to make the selected Address Book active
201 +1. If desired, the "Name" or "Address" column headers can be clicked to change the order devices are displayed in the dropdown menu
202 +1*. The up and down arrows at the bottom of the menu can be used to manually re-order devices
203 +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:
204 +1*. Connection type (TCP, USB, etc.) and method (SSH, SSL/TLS, etc.)
205 +1*. Connection port
206 +1*. Credentials
207 +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
197 197  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 ===
... ... @@ -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"]]
233 +[[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"]]
235 +[[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,18 +228,43 @@
228 228  This section is under construction: please check back at a later date for more information
229 229  )))
230 230  
231 -=== Text Console ===
242 +== Text Console ==
232 232  
244 +Text Console [[image:1663622220065-810.png]] is one of the most important tools in the Crestron Toolbox. Whenever the Chief Integrations' ShowRunnerCLC™ Startup Guide mentions "sending console commands," the Text Console is the tool that is required.
245 +
233 233  == File Manager ==
234 234  
248 +File Manager [[image:1663622340028-319.png]] is an essential tool for transferring files to and from the processor. While the ShowRunnerCLC™ license and configuration files can be loaded through the ShowRunnerHUB™ Web UI, it is still sometimes necessary to use the File Manager tool in certain circumstances (e.g., an Ethernet connection to the device cannot be established or for transferring files that aren't supported through the Web UI, such as custom ShowRunner™ extensions).
249 +
235 235  == Network Device Tree View ==
236 236  
237 -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.
252 +Network Device Tree View [[image:1663622313939-259.png]] is a useful tool for [[device addressing>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Device Addressing.Addressing Devices from Toolbox.WebHome||anchor="HNetworkDeviceTreeView"]].
238 238  
239 239  == Script Manager ==
240 240  
241 -= Miscellaneous =
256 +Load Scripts are .txt files that allow you to automate certain tasks by connecting to a device and executing a predetermined sequence of commands, and the Script Manager [[image:1663622272369-417.png]] is where Load Scripts can be opened and executed.
242 242  
258 +== Package Update Tool ==
259 +
260 +The Package Update Tool [[image:1663622297411-164.png]] is a very convenient way of [[performing firmware updates>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Updating Firmware.WebHome||anchor="HPackageUpdateTool28.puf29"]] for networked devices and [[loading the ShowRunnerCLC™ program>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Processor Setup.WebHome||anchor="HProgramLoad"]] to processors.
261 +
262 +While the Package Update Tool can be opened from within Toolbox, Chief Integrations does not recommend it as doing so 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 in a separate window. This allows you to open multiple instances of the Package Update Tool and load .puf files to multiple devices at once. **Exercise caution when updating firmware for multiple devices simultaneously,** as some devices will reboot as part of the update process which may disrupt connection to downstream devices.
263 +
264 +* Locate the firmware or ShowRunner™ .puf file in Windows Explorer
265 +* Double-click the .puf file to open the Package Update Tool
266 +[[image:put1.png||height="386" width="416"]]
267 +* Use the Address Book or the Pencil icon to connect to your processor and wait for it to connect
268 +* Verify that the correct .puf and target device are selected
269 +** 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
270 +** 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
271 +[[image:put2.png||height="365" width="393"]]
272 +* 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
273 +[[image:put3.png||height="340" width="366"]]
274 +* 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
275 +[[image:put4.png||height="336" width="362"]]
276 +
277 += Miscellaneous Tips =
278 +
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]]
1702589379487-339.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +258 bytes
Content
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
put2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +12.4 KB
Content
put3.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +11.7 KB
Content
put4.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +11.7 KB
Content
window.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +14.4 KB
Content