Changes for page Toolbox Basics

Last modified by Alexander Mott on 2024/03/19 21:00
From version 46.2
edited by Alexander Mott
on 2023/12/12 22:27
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
... ... @@ -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
... ... @@ -123,6 +123,8 @@
123 123  
124 124  == Troubleshooting a Failed Connection ==
125 125  
126 +Sometimes, a connection attempt will fail and you will need to do some troubleshooting to figure out why exactly the connection could not be established. Toolbox will give different error messages, though sometimes it can be helpful to attempt to connect with another software such as PuTTY just in case the error message is more informative from the alternate software.
127 +
126 126  "Device refused to identify"
127 127  
128 128  * This message typically means that the device is not online or could not be connected to
... ... @@ -147,10 +147,7 @@
147 147  
148 148  = Basic Tool Usage =
149 149  
150 -(% class="box warningmessage" %)
151 -(((
152 -This section is under construction: please check back at alater date for more information on using tools in Toolbox
153 -)))
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  
... ... @@ -167,6 +167,44 @@
167 167  1. Discover Devices button - press this to restart the discovery process
168 168  1. Export... button - use this button to export discovered devices to either a Device Summary or Address Book (covered in more detail below)
169 169  
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
186 +1*. IP Address
187 +[[image:export.png]]
188 +1. Click the "New Address Book" button to create a new Address Book with these device
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
190 +
191 +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
192 +
193 +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...
194 +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
195 +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
196 +1*. By default, newly created Address Books are saved to your "Documents\Crestron\Toolbox\AddressBook\" folder
197 +1. Click the "Open" button to make the selected Address Book active
198 +1. If desired, the "Name" or "Address" column headers can be clicked to change the order devices are displayed in the dropdown menu
199 +1*. The up and down arrows at the bottom of the menu can be used to manually re-order devices
200 +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:
201 +1*. Connection type (TCP, USB, etc.) and method (SSH, SSL/TLS, etc.)
202 +1*. Connection port
203 +1*. Credentials
204 +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
205 +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
206 +
170 170  === Export to Device Summary ===
171 171  
172 172  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.
... ... @@ -178,13 +178,14 @@
178 178  1. Verify that the expected number of Ethernet devices have been discovered, including any TSWs, GLPACs, DIN-CENCN-2s, etc.
179 179  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
180 180  1*. If no devices are discovered, verify that your computer is connected to the network and your IP address is compatible with the network
181 -1*. If some devices are missing, there may be an issue with your DHCP server settings or the network wiring
218 +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
182 182  1. Click the "Export..." button below the list of discovered devices
183 183  1*. If this button says "Address Book", then Toolbox needs to be updated
221 +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 184  1. Click the Write Device Summary button and save the Device Summary to your computer
185 185  1*. Though saved as a text file, the Device Summary is actually a table of comma separated values
186 186  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
187 -1**. Note that this .csv will have whitespace, so it may be beneficial to "clean" it using Excel's "=TRIM()" function
225 +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
188 188  
189 189  Below is an example of a Device Summary for a fully-configured Zūm Wired job:
190 190  
... ... @@ -193,25 +193,21 @@
193 193  * DeviceSummary.csv:
194 194  [[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"]]
195 195  
196 -=== Export to Address Book ===
197 -
198 198  (% class="box warningmessage" %)
199 199  (((
200 -This section is under construction: please check back at a later date for more information on using the Address Book
236 +This section is under construction: please check back at a later date for more information
201 201  )))
202 202  
203 -Address Books are useful ways of managing multiple jobs that each have many devices.
239 +=== Text Console ===
204 204  
205 -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.
241 +== File Manager ==
206 206  
207 -== Text Console ==
243 +== Network Device Tree View ==
208 208  
209 -== File Manager ==
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.
210 210  
211 211  == Script Manager ==
212 212  
213 -== Network Device Tree View ==
214 -
215 215  = Miscellaneous =
216 216  
217 217  == VPT COM Server ==
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