Changes for page Toolbox Basics

Last modified by Alexander Mott on 2024/03/19 21:00
From version 59.4
edited by Alexander Mott
on 2023/12/14 17:59
Change comment: (Autosaved)
To version 89.1
edited by Alexander Mott
on 2023/12/18 22:16
Change comment: Uploaded new attachment "ndtv_by category.png", version {1}

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  
... ... @@ -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,26 +233,103 @@
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 +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 +
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 +
258 +== File Manager ==
259 +
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).
261 +
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 +
282 +== Network Device Tree View ==
283 +
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 ==
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.
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"
291 +Initial configuration:
244 244  
245 -== File Manager ==
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)
246 246  
247 -== Network Device Tree View ==
304 +If the
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.
250 -
251 251  == Script Manager ==
252 252  
308 +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.
309 +
310 +To use a Load Script with the Load Script Manager:
311 +
312 +* Open the Load Script Manager in Toolbox
313 +* Right-click anywhere in the Load Script Manager, select "Load Script...", and locate your Load Script .txt file
314 +* The window will populate with all of the different command sets defined in the Load Script
315 +** Ensure that you are connected to your devices by the method required based on the connection type listed in the "Connection" column
316 +** This example script is expecting to connect to devices over Ethernet using their hostname
317 +[[image:sm1.png||height="218" width="954"]]
318 +* 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
319 +** 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
320 +** If commands are currently running, you can cancel them using this right-click menu as well
321 +[[image:sm2.png]]
322 +* While commands are running, their current status and progress are displayed under the various columns displayed in the Script Manager
323 +[[image:sm3.png||height="189" width="835"]]
324 +* Once a command section has executed all commands, it will display the success or failure of the commands
325 +** In this example, all of the commands failed for different reasons:
326 +** ZUMNET-JBOX-16A-LV-F2D94E commands failed due to the firmware file specified by the script not being in the correct location
327 +** 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
328 +** The remaining command sections were manually cancelled before they could complete
329 +[[image:sm4.png||height="205" width="904"]]
330 +
253 253  == Package Update Tool ==
254 254  
255 -The Package Update Tool 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.
333 +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 257  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  
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
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
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