Changes for page Toolbox Basics

Last modified by Alexander Mott on 2024/03/19 21:00
From version 73.1
edited by Alexander Mott
on 2023/12/14 22:58
Change comment: There is no comment for this version
To version 50.10
edited by Alexander Mott
on 2023/12/13 20:45
Change comment: (Autosaved)

Summary

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. 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
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
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,12 +149,11 @@
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]]
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,
154 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:
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:
158 158  
159 159  [[image:device discovery tool numbered.png]]
160 160  
... ... @@ -169,7 +169,7 @@
169 169  
170 170  === Export to Address Book ===
171 171  
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.
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.
173 173  
174 174  To create an Address Book in Toolbox:
175 175  
... ... @@ -183,17 +183,15 @@
183 183  1*. If this button says "Address Book", then Toolbox needs to be updated
184 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 out
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 default
187 -1*. IP Address - Recommended for jobs with static IP addresses only; entries are named the form "[hostname]_ip" by default
185 +1*. Hostname
186 +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
189 +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
... ... @@ -230,84 +230,27 @@
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"]]
230 +[[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"]]
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/1655487132138-904.png?rev=1.1||alt="1655487132138-904.png"]]
236 236  
237 -== Text Console ==
238 -
239 -
240 240  (% class="box warningmessage" %)
241 241  (((
242 242  This section is under construction: please check back at a later date for more information
243 243  )))
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.
239 +=== Text Console ===
246 246  
247 247  == File Manager ==
248 248  
249 -(% class="box warningmessage" %)
250 -(((
251 -This section is under construction: please check back at a later date for more information
252 -)))
253 -
254 -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).
255 -
256 256  == Network Device Tree View ==
257 257  
258 -(% class="box warningmessage" %)
259 -(((
260 -This section is under construction: please check back at a later date for more information
261 -)))
245 +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.
262 262  
263 -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.
264 -
265 265  == Script Manager ==
266 266  
267 -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.
249 += Miscellaneous =
268 268  
269 -To use a Load Script with the Load Script Manager:
270 -
271 -* Open the Load Script Manager in Toolbox
272 -* Right-click anywhere in the Load Script Manager, select "Load Script...", and locate your Load Script .txt file
273 -* The window will populate with all of the different command sets defined in the Load Script
274 -** Ensure that you are connected to your devices by the method required based on the connection type listed in the "Connection" column
275 -** This example script is expecting to connect to devices over Ethernet using their hostname
276 -[[image:sm1.png||height="218" width="954"]]
277 -* 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
278 -** 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
279 -** If commands are currently running, you can cancel them using this right-click menu as well
280 -[[image:sm2.png]]
281 -* While commands are running, their current status and progress are displayed under the various columns displayed in the Script Manager
282 -[[image:sm3.png||height="189" width="835"]]
283 -* Once a command section has executed all commands, it will display the success or failure of the commands
284 -** In this example, all of the commands failed for different reasons:
285 -** ZUMNET-JBOX-16A-LV-F2D94E commands failed due to the firmware file specified by the script not being in the correct location
286 -** 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
287 -** The remaining command sections were manually cancelled before they could complete
288 -[[image:sm4.png||height="205" width="904"]]
289 -
290 -== Package Update Tool ==
291 -
292 -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.
293 -
294 -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.
295 -
296 -* Locate the firmware or ShowRunner™ .puf file in Windows Explorer
297 -* Double-click the .puf file to open the Package Update Tool
298 -[[image:put1.png||height="386" width="416"]]
299 -* Use the Address Book or the Pencil icon to connect to your processor and wait for it to connect
300 -* Verify that the correct .puf and target device are selected
301 -** 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
302 -** 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
303 -[[image:put2.png||height="365" width="393"]]
304 -* 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
305 -[[image:put3.png||height="340" width="366"]]
306 -* 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
307 -[[image:put4.png||height="336" width="362"]]
308 -
309 -= Miscellaneous Tips =
310 -
311 311  == VPT COM Server ==
312 312  
313 313  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
sm1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,1 +1,0 @@
1 -26.6 KB
Content
sm2.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,1 +1,0 @@
1 -8.3 KB
Content
sm3.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,1 +1,0 @@
1 -30.5 KB
Content
sm4.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,1 +1,0 @@
1 -35.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