Changes for page Toolbox Basics

Last modified by Alexander Mott on 2024/03/19 21:00
From version 33.2
edited by Alexander Mott
on 2023/03/28 14:33
Change comment: There is no comment for this version
To version 44.1
edited by Alexander Mott
on 2023/12/08 19:18
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -124,7 +124,6 @@
124 124  
125 125  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:
126 126  
127 -
128 128  [[image:device discovery tool numbered.png]]
129 129  
130 130  1. Device Model - gives the specific model of the device type
... ... @@ -138,24 +138,73 @@
138 138  
139 139  === Export to Device Summary ===
140 140  
141 -The Device Summary is an important documentation tool provided by Crestron. It is a .txt file containing a comma-separated-values
140 +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.
142 142  
142 +To generate a Device Summary in Toolbox:
143 +
144 +1. Connect to the lighting network and open Device Discovery Tool in Toolbox
145 +1. The Device Discovery tool will automatically report how many Ethernet devices have been discovered
146 +1. Verify that the expected number of Ethernet devices have been discovered, including any TSWs, GLPACs, DIN-CENCN-2s, etc.
147 +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
148 +1*. If no devices are discovered, verify that your computer is connected to the network and your IP address is compatible with the network
149 +1*. If some devices are missing, there may be an issue with your DHCP server settings or the network wiring
150 +1. Click the "Export..." button below the list of discovered devices
151 +1*. If this button says "Address Book", then Toolbox needs to be updated
152 +1. Click the Write Device Summary button and save the Device Summary to your computer
153 +1*. Though saved as a text file, the Device Summary is actually a table of comma separated values
154 +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
155 +1**. Note that this .csv will have whitespace, so it may be beneficial to "clean" it using Excel's "=TRIM()" function
156 +
157 +Below is an example of a Device Summary for a fully-configured Zūm Wired job:
158 +
159 +* DeviceSummary.txt:
160 +[[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"]]
161 +* DeviceSummary.csv:
162 +[[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"]]
163 +
143 143  === Export to Address Book ===
144 144  
166 +(% class="box warningmessage" %)
167 +(((
168 +This section is under construction: please check back at a later date for more information on using the Address Book
169 +)))
170 +
145 145  Address Books are useful ways of managing multiple jobs that each have many devices.
146 146  
173 +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.
174 +
147 147  == Troubleshooting a Failed Connection ==
148 148  
149 -"Device refused to identify" (also happens if too many login attempts are made with the wrong username/password)
177 +"Device refused to identify"
150 150  
179 +* This message typically means that the device is not online or could not be connected to
180 +* This message may also occur when a device has blocked your username or IP address due to making too many incorrect login attempts
181 +** IP addresses are blocked for 24 hours by default, but you can attempt to circumvent this block by changing your IP address and trying again
182 +** Users are blocked for 30 minutes by default, and it is only possible to circumvent this if another user has already been created, otherwise you must wait for the block to expire before connecting again
183 +** The below commands are useful if you are able to connect to the processor through some other means (specific commands may vary depending on the device):
184 +*** ##listblockedip## and ##remblockedip## commands can be used to view/unblock an IP address
185 +*** ##listlockeduser## and ##remlockeduser## commands can be used to view/unblock specific users
186 +*** ##setloginattempts## and ##setlockouttime## commands can be used to modify how many login attempts are allowed before blocking an IP address and how long an address will be blocked
187 +*** ##setuserloginattempts## and ##setuserlockouttime## commands are used to modify how many login attempts are allowed before blocking a user and how long that user will be blocked
188 +*** ##setlogoffidletime## command can be used to modify how long you can be inactive before the processor automatically logs you out
189 +
151 151  "Device not found in database"
152 152  
192 +* This message typically means that the version of your device database is out of date and the device being connected to is not in it. Use Crestron's MasterInstaller tool to ensure that Toolbox and all installed Crestron components are up-to-date
193 +
153 153  = Basic Tool Usage =
154 154  
196 +(% class="box warningmessage" %)
197 +(((
198 +This section is under construction: please check back at alater date for more information on using tools in Toolbox
199 +)))
200 +
155 155  == Text Console ==
156 156  
157 157  == File Manager ==
158 158  
205 +== Script Manager ==
206 +
159 159  == Network Device Tree View ==
160 160  
161 161  = Miscellaneous =
device discovery tool.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,1 +1,0 @@
1 -190.7 KB
Content