Changes for page Toolbox Basics

Last modified by Alexander Mott on 2024/03/19 21:00
From version 63.1
edited by Alexander Mott
on 2023/12/14 21:11
Change comment: There is no comment for this version
To version 51.1
edited by Alexander Mott
on 2023/12/13 20:49
Change comment: Uploaded new attachment "addr.png", version {1}

Summary

Details

Page properties
Content
... ... @@ -149,8 +149,7 @@
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  
... ... @@ -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,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"]]
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 237  (% class="box warningmessage" %)
238 238  (((
... ... @@ -239,10 +239,8 @@
239 239  This section is under construction: please check back at a later date for more information
240 240  )))
241 241  
242 -== Text Console ==
239 +=== Text Console ===
243 243  
244 -Text Console 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 248  == Network Device Tree View ==
... ... @@ -251,27 +251,8 @@
251 251  
252 252  == Script Manager ==
253 253  
254 -== Package Update Tool ==
249 += Miscellaneous =
255 255  
256 -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.
257 -
258 -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.
259 -
260 -* Locate the firmware or ShowRunner™ .puf file in Windows Explorer
261 -* Double-click the .puf file to open the Package Update Tool
262 -[[image:put1.png||height="386" width="416"]]
263 -* Use the Address Book or the Pencil icon to connect to your processor and wait for it to connect
264 -* Verify that the correct .puf and target device are selected
265 -** 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
266 -** 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
267 -[[image:put2.png||height="365" width="393"]]
268 -* 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
269 -[[image:put3.png||height="340" width="366"]]
270 -* 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
271 -[[image:put4.png||height="336" width="362"]]
272 -
273 -= Miscellaneous Tips =
274 -
275 275  == VPT COM Server ==
276 276  
277 277  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]]
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