Changes for page Toolbox Basics

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

From 45.2 to 45.3 From 52.4 to 52.5

From version 45.3

edited by Alexander Mott
on 2023/12/12 22:26

Change comment: There is no comment for this version

To version 52.4

edited by Alexander Mott
on 2023/12/13 22:13

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Attachments (0 modified, 2 added, 0 removed)
- addr.png
- export.png

Details

Page properties

Content

@@ -37,7 +37,7 @@
  These elements have various functions:
 . Address Book Menu - Used to view and edit the current address book, or to change the active Address Book to a different Address Book
--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
++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
 . 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:
 *. [[image:1663625644870-585.png]]
 . Quick Function Menu (keyboard shortcut: ALT+F) - menu containing a few useful functions
@@ -121,6 +121,36 @@
 *. If the device has just recently powered up, it may take a few minutes to completely wake up before it can be connected to
 *. If you have issues connecting, see [[Troubleshooting a Failed Connection>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.Preparation.Toolbox Basics.WebHome||anchor="HTroubleshootingaFailedConnection"]] below
++== Troubleshooting a Failed Connection ==
++
++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.
++
++"Device refused to identify"
++
++* This message typically means that the device is not online or could not be connected to
++* This message may also occur when a device has blocked your username or IP address due to making too many incorrect login attempts
++** 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
++** 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
++** 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):
++*** ##listblockedip## and ##remblockedip## commands can be used to view/unblock an IP address
++*** ##listlockeduser## and ##remlockeduser## commands can be used to view/unblock specific users
++*** ##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
++*** ##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
++*** ##setlogoffidletime## command can be used to modify how long you can be inactive before the processor automatically logs you out
++
++"Device not found in database"
++
++* 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
++
++See our FAQ for additional tips:
++
++* [[I can't connect to my processor via Ethernet?>>https://wiki.chiefintegrations.com/FAQ/I%20can%27t%20connect%20to%20my%20processor%20via%20Ethernet]]
++* [[I can't connect to a 4-Series processor via USB?>>https://wiki.chiefintegrations.com/FAQ/I%20can%27t%20connect%20to%204-Series%20processor%20via%20USB]]
++
++= 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.
++
  == Device Discovery Tool ==
  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:
@@ -136,6 +136,46 @@
 . Discover Devices button - press this to restart the discovery process
 . Export... button - use this button to export discovered devices to either a Device Summary or Address Book (covered in more detail below)
++=== Export to Address Book ===
++
++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.
++
++To create an Address Book in Toolbox:
++
++1. Connect to the lighting network and open Device Discovery Tool in Toolbox
++1. The Device Discovery tool will automatically report how many Ethernet devices have been discovered
++1. Verify that the expected number of Ethernet devices have been discovered, including any TSWs, GLPACs, DIN-CENCN-2s, etc.
++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
++1*. If no devices are discovered, verify that your computer is connected to the network and your IP address is compatible with the network
++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
++1. Click the "Export..." button below the list of discovered devices
++1*. If this button says "Address Book", then Toolbox needs to be updated
++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
++1. 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
++[[image:export.png]]
++1. 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
++
++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
++
++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...
++[[image:addr.png||height="444" width="627"]]
++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
++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
++1*. By default, newly created Address Books are saved to your "Documents\Crestron\Toolbox\AddressBook\" folder
++1. Click the "Open" button to make the selected Address Book active
++1. If desired, the "Name" or "Address" column headers can be clicked to change the order devices are displayed in the dropdown menu
++1*. The up and down arrows at the bottom of the menu can be used to manually re-order devices
++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:
++1*. Connection type (TCP, USB, etc.) and method (SSH, SSL/TLS, etc.)
++1*. Connection port
++1*. Credentials
++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
++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
++
  === Export to Device Summary ===
  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.
@@ -147,13 +147,14 @@
 . Verify that the expected number of Ethernet devices have been discovered, including any TSWs, GLPACs, DIN-CENCN-2s, etc.
 *. 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
 *. If no devices are discovered, verify that your computer is connected to the network and your IP address is compatible with the network
--1*. If some devices are missing, there may be an issue with your DHCP server settings or the network wiring
++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
 . Click the "Export..." button below the list of discovered devices
 *. If this button says "Address Book", then Toolbox needs to be updated
++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
 . Click the Write Device Summary button and save the Device Summary to your computer
 *. Though saved as a text file, the Device Summary is actually a table of comma separated values
 *. 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
--1**. Note that this .csv will have whitespace, so it may be beneficial to "clean" it using Excel's "=TRIM()" function
++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
  Below is an example of a Device Summary for a fully-configured Zūm Wired job:
@@ -162,58 +162,29 @@
  * 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"]]
--=== Export to Address Book ===
--
  (% class="box warningmessage" %)
  (((
--This section is under construction: please check back at a later date for more information on using the Address Book
++This section is under construction: please check back at a later date for more information
  )))
--Address Books are useful ways of managing multiple jobs that each have many devices.
++== Text Console ==
--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.
++== File Manager ==
--== Troubleshooting a Failed Connection ==
++== Network Device Tree View ==
--"Device refused to identify"
++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.
--* This message typically means that the device is not online or could not be connected to
--* This message may also occur when a device has blocked your username or IP address due to making too many incorrect login attempts
--** 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
--** 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
--** 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):
--*** ##listblockedip## and ##remblockedip## commands can be used to view/unblock an IP address
--*** ##listlockeduser## and ##remlockeduser## commands can be used to view/unblock specific users
--*** ##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
--*** ##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
--*** ##setlogoffidletime## command can be used to modify how long you can be inactive before the processor automatically logs you out
++== Script Manager ==
--"Device not found in database"
++== Package Update Tool ==
--* 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
++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]] 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.
--See our FAQ for additional tips:
++Please see our other pages on [[firmware updates>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Updating Firmware.WebHome]] 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.
--* [[I can't connect to my processor via Ethernet?>>https://wiki.chiefintegrations.com/FAQ/I%20can%27t%20connect%20to%20my%20processor%20via%20Ethernet]]
--* [[I can't connect to a 4-Series processor via USB?>>https://wiki.chiefintegrations.com/FAQ/I%20can%27t%20connect%20to%204-Series%20processor%20via%20USB]]
++= Miscellaneous Tips =
--= Basic Tool Usage =
--
--(% class="box warningmessage" %)
--(((
--This section is under construction: please check back at alater date for more information on using tools in Toolbox
--)))
--
--== Text Console ==
--
--== File Manager ==
--
--== Script Manager ==
--
--== Network Device Tree View ==
--
--= Miscellaneous =
--
  == 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]]

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