Changes for page Toolbox Basics

Last modified by Alexander Mott on 2024/03/19 21:00
From version 46.1
edited by Alexander Mott
on 2023/12/12 22:26
Change comment: There is no comment for this version
To version 50.9
edited by Alexander Mott
on 2023/12/13 20:40
Change comment: (Autosaved)

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
... ... @@ -121,10 +121,10 @@
121 121  1*. If the device has just recently powered up, it may take a few minutes to completely wake up before it can be connected to
122 122  1*. If you have issues connecting, see [[Troubleshooting a Failed Connection>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Preparation.Toolbox Basics.WebHome||anchor="HTroubleshootingaFailedConnection"]] below
123 123  
124 -== ==
125 -
126 126  == Troubleshooting a Failed Connection ==
127 127  
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 +
128 128  "Device refused to identify"
129 129  
130 130  * This message typically means that the device is not online or could not be connected to
... ... @@ -149,11 +149,6 @@
149 149  
150 150  = Basic Tool Usage =
151 151  
152 -(% class="box warningmessage" %)
153 -(((
154 -This section is under construction: please check back at alater date for more information on using tools in Toolbox
155 -)))
156 -
157 157  == Device Discovery Tool ==
158 158  
159 159  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:
... ... @@ -169,6 +169,38 @@
169 169  1. Discover Devices button - press this to restart the discovery process
170 170  1. Export... button - use this button to export discovered devices to either a Device Summary or Address Book (covered in more detail below)
171 171  
167 +=== Export to Address Book ===
168 +
169 +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.
170 +
171 +To create an Address Book in Toolbox:
172 +
173 +1. Connect to the lighting network and open Device Discovery Tool in Toolbox
174 +1. The Device Discovery tool will automatically report how many Ethernet devices have been discovered
175 +1. Verify that the expected number of Ethernet devices have been discovered, including any TSWs, GLPACs, DIN-CENCN-2s, etc.
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 +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 and you are not filtering the results, then there may be an issue with your DHCP server settings or the network wiring
179 +1. Click the "Export..." button below the list of discovered devices
180 +1*. If this button says "Address Book", then Toolbox needs to be updated
181 +1*. Ensure that you are not filtering out any devices or that you have only filtered out the devices you want to be filtered ou
182 +1. Select how you would like devices to be saved:
183 +1*. Hostname
184 +1*. IP Address
185 +[[image:export.png]]
186 +1. Click the "New Address Book" button to create a new Address Book with these device
187 +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
188 +
189 +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
190 +
191 +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...
192 +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
193 +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
194 +1*. By default, newly created Address Books are saved to your "Documents\Crestron\Toolbox\AddressBook\" folder
195 +1. Click the "Open" button to make your new Address Book the active Address Book
196 +1. If desired, the "Name" or "Address" column headers can be clicked to change how devices are sorted
197 +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
198 +
172 172  === Export to Device Summary ===
173 173  
174 174  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.
... ... @@ -180,13 +180,14 @@
180 180  1. Verify that the expected number of Ethernet devices have been discovered, including any TSWs, GLPACs, DIN-CENCN-2s, etc.
181 181  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
182 182  1*. If no devices are discovered, verify that your computer is connected to the network and your IP address is compatible with the network
183 -1*. If some devices are missing, there may be an issue with your DHCP server settings or the network wiring
210 +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
184 184  1. Click the "Export..." button below the list of discovered devices
185 185  1*. If this button says "Address Book", then Toolbox needs to be updated
213 +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
186 186  1. Click the Write Device Summary button and save the Device Summary to your computer
187 187  1*. Though saved as a text file, the Device Summary is actually a table of comma separated values
188 188  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
189 -1**. Note that this .csv will have whitespace, so it may be beneficial to "clean" it using Excel's "=TRIM()" function
217 +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
190 190  
191 191  Below is an example of a Device Summary for a fully-configured Zūm Wired job:
192 192  
... ... @@ -195,26 +195,21 @@
195 195  * DeviceSummary.csv:
196 196  [[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"]]
197 197  
198 -=== Export to Address Book ===
199 -
200 200  (% class="box warningmessage" %)
201 201  (((
202 -This section is under construction: please check back at a later date for more information on using the Address Book
228 +This section is under construction: please check back at a later date for more information
203 203  )))
204 204  
205 -Address Books are useful ways of managing multiple jobs that each have many devices.
231 +=== Text Console ===
206 206  
207 -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.
233 +== File Manager ==
208 208  
209 -(% class="wikigeneratedid" %)
210 -== Text Console ==
235 +== Network Device Tree View ==
211 211  
212 -== File Manager ==
237 +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.
213 213  
214 214  == Script Manager ==
215 215  
216 -== Network Device Tree View ==
217 -
218 218  = Miscellaneous =
219 219  
220 220  == VPT COM Server ==
export.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +21.5 KB
Content