Changes for page Toolbox Basics

Last modified by Alexander Mott on 2024/03/19 21:00
From version 77.5
edited by Alexander Mott
on 2023/12/18 17:29
Change comment: (Autosaved)
To version 59.2
edited by Alexander Mott
on 2023/12/14 17:54
Change comment: (Autosaved)

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. 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
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
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,12 +149,11 @@
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]]
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.
154 154  
155 155  == Device Discovery Tool ==
156 156  
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:
156 +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:
158 158  
159 159  [[image:device discovery tool numbered.png]]
160 160  
... ... @@ -169,7 +169,7 @@
169 169  
170 170  === Export to Address Book ===
171 171  
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.
171 +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.
173 173  
174 174  To create an Address Book in Toolbox:
175 175  
... ... @@ -234,81 +234,32 @@
234 234  * DeviceSummary.csv:
235 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"]]
236 236  
237 -== Text Console ==
238 -
239 -
240 240  (% class="box warningmessage" %)
241 241  (((
242 242  This section is under construction: please check back at a later date for more information
243 243  )))
244 244  
245 -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.
241 +== Text Console ==
246 246  
247 -- help commands
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"
248 248  
249 -- sr commands
250 -
251 -- link to other pages
252 -
253 253  == File Manager ==
254 254  
255 -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).
256 -
257 -To use File Manager:
258 -
259 -* Open the File Manager tool and connect to your device
260 -** Note that not all devices have accessible storage, so File Manager tool will not always connect even if the device is online
261 -[[image:fm1.png||height="155" width="478"]]
262 -* Navigate your device's storage using either the navigation bar on the left or by double-clicking into folders on the right
263 -** Note that some older versions of Toolbox only allow navigation using the navigation bar on the left
264 -[[image:fm2.png||height="152" width="474"]]
265 -*
266 -* For normal Crestron processors (i.e. //not// VC-4 instances), ShowRunnerCLC™ files belong in the following folders:
267 -** ShowRunnerCLC™ license goes into the "NVRAM/sr/" folder
268 -** ShowRunnerCLC™ SrConfig.json configuration file goes into the "NVRAM/sr/default" folder
269 -** Note that ShowRunnerCLC™
270 -
271 271  == Network Device Tree View ==
272 272  
273 -(% class="box warningmessage" %)
274 -(((
275 -This section is under construction: please check back at a later date for more information
276 -)))
249 +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.
277 277  
278 -Network Device Tree View [[image:1663622313939-259.png]] is a useful tool for addressing devices and resolving certain issues with networked hardware. See our [[device addressing>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Device Addressing.Addressing Devices from Toolbox.WebHome||anchor="HNetworkDeviceTreeView"]] page for specific instructions on how to use the Network Device Tree View for device addressing.
279 -
280 280  == Script Manager ==
281 281  
282 -The Script Manager [[image:1663622272369-417.png]] is where Load Scripts can be opened and specific sets of commands executed. 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 are a powerful tool to save time on-site when you need to run the same or similar set of commands on many devices.
283 -
284 -To use a Load Script with the Load Script Manager:
285 -
286 -* Open the Load Script Manager in Toolbox
287 -* Right-click anywhere in the Load Script Manager, select "Load Script...", and locate your Load Script .txt file
288 -* The window will populate with all of the different command sets defined in the Load Script
289 -** Ensure that you are connected to your devices by the method required based on the connection type listed in the "Connection" column
290 -** This example script is expecting to connect to devices over Ethernet using their hostname
291 -[[image:sm1.png||height="218" width="954"]]
292 -* Select the command sets you would like to execute by ctrl+clicking or shift+clicking them and then right-click and "Start Selected" to begin executing the commands
293 -** If no commands are currently running, the "Start All" option will also be available. Note that the number of concurrent command sections may be limited by the load script, so even if "Start All" is selected there may only be e.g. 10 command sets that actually start
294 -** If commands are currently running, you can cancel them using this right-click menu as well
295 -[[image:sm2.png]]
296 -* While commands are running, their current status and progress are displayed under the various columns displayed in the Script Manager
297 -[[image:sm3.png||height="189" width="835"]]
298 -* Once a command section has executed all commands, it will display the success or failure of the commands
299 -** In this example, all of the commands failed for different reasons:
300 -** ZUMNET-JBOX-16A-LV-F2D94E commands failed due to the firmware file specified by the script not being in the correct location
301 -** The commands which failed due to an "unknown error" failed because they weren't reachable at the specified connection address due to some quirks with this specific LAN configuration
302 -** The remaining command sections were manually cancelled before they could complete
303 -[[image:sm4.png||height="205" width="904"]]
304 -
305 305  == Package Update Tool ==
306 306  
307 -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.
255 +The Package Update Tool 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.
308 308  
309 -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.
257 +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.
310 310  
311 -* Locate the firmware or ShowRunner™ .puf file in Windows Explorer
259 +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**.
260 +
261 +* Locate the firmware .puf file in Windows Explorer
312 312  * Double-click the .puf file to open the Package Update Tool
313 313  [[image:put1.png||height="386" width="416"]]
314 314  * Use the Address Book or the Pencil icon to connect to your processor and wait for it to connect
... ... @@ -321,6 +321,8 @@
321 321  * 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
322 322  [[image:put4.png||height="336" width="362"]]
323 323  
274 +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.
275 +
324 324  = Miscellaneous Tips =
325 325  
326 326  == VPT COM Server ==
1702589379487-339.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,1 +1,0 @@
1 -258 bytes
Content
fm1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,1 +1,0 @@
1 -10.2 KB
Content
fm2.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,1 +1,0 @@
1 -15.4 KB
Content
sm1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,1 +1,0 @@
1 -26.6 KB
Content
sm2.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,1 +1,0 @@
1 -8.3 KB
Content
sm3.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,1 +1,0 @@
1 -30.5 KB
Content
sm4.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,1 +1,0 @@
1 -35.7 KB
Content
window.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,1 +1,0 @@
1 -14.4 KB
Content