Changes for page Toolbox Basics

Last modified by Alexander Mott on 2024/03/19 21:00
From version 70.1
edited by Alexander Mott
on 2023/12/14 22:54
Change comment: Uploaded new attachment "sm4.png", version {1}
To version 87.2
edited by Alexander Mott
on 2023/12/18 22:07
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -2,7 +2,7 @@
2 2  {{toc/}}
3 3  {{/box}}
4 4  
5 -[[Crestron's Toolbox>>url:https://www.crestron.com/Products/Control-Hardware-Software/Software/Development-Software/SW-TB]] software is vital to being able to startup any Crestron lighting control job. The intent of this article is to familiarize a new lighting control tech with the very basics of the various Tools available within the Crestron Toolbox software; detailed information can be access anytime from within Toolbox by pressing the F1 function key to open the Crestron Toolbox Help Menu. If a tool window is the active window, pressing F1 will open the Crestron Toolbox Help Menu to the specific page for that tool.
5 +[[Crestron's Toolbox>>url:https://www.crestron.com/Products/Control-Hardware-Software/Software/Development-Software/SW-TB]] software is vital to starting up any Crestron lighting control job. The intent of this article is to familiarize a new lighting control tech with the very basics of the various Tools available within the Crestron Toolbox software; detailed information can be access anytime from within Toolbox by pressing the F1 function key to open the Crestron Toolbox Help Menu. If a tool window is the active window, pressing F1 will open the Crestron Toolbox Help Menu to the specific page for that tool.
6 6  
7 7  = Initial Toolbox Configuration =
8 8  
... ... @@ -234,27 +234,98 @@
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 -(% class="box warningmessage" %)
238 -(((
239 -This section is under construction: please check back at a later date for more information
240 -)))
241 -
242 242  == Text Console ==
243 243  
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.
239 +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. Below are some general tips that may come in handy when using the Text Console tool:
245 245  
241 +* It recommended to run the command ##broadcast on## as the first command when connecting to a processor, as not running this command means that you will miss important messages from the device
242 +* The Text Console buffer (all commands and messages from the current Text Console session) can be saved and exported to .txt and .tblog files by using the "Logging > Save Buffer..." menu above the toolbar
243 +* The Text Console buffer is not infinite, and will fill up if a large number of messages are sent and received (indicated by the percentage given in the Text Console window)
244 +* Pressing alt-c or right-clicking and selecting "Clear" will clear the Text Console buffer and make it easier to navigate through recent messages
245 +* Pressing the up arrow key on your keyboard will cycle through recently sent commands, and pressing tab when a specific command is highlighted will allow you to edit the command before sending it
246 +* Commands are generally not case sensitive with the exception of commands relating to credentials (i.e. a user's password) and some specific commands as noted in this guide
247 +
248 +Below are some generally useful console commands for Crestron devices. Note that while most or all Crestron devices will allow for a Text Console connection, only processors with a running and licensed copy of the ShowRunnerCLC™ software will allow the use of the ShowRunner™ specific "##sr##" commands. Text Console commands for specific tasks/functions required by ShowRunnerCLC™ are covered in more detail on the pages that cover those tasks, but the below commands are generally useful for a variety of tasks:
249 +
250 +* It recommended to run the command ##broadcast on## as the first command when connecting to a processor, as not running this command means that you will miss important messages from the device
251 +* Use the ##help all## or ##hidhelp all## commands to list all available Crestron-specific commands available (i.e. commands that are available regardless of whether the ShowRunnerCLC™ program is running on the processor)
252 +* Use ##sr ?## and ##sradmin ?## commands to view all ShowRunnerCLC™ specific commands available
253 +** These help lists can be further refined by typing out more of the specific command you want to learn about, e.g. ##sr devmgr ?## will show commands related to the ShowRunnerCLC™ device manager
254 +* Use ##err sys## command to show the error log (up to the last 500 entries), and use the ##clear err## command to clear the log (useful if you are about to restart the program to diagnose errors and don't want to need to sort through which errors are new and which are from the previous startup)
255 +* Many commands can be shortened by typing just enough letters to make the command unique, e.g. ##sr show loads## can be shortened to ##sr sh lo## and ##setlogoffidletime## can be shortened to ##setl##
256 +* See our [[frequently used commands page>>doc:SHOWRUNNER™ Setup Guide.Troubleshooting Guide.Advanced Tools.Crestron Command Line.WebHome]] and our [[debug program logic page>>doc:SHOWRUNNER™ Setup Guide.Troubleshooting Guide.Troubleshooting.Debug Program Logic.WebHome]] for some more useful information on using Text Console with ShowRunnerCLC™
257 +
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  
262 +To use File Manager:
263 +
264 +* Open the File Manager tool and connect to your device
265 +** Note that not all devices have accessible storage, so File Manager tool will not always connect even if the device is online
266 +[[image:fm1.png||height="155" width="478"]]
267 +* Navigate your device's storage using either the navigation bar on the left or by double-clicking into folders on the right
268 +** Note that some older versions of Toolbox only allow navigation using the navigation bar on the left
269 +[[image:fm2.png||height="152" width="474"]]
270 +* Once you've navigated to the directory that you want to add files to or remove files from
271 +** 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...":
272 +[[image:fm3a.png]]
273 +** Copy files from the device ("Send File(s) To...") to your computer or modify files on the device by right-clicking on the file:
274 +[[image:fm3b.png]]
275 +* For normal Crestron processors (i.e. //not// VC-4 instances), ShowRunnerCLC™ files belong in the following folders (v3.10 and newer):
276 +** ShowRunnerCLC™ license goes into the "NVRAM/sr/" folder
277 +** ShowRunnerCLC™ SrConfig.json configuration file goes into the "NVRAM/sr/default" folder
278 +** Note that older releases ShowRunnerCLC™ use a different file structure
279 +** Note that the "alt-[x]" folders are for ShowRunnerCLC's "Alternate Configuration" feature and are not present in most deployments
280 +[[image:fm4.png||height="146" width="456"]]
281 +
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"]].
284 +(% class="box warningmessage" %)
285 +(((
286 +This section is under construction: please check back at a later date for more information
287 +)))
253 253  
289 +Network Device Tree View [[image:1663622313939-259.png]] is a useful tool for addressing devices and resolving certain issues with networked hardware. Below are just some general tips for using the tool; 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.
290 +
291 +Initial configuration:
292 +
293 +* When opening Network Device Tree View, we recommend making certain changes to the type of information displayed
294 +* These changes can be made once you are connected to a device by right-clicking and selecting the "Show Configuration Dialog" option:
295 +** Displaying the Serial Number and TSID is useful for easily identifying devices and determining whether specific devices are online or not
296 +** Displaying the Network ID is useful for easily identifying whether devices have been addressed or not
297 +** Displaying the Net Type is somewhat optional, as it should be apparent whether devices are connected via Cresnet, zummesh, etc. based on the model of device you are connected to
298 +** Displaying Status is also optional, as this information is also displayed in the form of a colored icon next to the device model
299 +[[image:ndtv_settings.png||height="317" width="565"]]
300 +* These configuration changes are saved per device type, so once they are made they will not need to be made again unless you are connecting to a new type of device for the first time (e.g. changes made while connected to a DIN-AP4 will apply to all DIN-AP4s, but will not apply to any DIN-CENCN-2s you may connect to later)
301 +
302 +I
303 +
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.
306 +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  
308 +To use a Load Script with the Load Script Manager:
309 +
310 +* Open the Load Script Manager in Toolbox
311 +* Right-click anywhere in the Load Script Manager, select "Load Script...", and locate your Load Script .txt file
312 +* The window will populate with all of the different command sets defined in the Load Script
313 +** Ensure that you are connected to your devices by the method required based on the connection type listed in the "Connection" column
314 +** This example script is expecting to connect to devices over Ethernet using their hostname
315 +[[image:sm1.png||height="218" width="954"]]
316 +* 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
317 +** 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
318 +** If commands are currently running, you can cancel them using this right-click menu as well
319 +[[image:sm2.png]]
320 +* While commands are running, their current status and progress are displayed under the various columns displayed in the Script Manager
321 +[[image:sm3.png||height="189" width="835"]]
322 +* Once a command section has executed all commands, it will display the success or failure of the commands
323 +** In this example, all of the commands failed for different reasons:
324 +** ZUMNET-JBOX-16A-LV-F2D94E commands failed due to the firmware file specified by the script not being in the correct location
325 +** 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
326 +** The remaining command sections were manually cancelled before they could complete
327 +[[image:sm4.png||height="205" width="904"]]
328 +
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
ndtv_settings.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +36.2 KB
Content