Changes for page Toolbox Basics

Last modified by Alexander Mott on 2024/03/19 21:00
From version 93.1
edited by Alexander Mott
on 2024/01/05 18:52
Change comment: Renamed back-links.
To version 77.8
edited by Alexander Mott
on 2023/12/18 17:44
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 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.
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.
6 6  
7 7  = Initial Toolbox Configuration =
8 8  
... ... @@ -236,25 +236,20 @@
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:
240 240  
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
240 +(% class="box warningmessage" %)
241 +(((
242 +This section is under construction: please check back at a later date for more information
243 +)))
247 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:
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.
249 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.Hardware and Installation.Debug Program Logic.WebHome]] for some more useful information on using Text Console with ShowRunnerCLC™
247 +- help commands
257 257  
249 +- sr commands
250 +
251 +- link to other pages
252 +
258 258  == File Manager ==
259 259  
260 260  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).
... ... @@ -267,53 +267,20 @@
267 267  * Navigate your device's storage using either the navigation bar on the left or by double-clicking into folders on the right
268 268  ** Note that some older versions of Toolbox only allow navigation using the navigation bar on the left
269 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):
265 +*
266 +* For normal Crestron processors (i.e. //not// VC-4 instances), ShowRunnerCLC™ files belong in the following folders:
276 276  ** ShowRunnerCLC™ license goes into the "NVRAM/sr/" folder
277 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"]]
269 +** Note that ShowRunnerCLC™
281 281  
282 282  == Network Device Tree View ==
283 283  
284 -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. The below are some general tips and recommended settings for Network Device Tree View:
273 +(% class="box warningmessage" %)
274 +(((
275 +This section is under construction: please check back at a later date for more information
276 +)))
285 285  
286 -* 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:
287 -** Displaying the Serial Number and TSID is useful for easily identifying devices and determining whether specific devices are online or not
288 -** Displaying the Network ID is useful for easily identifying whether devices have been addressed or not
289 -** 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
290 -** Displaying Status is also optional, as this information is also displayed in the form of a colored icon next to the device model
291 -[[image:ndtv_settings.png||height="317" width="565"]]
292 -* In addition to the above settings, **it is generally recommended to right-click and ensure that "Show by Device Connection" is checked**
293 -** "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.)
294 -[[image:ndtv_by connection.png||height="436" width="344"]]
295 -** "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; notice how in the below example there appear to be duplicate network IDs (e.g. a keypad and a GLXP-DIMFLV8 both at ID: 04) that aren't being flagged as duplicates because the devices are actually on different Nets, a detail that is only visible when "Show by Device Connection" is enabled as shown above.
296 -[[image:ndtv_by category.png||height="442" width="349"]]
297 -* 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)
298 -* If Network Device Tree View has been configured as recommended above, then the interface will look similar to the below for a fully-addressed system with no issues:
299 -** Since all of the devices have been addressed and there are no issues, the Network Device Tree View shows a yellow circle next to each device indicating an "OK" status
300 -[[image:ndtv_by connection.png||height="436" width="344"]]
301 -** A new system where all devices are online but have not been re-addressed may look more like the following example, with a red exclamation point indicating duplicate Network IDs
302 -[[image:ndtv_all loops.png||height="423" width="339"]]
303 -** Other types of status indicator may include a black circle for "Invalid Network ID" or "Invalid/duplicate TSID or Serial Number"
304 -* Right-clicking on an individual device will give many options to resolve common issues, as well as allow for identifying a specific device:
305 -** "Refresh All" use to refresh the list of actively connected devices, necessary e.g. if a Cresnet cable has been connected/disconnected from the device
306 -*** F5 is the keyboard shortcut for this function, though in both cases it may be more reliable to completely close and reopen Network Device Tree View to ensure all devices are refreshed
307 -** "Change Network ID..." use to change the Network ID (CID) of a specific device (see our [[device addressing page>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Device Addressing.Addressing Devices from Toolbox.WebHome||anchor="HNetworkDeviceTreeView"]] for more information)
308 -*** F2 is the keyboard shortcut for this function
309 -** "Identify This Device..." will put a specific device into "Identify" mode, the specific behavior for which depends on the individual device:
310 -*** Note that entering identify mode may stop the ShowRunnerCLC™ program and restart it when exiting identify mode: **to avoid losing progress and placing strain on the processor**, it is recommended to either identify and address all hardware prior to loading the ShowRunnerCLC™ program, or temporarily suspend the program with the console command ##stopprog -p:01## and then resume the program once done identifying all devices with the command ##progreset##
311 -*** Some devices will flash an LED (Cresnet keypads, GLS-SIMs, et al.)
312 -*** Some devices will flash an LED and make a noise (Cresnet occupancy sensors, most room controllers, et al.)
313 -*** Load controllers will typically flash all connected loads
314 -** "Change Serial Number..." is used to change the device's Serial Number (and thus its TSID); this is rarely required and is only necessary in cases where a device reports an invalid or duplicate SN/TSID, or where the reported SN does not match the SN physically printed on the device
315 -** "Open Text Console..." will open a Text Console window directly to the specific selected Cresnet/RFID device (//not// to the host device you are connected to in Network Device Tree View); only recommended for advanced users
316 -[[image:ndtv_rc on device.png]]
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.
317 317  
318 318  == Script Manager ==
319 319  
fm3a.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,1 +1,0 @@
1 -1.5 KB
Content
fm3b.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,1 +1,0 @@
1 -5.1 KB
Content
fm4.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,1 +1,0 @@
1 -29.1 KB
Content
ndtv_all loops.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,1 +1,0 @@
1 -61.4 KB
Content
ndtv_by category.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,1 +1,0 @@
1 -353.9 KB
Content
ndtv_by connection.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,1 +1,0 @@
1 -332.0 KB
Content
ndtv_rc on device.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,1 +1,0 @@
1 -101.5 KB
Content
ndtv_settings.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,1 +1,0 @@
1 -36.2 KB
Content