Changes for page Toolbox Basics
Last modified by Alexander Mott on 2024/03/19 21:00
From version 64.1
edited by Alexander Mott
on 2023/12/14 21:29
on 2023/12/14 21:29
Change comment:
Uploaded new attachment "1702589379487-339.png", version {1}
Summary
-
Page properties (1 modified, 0 added, 0 removed)
-
Attachments (0 modified, 0 added, 7 removed)
Details
- Page properties
-
- Content
-
... ... @@ -149,12 +149,9 @@ 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. 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]] 154 - 155 155 == Device Discovery Tool == 156 156 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:154 +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: 158 158 159 159 [[image:device discovery tool numbered.png]] 160 160 ... ... @@ -181,30 +181,22 @@ 181 181 1*. If some devices are missing and you are not filtering the results, then there may be an issue with your DHCP server settings or the network wiring 182 182 1. Click the "Export..." button below the list of discovered devices 183 183 1*. If this button says "Address Book", then Toolbox needs to be updated 184 -1*. Ensure that you are not filtering out any devices or that you have only filtered out the devices you want to be filtered ou t181 +1*. Ensure that you are not filtering out any devices or that you have only filtered out the devices you want to be filtered ou 185 185 1. Select how you would like devices to be saved: 186 -1*. Hostname - Recommended for jobs with DHCP servers, though it should be noted that the Address Book must be updated if device hostnames are changed; entries are named with the device hostname by default187 -1*. IP Address - Recommended for jobs with static IP addresses only; entries are named the form "[hostname]_ip" by default183 +1*. Hostname 184 +1*. IP Address 188 188 [[image:export.png]] 189 189 1. Click the "New Address Book" button to create a new Address Book with these device 190 -1*. Click the "Current Address Book" button to add devices to the currently active Address Book; note that if an Address Book has just been created but not has not yet been made the active address book, then devices will not be added to that Address Book (more likely they will be added to the "Default" address book instead) 191 -1*. Devices with the same name and connection method will be overwritten, while devices with new names will be added 187 +1*. If you want to add newly discovered devices to your current Address Book, click the "Current Address Book" button. Devices with the same name and connection method will be overwritten, while devices with new names will be added 192 192 193 193 Once a new Address Book has been created, it must be manually selected and made the current Address Book before the new devices will appear in the connection dropdown menu 194 194 195 195 1. Open any tool and click the Address Book Menu button on the lower left, or open the Address Book dialog directly from the Tools > Manage Address Book... 196 -[[image:addr.png||height="444" width="627"]] 197 197 1. The currently selected address book is displayed in the "Current Address Book" field, and recently opened Address Books are available in the dropdown menu 198 198 1. To open an Address Book that has never been open or has not recently been opened, click "Open / New..." and locate the Address Book 199 199 1*. By default, newly created Address Books are saved to your "Documents\Crestron\Toolbox\AddressBook\" folder 200 -1. Click the "Open" button to make the selected Address Book active 201 -1. If desired, the "Name" or "Address" column headers can be clicked to change the order devices are displayed in the dropdown menu 202 -1*. The up and down arrows at the bottom of the menu can be used to manually re-order devices 203 -1. Connection settings for individual entries in the Address Book can be modified by selecting them and then editing their attributes in the menu on the left, including: 204 -1*. Connection type (TCP, USB, etc.) and method (SSH, SSL/TLS, etc.) 205 -1*. Connection port 206 -1*. Credentials 207 -1. Right-click on an entry to rename or delete it, or select the entry and use the buttons at the bottom of the menu 195 +1. Click the "Open" button to make your new Address Book the active Address Book 196 +1. If desired, the "Name" or "Address" column headers can be clicked to change how devices are sorted 208 208 1. Click "OK" without selecting a device from the list to close the Address Book dialog without connecting to a device, or select a device from the list and click "OK" to connect immediately 209 209 210 210 === Export to Device Summary === ... ... @@ -230,9 +230,9 @@ 230 230 Below is an example of a Device Summary for a fully-configured Zūm Wired job: 231 231 232 232 * DeviceSummary.txt: 233 -[[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/1655487020590-542.png?rev=1.1||alt="1655487020590-542.png" height="201" width="912"]]222 +[[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/1655487020590-542.png?rev=1.1||alt="1655487020590-542.png"]] 234 234 * DeviceSummary.csv: 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"]]224 +[[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"]] 236 236 237 237 (% class="box warningmessage" %) 238 238 ((( ... ... @@ -239,43 +239,18 @@ 239 239 This section is under construction: please check back at a later date for more information 240 240 ))) 241 241 242 -== Text Console == 231 +=== 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. 245 - 246 246 == File Manager == 247 247 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 - 250 250 == Network Device Tree View == 251 251 252 - Network DeviceTree View [[image:1663622313939-259.png]] is a useful tool for237 +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. 253 253 254 254 == Script Manager == 255 255 256 - LoadScriptsare.txt files that allow you toautomate certaintasks by connecting toa device and executing a predeterminedsequenceof commands, and the Script Manager tool [[image:1663622272369-417.png]] is where Load Scripts can be opened and executed.241 += Miscellaneous = 257 257 258 -== Package Update Tool == 259 - 260 -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. 261 - 262 -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. 263 - 264 -* Locate the firmware or ShowRunner™ .puf file in Windows Explorer 265 -* Double-click the .puf file to open the Package Update Tool 266 -[[image:put1.png||height="386" width="416"]] 267 -* Use the Address Book or the Pencil icon to connect to your processor and wait for it to connect 268 -* Verify that the correct .puf and target device are selected 269 -** Verify the information under "Package Info" matches what is expected for the desired firmware, and re-select the .puf using the "Select..." button if the information is incorrect 270 -** Verify that the information under "Target" matches the device to be updated, and re-select the device using the Address Book or Pencil icon if it is incorrect 271 -[[image:put2.png||height="365" width="393"]] 272 -* Once you have verified all the information is correct and the Package Update Tool has run its check to see that the firmware is compatible with the device, click the "Update" button to begin the update 273 -[[image:put3.png||height="340" width="366"]] 274 -* The Package Update Tool will notify you of when it is safe to close, but it is recommended to stay connected if possible in order to verify that the firmware update has been completed successfully 275 -[[image:put4.png||height="336" width="362"]] 276 - 277 -= Miscellaneous Tips = 278 - 279 279 == VPT COM Server == 280 280 281 281 Whenever Toolbox is open, Toolbox also starts a separate process called the Crestron Toolbox VPT COM server. This process appears in the system tray with the following icon when active: [[image:1663630447432-699.png]]
- 1702589379487-339.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.alexander\.mott@chiefintegrations\.com - Size
-
... ... @@ -1,1 +1,0 @@ 1 -258 bytes - Content
- addr.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.alexander\.mott@chiefintegrations\.com - Size
-
... ... @@ -1,1 +1,0 @@ 1 -26.4 KB - Content
- put1.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.alexander\.mott@chiefintegrations\.com - Size
-
... ... @@ -1,1 +1,0 @@ 1 -9.5 KB - Content
- put2.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.alexander\.mott@chiefintegrations\.com - Size
-
... ... @@ -1,1 +1,0 @@ 1 -12.4 KB - Content
- put3.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.alexander\.mott@chiefintegrations\.com - Size
-
... ... @@ -1,1 +1,0 @@ 1 -11.7 KB - Content
- put4.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.alexander\.mott@chiefintegrations\.com - Size
-
... ... @@ -1,1 +1,0 @@ 1 -11.7 KB - Content
- window.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.alexander\.mott@chiefintegrations\.com - Size
-
... ... @@ -1,1 +1,0 @@ 1 -14.4 KB - Content