Changes for page Toolbox Basics

Last modified by Alexander Mott on 2024/03/19 21:00
From version 80.1
edited by Alexander Mott
on 2023/12/18 18:36
Change comment: Uploaded new attachment "fm4.png", version {1}
To version 89.2
edited by Alexander Mott
on 2023/12/18 22:17
Change comment: (Autosaved)

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  
... ... @@ -236,20 +236,25 @@
236 236  
237 237  == Text Console ==
238 238  
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:
239 239  
240 -(% class="box warningmessage" %)
241 -(((
242 -This section is under construction: please check back at a later date for more information
243 -)))
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
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.
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:
246 246  
247 -- help commands
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™
248 248  
249 -- sr commands
250 -
251 -- link to other pages
252 -
253 253  == File Manager ==
254 254  
255 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).
... ... @@ -262,11 +262,17 @@
262 262  * Navigate your device's storage using either the navigation bar on the left or by double-clicking into folders on the right
263 263  ** Note that some older versions of Toolbox only allow navigation using the navigation bar on the left
264 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:
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):
267 267  ** ShowRunnerCLC™ license goes into the "NVRAM/sr/" folder
268 268  ** ShowRunnerCLC™ SrConfig.json configuration file goes into the "NVRAM/sr/default" folder
269 -** Note that ShowRunnerCLC™
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"]]
270 270  
271 271  == Network Device Tree View ==
272 272  
... ... @@ -275,8 +275,23 @@
275 275  This section is under construction: please check back at a later date for more information
276 276  )))
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.
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.
279 279  
291 +Initial configuration:
292 +
293 +* When connecting to a device for the first time in Network Device Tree View, we recommend making certain changes to the type of information displayed by right-clicking and selecting the "Show Configuration Dialog" option:
294 +** Displaying the Serial Number and TSID is useful for easily identifying devices and determining whether specific devices are online or not
295 +** Displaying the Network ID is useful for easily identifying whether devices have been addressed or not
296 +** 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
297 +** Displaying Status is also optional, as this information is also displayed in the form of a colored icon next to the device model
298 +[[image:ndtv_settings.png||height="317" width="565"]]
299 +* In addition to the above settings, **it is generally recommended to right-click and ensure that "Show by Device Connection" is checked**
300 +** "Show by Device Connection" will group devices by their connection to the host device (e.g., Cresnet devices on a DIN-CENCN-2 will be sorted by the Net that they are connected to, Zūm Wireless devices will be sorted by the ZUM-NETBRIDGE they are connected to, etc.)
301 +** "Show by Category" can be useful in some situations, particularly when looking at devices on a processor where all of the devices are necessarily on the same net, but it can be confusing since you are not able to tell at a glance how a device is connected (i.e. whether it is on Net 1 or Net 2 of a DIN-CENCN-2) and may result in accidentally misaddressing devices
302 +* 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)
303 +
304 +If the
305 +
280 280  == Script Manager ==
281 281  
282 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.
ndtv_by category.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +353.9 KB
Content
ndtv_by connection.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +332.0 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