Changes for page Toolbox Basics

Last modified by Alexander Mott on 2024/03/19 21:00
From version 6.1
edited by Alexander Mott
on 2022/09/19 16:05
Change comment: There is no comment for this version
To version 25.1
edited by Alexander Mott
on 2022/09/19 23:34
Change comment: Uploaded new attachment "1663630447432-699.png", version {1}

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  
... ... @@ -14,26 +14,76 @@
14 14  ** For "Automatically Connect to:" select "Nothing"
15 15  * From the list of options at the top, navigate to "Tools>Manage Tools..."
16 16  ** We recommend selecting the most commonly used tools and familiarizing yourself with their icons:
17 -*** System Info
18 -*** Text Console
19 -*** SIMPL Debugger
20 -*** Script Manager
21 -*** Package Update Tool
22 -*** Network Device Tree View
23 -*** File Manager
24 -*** Device Discovery Tool
25 -*** DALI Commissioning Tool
26 -*** Network Analyzer
17 +*** [[image:1663622192322-441.png]]System Info
18 +*** [[image:1663622220065-810.png]]Text Console
19 +*** [[image:1663622252305-602.png]]SIMPL Debugger
20 +*** [[image:1663622272369-417.png]]Script Manager
21 +*** [[image:1663622297411-164.png]]Package Update Tool
22 +*** [[image:1663622313939-259.png]]Network Device Tree View
23 +*** [[image:1663622340028-319.png]]File Manager
24 +*** [[image:1663622362685-655.png]]Device Discovery Tool
25 +*** [[image:1663622375782-444.png]]DALI Commissioning Tool
26 +*** [[image:1663622400865-394.png]]Network Analyzer
27 27  ** Once checked, these icons appear as shortcuts below the "File/View/Tools/etc." menus
28 28  
29 -= Basic Tool Usage =
29 += Connecting to Devices =
30 30  
31 -== Connecting to Devices ==
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 -== Text Console ==
33 +Any Toolbox tool which requires connecting to a device has several buttons and fields at the lower left which relate to device connection:
34 34  
35 -== Device Discovery Tool ==
35 +[[image:Untitled.png]]
36 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 +
50 +== USB Connection ==
51 +
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.
53 +
54 +To connect via USB:
55 +
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 +
73 +== Ethernet Connection ==
74 +
75 +== Device Discovery Tool and Address Book ==
76 +
77 +== Troubleshooting a Failed Connection ==
78 +
79 +"Device refused to identify"
80 +
81 +"Device not found in database"
82 +
83 += Basic Tool Usage =
84 +
85 +== Text Console ==
86 +
37 37  == Network Device Tree View ==
38 38  
39 39  = Toolbox Quirks =
1663622192322-441.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +226 bytes
Content
1663622220065-810.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +254 bytes
Content
1663622252305-602.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +225 bytes
Content
1663622272369-417.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +877 bytes
Content
1663622297411-164.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +346 bytes
Content
1663622313939-259.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +314 bytes
Content
1663622340028-319.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +824 bytes
Content
1663622362685-655.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +561 bytes
Content
1663622375782-444.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +1003 bytes
Content
1663622400865-394.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +500 bytes
Content
1663623469442-718.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +43.0 KB
Content
1663623698811-334.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +10.5 KB
Content
1663624308174-567.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +1.2 KB
Content
1663624626576-209.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +1.6 KB
Content
1663625594527-742.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +7.4 KB
Content
1663625644870-585.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +7.4 KB
Content
1663630447432-699.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +349 bytes
Content
Untitled.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.alexander\.mott@chiefintegrations\.com
Size
... ... @@ -1,0 +1,1 @@
1 +2.7 KB
Content