Changes for page Toolbox Basics

Last modified by Alexander Mott on 2024/03/19 21:00
From version 49.1
edited by Alexander Mott
on 2023/12/13 19:11
Change comment: There is no comment for this version
To version 59.3
edited by Alexander Mott
on 2023/12/14 17:58
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -37,7 +37,7 @@
37 37  These elements have various functions:
38 38  
39 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 -1. Current Connected Device - If the currently connected device is in the Address Book, it's name in the Address Book will be displayed here. This drop down menu can also be used to connect to a different device within the current Address Book
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]]
43 43  1. Quick Function Menu (keyboard shortcut: ALT+F) - menu containing a few useful functions
... ... @@ -149,6 +149,8 @@
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.
153 +
152 152  == Device Discovery Tool ==
153 153  
154 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:
... ... @@ -164,6 +164,46 @@
164 164  1. Discover Devices button - press this to restart the discovery process
165 165  1. Export... button - use this button to export discovered devices to either a Device Summary or Address Book (covered in more detail below)
166 166  
169 +=== Export to Address Book ===
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 +
173 +To create an Address Book in Toolbox:
174 +
175 +1. Connect to the lighting network and open Device Discovery Tool in Toolbox
176 +1. The Device Discovery tool will automatically report how many Ethernet devices have been discovered
177 +1. Verify that the expected number of Ethernet devices have been discovered, including any TSWs, GLPACs, DIN-CENCN-2s, etc.
178 +1*. Note that only Crestron devices will appear in Device Discovery; non-Crestron devices (such as Pharos or Enttec DMX controllers) will not appear in Device Discovery Tool
179 +1*. If no devices are discovered, verify that your computer is connected to the network and your IP address is compatible with the network
180 +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
181 +1. Click the "Export..." button below the list of discovered devices
182 +1*. If this button says "Address Book", then Toolbox needs to be updated
183 +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
184 +1. Select how you would like devices to be saved:
185 +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
186 +1*. IP Address - Recommended for jobs with static IP addresses only; entries are named the form "[hostname]_ip" by default
187 +[[image:export.png]]
188 +1. Click the "New Address Book" button to create a new Address Book with these device
189 +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)
190 +1*. Devices with the same name and connection method will be overwritten, while devices with new names will be added
191 +
192 +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
193 +
194 +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...
195 +[[image:addr.png||height="444" width="627"]]
196 +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
197 +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
198 +1*. By default, newly created Address Books are saved to your "Documents\Crestron\Toolbox\AddressBook\" folder
199 +1. Click the "Open" button to make the selected Address Book active
200 +1. If desired, the "Name" or "Address" column headers can be clicked to change the order devices are displayed in the dropdown menu
201 +1*. The up and down arrows at the bottom of the menu can be used to manually re-order devices
202 +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:
203 +1*. Connection type (TCP, USB, etc.) and method (SSH, SSL/TLS, etc.)
204 +1*. Connection port
205 +1*. Credentials
206 +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
207 +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
208 +
167 167  === Export to Device Summary ===
168 168  
169 169  The Device Summary is an important documentation tool provided by Crestron. It is a .txt file containing a comma-separated-values of all networked devices, and is useful to capture which devices are online, what their current IP and hostname settings are, what version of firmware they are on, and their MAC address and serial number.
... ... @@ -175,34 +175,31 @@
175 175  1. Verify that the expected number of Ethernet devices have been discovered, including any TSWs, GLPACs, DIN-CENCN-2s, etc.
176 176  1*. Note that only Crestron devices will appear in Device Discovery; non-Crestron devices (such as Pharos or Enttec DMX controllers) will not appear in Device Discovery Tool
177 177  1*. If no devices are discovered, verify that your computer is connected to the network and your IP address is compatible with the network
178 -1*. If some devices are missing, there may be an issue with your DHCP server settings or the network wiring
220 +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
179 179  1. Click the "Export..." button below the list of discovered devices
180 180  1*. If this button says "Address Book", then Toolbox needs to be updated
223 +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
181 181  1. Click the Write Device Summary button and save the Device Summary to your computer
182 182  1*. Though saved as a text file, the Device Summary is actually a table of comma separated values
183 183  1*. Renaming DeviceSummary.txt to DeviceSummary.csv will allow it to be opened and manipulated in common spreadsheet software such as Microsoft Excel or LibreOffice Calc
184 -1**. Note that this .csv will have whitespace, so it may be beneficial to "clean" it using Excel's "=TRIM()" function
227 +1**. Note that this .csv will have whitespace, so you may want to "clean" it using Excel's "=TRIM()" function if you intend to copy/paste it into the takeoff
185 185  
186 186  Below is an example of a Device Summary for a fully-configured Zūm Wired job:
187 187  
188 188  * DeviceSummary.txt:
189 -[[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"]]
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" height="201" width="912"]]
190 190  * DeviceSummary.csv:
191 -[[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"]]
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" height="289" width="752"]]
192 192  
193 -=== Export to Address Book ===
194 -
195 195  (% class="box warningmessage" %)
196 196  (((
197 197  This section is under construction: please check back at a later date for more information
198 198  )))
199 199  
200 -Address Books provide a convenient way to easily connect to different devices without the need to remember different IP addresses or credentials.
201 -
202 -Note that when exporting devices to the Address Book, it is possible to add devices by either Hostname or by IP Address. On systems with a DHCP server, it is recommended to add devices by Hostname, but only after the final hostnames have been set for all devices.
203 -
204 204  == Text Console ==
205 205  
243 +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"
244 +
206 206  == File Manager ==
207 207  
208 208  == Network Device Tree View ==
... ... @@ -211,8 +211,27 @@
211 211  
212 212  == Script Manager ==
213 213  
214 -= Miscellaneous =
253 +== Package Update Tool ==
215 215  
255 +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.
256 +
257 +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.
258 +
259 +* Locate the firmware or ShowRunner™ .puf file in Windows Explorer
260 +* Double-click the .puf file to open the Package Update Tool
261 +[[image:put1.png||height="386" width="416"]]
262 +* Use the Address Book or the Pencil icon to connect to your processor and wait for it to connect
263 +* Verify that the correct .puf and target device are selected
264 +** 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
265 +** 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
266 +[[image:put2.png||height="365" width="393"]]
267 +* 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
268 +[[image:put3.png||height="340" width="366"]]
269 +* 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
270 +[[image:put4.png||height="336" width="362"]]
271 +
272 += Miscellaneous Tips =
273 +
216 216  == VPT COM Server ==
217 217  
218 218  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]]
addr.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +26.4 KB
Content
export.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +21.5 KB
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