Changes for page Toolbox Basics
Last modified by Alexander Mott on 2024/03/19 21:00
From version 52.1
edited by Alexander Mott
on 2023/12/13 20:56
on 2023/12/13 20:56
Change comment:
There is no comment for this version
To version 69.1
edited by Alexander Mott
on 2023/12/14 22:51
on 2023/12/14 22:51
Change comment:
Uploaded new attachment "sm4.png", version {1}
Summary
-
Page properties (1 modified, 0 added, 0 removed)
-
Attachments (0 modified, 10 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -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 ... ... @@ -229,9 +229,9 @@ 229 229 Below is an example of a Device Summary for a fully-configured Zūm Wired job: 230 230 231 231 * DeviceSummary.txt: 232 -[[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"]] 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"]] 233 233 * DeviceSummary.csv: 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"]] 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"]] 235 235 236 236 (% class="box warningmessage" %) 237 237 ((( ... ... @@ -240,14 +240,39 @@ 240 240 241 241 == Text Console == 242 242 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 + 243 243 == File Manager == 244 244 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 + 245 245 == Network Device Tree View == 246 246 247 - Seeourpage for more specific information on how to use the Network Device Tree View for device addressing purposes.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"]]. 248 248 249 249 == Script Manager == 250 250 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. 257 + 258 +== Package Update Tool == 259 + 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. 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 + 251 251 = Miscellaneous Tips = 252 252 253 253 == VPT COM Server ==
- 1702589379487-339.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +XWiki.alexander\.mott@chiefintegrations\.com - Size
-
... ... @@ -1,0 +1,1 @@ 1 +258 bytes - Content
- put1.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +XWiki.alexander\.mott@chiefintegrations\.com - Size
-
... ... @@ -1,0 +1,1 @@ 1 +9.5 KB - Content
- put2.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +XWiki.alexander\.mott@chiefintegrations\.com - Size
-
... ... @@ -1,0 +1,1 @@ 1 +12.4 KB - Content
- put3.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +XWiki.alexander\.mott@chiefintegrations\.com - Size
-
... ... @@ -1,0 +1,1 @@ 1 +11.7 KB - Content
- put4.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +XWiki.alexander\.mott@chiefintegrations\.com - Size
-
... ... @@ -1,0 +1,1 @@ 1 +11.7 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