Toolbox Basics

Version 26.7 by Alexander Mott on 2022/10/10 22:02
CONTENTS

Crestron's Toolbox 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. 

Initial Toolbox Configuration

When you first open Toolbox, there are several settings and preferences that Chief Integrations recommends making:

  • From the list of options at the top, navigate to "File>Preferences..."
    • For "Load Workspace on startup?" select "None"
    • For "Save Workspace on exit?" select "Never"
    • For "Automatically Connect to:" select "Nothing"
  • From the list of options at the top, navigate to "Tools>Manage Tools..."
    • We recommend selecting the most commonly used tools and familiarizing yourself with their icons:
      • 1663622192322-441.pngSystem Info
      • 1663622220065-810.pngText Console
      • 1663622252305-602.pngSIMPL Debugger
      • 1663622272369-417.pngScript Manager
      • 1663622297411-164.pngPackage Update Tool
      • 1663622313939-259.pngNetwork Device Tree View
      • 1663622340028-319.pngFile Manager
      • 1663622362685-655.pngDevice Discovery Tool
      • 1663622375782-444.pngDALI Commissioning Tool
      • 1663622400865-394.pngNetwork Analyzer
    • Once checked, these icons appear as shortcuts below the "File/View/Tools/etc." menus

Connecting to Devices

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.

Any Toolbox tool which requires connecting to a device has several buttons and fields at the lower left which relate to device connection:

Untitled.png

These elements have various functions:

  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 
  2. 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
  3. 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:
    • 1663625644870-585.png
  4. Quick Function Menu (keyboard shortcut: ALT+F) - menu containing a few useful functions
    • Firmware (keyboard shortcut: ALT+O) - menu for loading firmware
    • SIMPL Program (keyboard shortcut: ALT+P) - menu for loading a SIMPL or SIMPL# Program
    • Project (keyboard shortcut: ALT+T) - menu for loading an XPanel UI
  5. Current connection status ("Connecting", "Connected", "Disconnected", or "Unknown")
  6. Current connection type and address (e.g. "usb" or "ssh 10.44.5.71")

USB Connection

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.

To connect via USB:

  1. Determine the necessary USB cable
    • 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
  2. Plug the USB cable in to both the device and your computer
  3. Open Toolbox and then open the desired tool
  4. Connect to the device
    • If you are using the Default Address Book, there is already an entry for "Local-USB"
    • If you are not using an Address Book, then you should click the Pencil Icon to open the Manual Connection Menu:
      1. Change the connection type from "TCP" to "USB"
      2. Leave Model, Hostname, and Serial fields blank
      3. If the device has authentication enabled, expand the Advanced options and input the username and password
      4. Click "OK"
  5. The current connection status field should change from "Unknown" to "Connecting"
  6. After a brief period, the connection status field should change from "Connecting" to "Connected"
    • Some devices may take longer than others to connect
    • 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 below

Ethernet Connection

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. 

To connect to a device via Ethernet, your laptop must first be connected

Device Discovery Tool and Address Book

Troubleshooting a Failed Connection

"Device refused to identify"

"Device not found in database"

Basic Tool Usage

Text Console

Network Device Tree View

Toolbox Quirks

Toolbox has some unique quirks that can sometimes cause issues.

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: 1663630447432-699.png

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:

  1. Close Crestron Toolbox
  2. Press CTRL+SHIFT+ESC to open Windows Task Manager
  3. Click the "More Details" button to see all processes
  4. Sort processes alphabetically and look for "VptCOMServer Module (32 bit)" under the "Background Processes" section
    • 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
    • If the VptCOMServer process is still running after Toolbox has closed, select it in Task Manager and press End Process to stop it
  5. Once VptCOMServer is stopped, open Toolbox and see if your issues have been resolved

Text Console Alternatives

File Management Alternatives

Package Update Tool Alternatives