Changes for page Toolbox Basics

Last modified by Alexander Mott on 2024/03/19 21:00
From version 67.1
edited by Alexander Mott
on 2023/12/14 22:39
Change comment: Uploaded new attachment "sm2.png", version {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
... ... @@ -234,27 +234,80 @@
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 +
237 237  (% class="box warningmessage" %)
238 238  (((
239 239  This section is under construction: please check back at a later date for more information
240 240  )))
241 241  
242 -== Text Console ==
243 -
244 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 245  
247 +- help commands
248 +
249 +- sr commands
250 +
251 +- link to other pages
252 +
246 246  == File Manager ==
247 247  
248 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 249  
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 +
250 250  == Network Device Tree View ==
251 251  
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"]].
279 +(% class="box warningmessage" %)
280 +(((
281 +This section is under construction: please check back at a later date for more information
282 +)))
253 253  
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 +
254 254  == Script Manager ==
255 255  
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.
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.
257 257  
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 +
258 258  == Package Update Tool ==
259 259  
260 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.
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
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