Changes for page Toolbox Basics

Last modified by Alexander Mott on 2024/03/19 21:00

From 51.1 to 50.10 From 56.1 to 55.2

From version 55.2

edited by Alexander Mott
on 2023/12/14 17:42

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}

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -149,7 +149,7 @@
  = Basic Tool Usage =
--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.
++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,
  == Device Discovery Tool ==
@@ -182,17 +182,15 @@
 *. If this button says "Address Book", then Toolbox needs to be updated
 *. Ensure that you are not filtering out any devices or that you have only filtered out the devices you want to be filtered out
 . Select how you would like devices to be saved:
--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
--1*. IP Address - Recommended for jobs with static IP addresses only; entries are named the form "[hostname]_ip" by default
++1*. Hostname
++1*. IP Address
  [[image:export.png]]
 . Click the "New Address Book" button to create a new Address Book with these device
--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)
--1*. Devices with the same name and connection method will be overwritten, while devices with new names will be added
++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
  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
 . 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...
--[[image:addr.png||height="444" width="627"]]
 . The currently selected address book is displayed in the "Current Address Book" field, and recently opened Address Books are available in the dropdown menu
 . To open an Address Book that has never been open or has not recently been opened, click "Open / New..." and locate the Address Book
 *. By default, newly created Address Books are saved to your "Documents\Crestron\Toolbox\AddressBook\" folder
@@ -229,9 +229,9 @@
  Below is an example of a Device Summary for a fully-configured Zūm Wired job:
  * DeviceSummary.txt:
--[[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"]]
++[[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"]]
  * DeviceSummary.csv:
--[[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"]]
++[[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"]]
  (% class="box warningmessage" %)
  (((
@@ -238,10 +238,8 @@
  This section is under construction: please check back at a later date for more information
  )))
--== Text Console ==
++=== Text Console ===
--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"
--
  == File Manager ==
  == Network Device Tree View ==
@@ -250,29 +250,8 @@
  == Script Manager ==
--== Package Update Tool ==
++= Miscellaneous =
--The Package Update Tool can be used to load .puf files to devices, typically in order to [[update firmware>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Updating Firmware.WebHome||anchor="HPackageUpdateTool28.puf29"]] or [[load the ShowRunnerCLC™ program>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Processor Setup.WebHome||anchor="HProgramLoad"]] to processors. While the Package Update Tool can be opened from within Toolbox, Chief Integrations does not recommend it as loading a .puf file this way 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. This allows you to open multiple instances of the Package Update Tool and load .puf files to multiple devices at once.
--
--Crestron's Package Update Tool is the most convenient way of performing firmware updates for devices that use .puf files for firmware. The Package Update Tool can be opened from Toolbox, but doing this will lock Toolbox and only allow updating one device at a time, so we recommend instead that you double-click the .puf file directly. Double-clicking a .puf file will allow you to open multiple instance of the Package Update Tool and enable updating multiple devices simultaneously. Once again, **be careful when updating multiple devices simultaneously not to do anything that would disrupt your connection to a device while transferring the .puf file, nor should you do anything that could result in the device rebooting while it is mid-update**.
--
--* Locate the firmware .puf file in Windows Explorer
--* Double-click the .puf file to open the Package Update Tool
--[[image:put1.png||height="386" width="416"]]
--* Use the Address Book or the Pencil icon to connect to your processor and wait for it to connect
--* Verify that the correct .puf and target device are selected
--** 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
--** 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
--[[image:put2.png||height="365" width="393"]]
--* 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
--[[image:put3.png||height="340" width="366"]]
--* 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
--[[image:put4.png||height="336" width="362"]]
--
--Please see our other pages on [[firmware updates>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Updating Firmware.WebHome||anchor="HPackageUpdateTool28.puf29"]] and [[loading the ShowRunnerCLC™ program>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Processor Setup.WebHome||anchor="HProgramLoad"]] for more detailed information on how to use the Package Update Tool.
--
--= Miscellaneous Tips =
--
  == VPT COM Server ==
  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]]