Changes for page Toolbox Basics

Last modified by Alexander Mott on 2024/03/19 21:00
From version 57.1
edited by Alexander Mott
on 2023/12/14 17:42
Change comment: Upload new image "put2.png", version 1.1
To version 81.1
edited by Alexander Mott
on 2023/12/18 18:36
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,11 +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.
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]]
153 153  
154 154  == Device Discovery Tool ==
155 155  
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:
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:
157 157  
158 158  [[image:device discovery tool numbered.png]]
159 159  
... ... @@ -168,7 +168,7 @@
168 168  
169 169  === Export to Address Book ===
170 170  
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.
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.
172 172  
173 173  To create an Address Book in Toolbox:
174 174  
... ... @@ -233,30 +233,87 @@
233 233  * DeviceSummary.csv:
234 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"]]
235 235  
237 +== Text Console ==
238 +
239 +
236 236  (% class="box warningmessage" %)
237 237  (((
238 238  This section is under construction: please check back at a later date for more information
239 239  )))
240 240  
241 -== Text Console ==
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.
242 242  
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"
247 +- help commands
244 244  
249 +- sr commands
250 +
251 +- link to other pages
252 +
245 245  == File Manager ==
246 246  
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 +* Once you've navigated to the directory that you want to add files to or remove files from
266 +** Copy files to the current directory by either dragging the file from your computer into the File Manager tool or by right-clicking on an empty space and selecting "Copy File(s) From...":
267 +[[image:fm3a.png]]
268 +** Copy files from the device ("Send File(s) To...") to your computer or modify files on the device by right-clicking on the file:
269 +[[image:fm3b.png]]
270 +* For normal Crestron processors (i.e. //not// VC-4 instances), ShowRunnerCLC™ files belong in the following folders (v3.10 and newer):
271 +** ShowRunnerCLC™ license goes into the "NVRAM/sr/" folder
272 +** ShowRunnerCLC™ SrConfig.json configuration file goes into the "NVRAM/sr/default" folder
273 +** Note that older releases ShowRunnerCLC™ use a different file structure
274 +** Note that the "alt-[x]" folders are for ShowRunnerCLC's "Alternate Configuration" feature and are not present in most deployments
275 +[[image:fm4.png||height="146" width="456"]]
276 +
247 247  == Network Device Tree View ==
248 248  
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.
279 +(% class="box warningmessage" %)
280 +(((
281 +This section is under construction: please check back at a later date for more information
282 +)))
250 250  
284 +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.
285 +
251 251  == Script Manager ==
252 252  
288 +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.
289 +
290 +To use a Load Script with the Load Script Manager:
291 +
292 +* Open the Load Script Manager in Toolbox
293 +* Right-click anywhere in the Load Script Manager, select "Load Script...", and locate your Load Script .txt file
294 +* The window will populate with all of the different command sets defined in the Load Script
295 +** Ensure that you are connected to your devices by the method required based on the connection type listed in the "Connection" column
296 +** This example script is expecting to connect to devices over Ethernet using their hostname
297 +[[image:sm1.png||height="218" width="954"]]
298 +* 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
299 +** 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
300 +** If commands are currently running, you can cancel them using this right-click menu as well
301 +[[image:sm2.png]]
302 +* While commands are running, their current status and progress are displayed under the various columns displayed in the Script Manager
303 +[[image:sm3.png||height="189" width="835"]]
304 +* Once a command section has executed all commands, it will display the success or failure of the commands
305 +** In this example, all of the commands failed for different reasons:
306 +** ZUMNET-JBOX-16A-LV-F2D94E commands failed due to the firmware file specified by the script not being in the correct location
307 +** 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
308 +** The remaining command sections were manually cancelled before they could complete
309 +[[image:sm4.png||height="205" width="904"]]
310 +
253 253  == Package Update Tool ==
254 254  
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.
313 +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.
256 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**.
315 +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.
258 258  
259 -* Locate the firmware .puf file in Windows Explorer
317 +* Locate the firmware or ShowRunner™ .puf file in Windows Explorer
260 260  * Double-click the .puf file to open the Package Update Tool
261 261  [[image:put1.png||height="386" width="416"]]
262 262  * Use the Address Book or the Pencil icon to connect to your processor and wait for it to connect
... ... @@ -269,8 +269,6 @@
269 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 270  [[image:put4.png||height="336" width="362"]]
271 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 274  = Miscellaneous Tips =
275 275  
276 276  == VPT COM Server ==
1702589379487-339.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +258 bytes
Content
fm1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +10.2 KB
Content
fm2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +15.4 KB
Content
fm3a.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +1.5 KB
Content
fm3b.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +5.1 KB
Content
fm4.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +29.1 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
sm1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +26.6 KB
Content
sm2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +8.3 KB
Content
sm3.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +30.5 KB
Content
sm4.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +35.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