Changes for page Toolbox Basics

Last modified by Alexander Mott on 2024/03/19 21:00
From version 23.2
edited by Alexander Mott
on 2022/09/19 22:15
Change comment: (Autosaved)
To version 30.1
edited by Alexander Mott
on 2023/02/08 22:24
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -2,7 +2,7 @@
2 2  {{toc/}}
3 3  {{/box}}
4 4  
5 -[[Crestron's Toolbox>>url:https://www.crestron.com/Products/Control-Hardware-Software/Software/Development-Software/SW-TB]] software is vital to being able to startup any Crestron lighting control job. The intent of this article is to familiarize a new lighting control tech with the very basics of the various Tools available within the Crestron Toolbox software.
5 +[[Crestron's Toolbox>>url:https://www.crestron.com/Products/Control-Hardware-Software/Software/Development-Software/SW-TB]] software is vital to being able to startup any Crestron lighting control job. The intent of this article is to familiarize a new lighting control tech with the very basics of the various Tools available within the Crestron Toolbox software; detailed information can be access anytime from within Toolbox by pressing the F1 function key to open the Crestron Toolbox Help Menu. If a tool window is the active window, pressing F1 will open the Crestron Toolbox Help Menu to the specific page for that tool.
6 6  
7 7  = Initial Toolbox Configuration =
8 8  
... ... @@ -28,22 +28,108 @@
28 28  
29 29  = Connecting to Devices =
30 30  
31 -In order to connect to any lighting devices, your computer must be physically connected to the lighting device or the lighting network. Typically, this is achieved with either a USB-A to USB-B cable or an Ethernet cable, though some devices use different types of USB or have wireless adapters.
31 +In order to connect to any lighting devices, your computer must be physically connected to the lighting device or the lighting network. Typically, this is achieved via TCP (i.e. Ethernet or WiFi) or USB (usually a USB-A to USB-B cable), though some older devices may require an RS-232 serial connection.
32 32  
33 -(% class="box infomessage" %)
34 -(((
35 -Note: It is not recommended to use Toolbox with multiple types of connections simultaneously as Toolbox may behave unexpectedly. If changing the connection method (e.g. switching to an Ethernet connection after using a USB connection), then you should unplug the first cable before plugging in the second one.
36 -)))
33 +Any Toolbox tool which requires connecting to a device has several buttons and fields at the lower left which relate to device connection:
37 37  
35 +[[image:Untitled.png]]
36 +
37 +These elements have various functions:
38 +
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
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 +1*. [[image:1663625644870-585.png]]
43 +1. Quick Function Menu (keyboard shortcut: ALT+F) - menu containing a few useful functions
44 +1*. Firmware (keyboard shortcut: ALT+O) - menu for loading firmware
45 +1*. SIMPL Program (keyboard shortcut: ALT+P) - menu for loading a SIMPL or SIMPL# Program
46 +1*. Project (keyboard shortcut: ALT+T) - menu for loading an XPanel UI
47 +1. Current connection status ("Connecting", "Connected", "Disconnected", or "Unknown")
48 +1. Current connection type and address (e.g. "usb" or "ssh 10.44.5.71")
49 +
38 38  == USB Connection ==
39 39  
40 -To connect via USB, simply plug the appropriate USB cable into your computer and the device and then open the desired tool. When connected via USB, only the device you are connected to will appear:
52 +Connecting to a device via USB is only recommended during initial configuration of the device's IP settings or if there is an issue with connecting via Ethernet/TCP. The data transfer rate over USB is very low relative to Ethernet, and so any activities that require data transfer (such as updating firmware, updating showrunner™, or loading a UI) will take much longer than necessary. Additionally, when connecting via USB, only the device you are plugged in to will be connectable in Toolbox, rather than being able to connect to any device on the lighting network as would be possible when connected by Ethernet.
41 41  
54 +To connect via USB:
42 42  
56 +1. Determine the necessary USB cable
57 +1*. Most devices (DIN-AP3, DIN-AP4, DIN-CENCN-2, etc.) will require a USB-B connection, but some devices may require a Mini USB-B or Micro USB-B connection
58 +1. Plug the USB cable in to both the device and your computer
59 +1. Open Toolbox and then open the desired tool
60 +1. Connect to the device
61 +1*. If you are using the Default Address Book, there is already an entry for "Local-USB"
62 +1*. If you are not using an Address Book, then you should click the Pencil Icon to open the Manual Connection Menu:
63 +1*1. Change the connection type from "TCP" to "USB"
64 +1*1. Leave Model, Hostname, and Serial fields blank
65 +1*1. If the device has authentication enabled, expand the Advanced options and input the username and password
66 +1*1. Click "OK"
67 +1. The current connection status field should change from "Unknown" to "Connecting"
68 +1. After a brief period, the connection status field should change from "Connecting" to "Connected"
69 +1*. Some devices may take longer than others to connect
70 +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
71 +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
72 +
43 43  == Ethernet Connection ==
44 44  
75 +Plugging in to the lighting network and connecting to devices via Ethernet is the most useful way to connect to lighting control hardware. When your laptop is connected to the lighting network, you are able to connect to any device that is on the network, as well as connect to multiple devices simultaneously. Unlike with a USB connection, connecting to a device via Ethernet does not require physical proximity to the device. Wireless connection to the lighting network is possible if the lighting network has properly configured a wireless router on it.
76 +
77 +To connect to a device via Ethernet, your laptop must first be connected to the lighting network.
78 +
79 +To connect to the lighting network:
80 +
81 +1. Identify an open where you are able to plug in to the lighting network
82 +1*. Many Crestron processor and HUB panels will have one or more CEN-SW-POE-5 or CEN-SWPOE-16 ethernet switches. Any open port on these Ethernet switches should be able to be used to connect a laptop to the network.
83 +1*. Laptops do not require power over Ethernet, so it is acceptable to use the "Uplink" port if necessary.
84 +1*. If the lighting network is on the building LAN, then you may need to reach out to the building's IT department for instructions on how to access the lighting network or VLAN.
85 +1. Use a Cat 5a or Cat 6 cable to connect your laptop to the lighting network at an open port
86 +1*. Most newer laptops will require some sort of adapter in order to connect to a Cat 5a/6 cable
87 +1. Configure your laptop's network settings to be compatible with the lighting network:
88 +11. Navigate to Control Panel>Network and Internet>Network Connections
89 +11. Locate the network adapter that is connected to the lighting network
90 +11. Right click the network adapter and click "Properties"
91 +11. In the Networking tab of the adapter Properties menu, select "Internet Protocol Version 4 (TCP/IPv4)" from the list
92 +11. Click the "Properties" button
93 +11*. If the lighting network uses static IP addresses:
94 +11*1. Click "Use the following IP address:"
95 +11*1. For the IP Address, give your laptop an address that is in the range of the lighting devices but that does not conflict with any addresses on the network
96 +11*1. For the Subnet mask, give your laptop the same subnet mask as the lighting devices
97 +11*1. The Default gateway can be left blank
98 +11*1. Once all settings have been configured, press "OK" to close the IP configuration dialog
99 +11*1*. E.g., if there is a lighting network with a processor at 10.0.0.10, a DIN-CENCN-2 at 10.0.0.11, and a TSW at 10.0.0.12 and all devices have a subnet mask of 255.255.255.0, then your laptop can have any address in the range 10.0.0.2 through 10.0.0.9 or 10.0.0.13 through 10.0.0.254, since these addresses are all in the subnetwork range and are not being used by other devices.
100 +11*1. Press "OK" again to close the Ethernet Properties dialog
101 +11*. If the lighting network has a DHCP server (such as a CP4N control subnet):
102 +11*1. Use the "Obtain an IP address automatically" option
103 +11*1. Press "OK" to close the IP Configuration dialog
104 +11*1. Press "OK" again to close the Ethernet Properties dialog
105 +11*1. Your laptop will automatically be assigned an IP address in the correct range by the DHCP server on the network.
106 +11*1*. You can verify this by opening the Windows Command Line tool and running "ipconfig" command to view your current adapter settings
107 +1. Open Toolbox and then open the desired tool
108 +1. Connect to the device:
109 +1*. If you have created an address book, then select the device from the drop down menu
110 +1*. If you have not created an address book, then you should click the Pencil Icon to open the Manual Connection Menu:
111 +1*1. Leave the connection type as "TCP"
112 +1*1. Type in the IP address of the device you wish to connect to
113 +1*1. Generally, the "Auto Detect" box should be left at "Auto Detect", though if you know what type of connection you need then you can manually change it
114 +1*1. Leave Model, Hostname, and Serial fields blank
115 +1*1. If the device has authentication enabled, expand the Advanced options and input the username and password
116 +1*1. Click "OK"
117 +1. The current connection status field should change from "Unknown" to "Connecting"
118 +1. After a brief period, the connection status field should change from "Connecting" to "Connected"
119 +1*. Some devices may take longer than others to connect
120 +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
121 +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
122 +
45 45  == Device Discovery Tool and Address Book ==
46 46  
125 +Address Books are useful ways of managing multiple jobs that each have many devices.
126 +
127 +== Troubleshooting a Failed Connection ==
128 +
129 +"Device refused to identify" (also happens if too many login attempts are made with the wrong username/password)
130 +
131 +"Device not found in database"
132 +
47 47  = Basic Tool Usage =
48 48  
49 49  == Text Console ==
... ... @@ -56,8 +56,22 @@
56 56  
57 57  == VPT COM Server ==
58 58  
59 -== Text Console Alternatives ==
145 +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]]
60 60  
61 -== File Management Alternatives ==
147 +Occasionally, something goes wrong with the VPT COM Server process which will prevent Toolbox from functioning correctly. To solve this problem, take the following steps:
62 62  
63 -== Package Update Tool Alternatives ==
149 +1. Close Crestron Toolbox
150 +1. Press CTRL+SHIFT+ESC to open Windows Task Manager
151 +1. Click the "More Details" button to see all processes
152 +1. Sort processes alphabetically and look for "VptCOMServer Module (32 bit)" under the "Background Processes" section
153 +1*. If you do not see the VptCOMServer process in Task Manager and the icon is not in the system tray, then it is not running
154 +1*. If the VptCOMServer process is still running after Toolbox has closed, select it in Task Manager and press End Process to stop it
155 +1. Once VptCOMServer is stopped, open Toolbox and see if your issues have been resolved
156 +
157 +== Alternatives to Specific Toolbox Tools ==
158 +
159 +Sometimes it is necessary to connect to a Crestron device for troubleshooting using a computer that either does not or cannot have Toolbox installed on it. In these instances, third-party software can be used to replace some of the Tools in Toolbox in order to allow immediate troubleshooting of the lighting control system.
160 +
161 +The Text Console tool can be substituted with [[PuTTY>>https://www.putty.org/]], a free and open-source Telnet and SSH client/terminal emulator. [[SecureCRT>>https://www.vandyke.com/products/securecrt/]] is another option with some more capability than PuTTY, but note that it is a paid software which requires a license to use. The File Management tool can be substituted with [[WinSCP>>https://winscp.net/eng/index.php]], [[FileZilla>>https://filezilla-project.org/]], or [[CyberDuck>>https://cyberduck.io/]]. These are all free FTP/SFTP clients that do not require any license to use.
162 +
163 +Note that any Text Console or File Management alternatives are only suitable when connecting to Crestron devices over TCP/IP (Ethernet). When connecting to a Crestron device using these third-party programs, use port 22. Connecting to Crestron devices over USB is only possible using Toolbox because these devices do not use a standard communications protocol for USB communications.
1663630447432-699.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +349 bytes
Content