Académique Documents
Professionnel Documents
Culture Documents
User’s Manual
Version: 0.0
Released 9/22/05
©
Hydro Electronic Devices, Inc. 2005
CANLink Diagnostic Tool Contents
CONTENTS:
DISCLAIMER .............................................................................................................................................. 1
GETTING STARTED.................................................................................................................................. 2
TERMINOLOGY: ........................................................................................................................................... 3
CONNECTION:.............................................................................................................................................. 3
REQUIRED FILES: ........................................................................................................................................ 3
SYSTEM REQUIREMENTS: ............................................................................................................................ 3
INSTALLER’S ACCESS RIGHTS: .................................................................................................................... 3
PASSWORDS: ............................................................................................................................................... 3
SPACEBAR (E-STOP/SAFE MODE):...................................................................................................... 3
SOFTWARE INSTALLATION AND EXECUTION ............................................................................... 4
INSTALLING CD: ......................................................................................................................................... 5
FILE LOCATIONS: ........................................................................................................................................ 5
SOFTWARE LICENSE AGREEMENT:.............................................................................................................. 5
REGISTER: ................................................................................................................................................... 5
RUN: ........................................................................................................................................................... 5
TOOLBAR FUNCTIONALITY ................................................................................................................. 8
EXIT BUTTON:......................................................................................................................................... 9
CONNECT/DISCONNECT BUTTON:..................................................................................................... 9
MULTI-VIEW BUTTON: ......................................................................................................................... 9
ADDING/REMOVING Parameters:....................................................................................................... 9
DEBUG BUTTON (ACCESS BASED): ...................................................................................................... 11
SPACEBAR (E-STOP/SAFE MODE):.................................................................................................... 11
DATA WINDOWS ..................................................................................................................................... 12
DESCRIPTION:............................................................................................................................................ 13
MODULES WINDOW:.............................................................................................................................. 14
Description ........................................................................................................................................... 14
INPUTS WINDOW: ................................................................................................................................... 16
Description ........................................................................................................................................... 16
OUTPUTS WINDOW: ............................................................................................................................... 18
Description ........................................................................................................................................... 18
VARIABLES WINDOW:........................................................................................................................... 20
Description ........................................................................................................................................... 20
J1939 (ENGINE DATA) WINDOW: ............................................................................................................. 21
Description ........................................................................................................................................... 21
J1939 ERROR (ENGINE DATA) WINDOW:.................................................................................................. 22
Description ........................................................................................................................................... 22
EEPROM (PARAMETERS) WINDOW:........................................................................................................ 23
Description ........................................................................................................................................... 23
Functions .............................................................................................................................................. 24
DEBUG........................................................................................................................................................ 26
DEBUGGING INPUTS, VARIABLES, J1939 AND J1939 ERROR: ................................................................... 27
DEBUGGING OUTPUTS:.............................................................................................................................. 27
MISC. CDT OPERATIONS...................................................................................................................... 30
MENU BAR:............................................................................................................................................... 31
Comm.................................................................................................................................................... 31
About .................................................................................................................................................... 31
DataLogger (Access Based) ................................................................................................................. 31
E-STOP ENABLED (ACCESS BASED) ..................................................................................................... 31
i
CANLink Diagnostic Tool Contents
COMPANY INFORMATION................................................................................................................... 34
ii
CANLink Diagnostic Tool Disclaimer
Disclaimer
IMPORTANT
You should read this first before you use this software.
-1-
CANLink Diagnostic Tool Getting Started
Getting Started
-2-
CANLink Diagnostic Tool Getting Started
Terminology:
CANLink Diagnostic Tool (CDT): Software supplied with this manual.
Equipment: Vehicle, Machine, or Device that the CDT is connected to.
System: All CANLink modules and equipment connected.
OEM: Original Equipment Manufacturer
IOc File: File required for execution of the CDT (.IOc file extension).
Server Module: The main module of the System.
Client Module: All CANLink modules other than the Server Module.
Connection:
The CDT is to be connected to the equipment via a diagnostic connector. Plug the required cable between
the PC and the equipment’s diagnostic connector. Contact equipment’s OEM for required cable.
Required Files:
In order to run the CDT, a file specific to your equipment is required. This file will be an IOc type file, and
should be obtained from your equipment’s OEM. Copy this file in a convenient location on your PC (ex:
C:\Program Files\CANLink Diagnostic Tool folder).
System Requirements:
OS: Windows NT, 2000, and XP
CPU: Pentium II or later (Pentium III or later recommended)
RAM: 128 MB or more (256 MB or more recommended)
Communications: RS-232 recommended
Passwords:
Once the CDT is started, you will be prompted for a case-sensitive password. Your equipment OEM will
supply the password.
Note: The level of access to the operating features of the CANLink Diagnostic Tool will be determined by
the equipment OEM, where some features described later in this document may not be available.
-3-
CANLink Diagnostic Tool SW Installation/Execution
-4-
CANLink Diagnostic Tool SW Installation/Execution
Installing CD:
Insert the CD-ROM supplied with this software package into the CD-ROM drive. Locate SETUP.EXE and
double-click to execute the installation.
File Locations:
We strongly suggest letting the installation install the software into the default locations given by this
program.
Register:
Click “Register Now” to register this product with HED, Inc. Registration can be done via email or fax.
The installation will supply all information required for both options.
Run:
After successful installation, double-click the “CANLinkDiagnosticTool.EXE” file to execute the CDT.
First screen to show will be the CDT splash screen. Your equipment’s OEM configures the logo. Version
of the CDT Software can be viewed on this screen.
Figure 2
Next screen will prompt the user to select the system’s IOc file.
-5-
CANLink Diagnostic Tool SW Installation/Execution
Figure 3
NOTE: In order to run the CDT, a file specific to your equipment is required. This file will be an .IOc type
file, and should be obtained from your equipment’s OEM. If an invalid file is selected, no connection will
be made and a prompt will warn of invalid file selection.
After the IOc file is selected, you will be prompted for a password.
Figure 4
If an incorrect password is entered three consecutive times, the CDT will default to a read-only state where
you can observe the status of inputs and outputs etc, but you cannot debug them.
-6-
CANLink Diagnostic Tool SW Installation/Execution
Figure 5
This same access level will also be obtained by simply clicking “Cancel” when prompted for a password.
Once a valid password is entered or “Cancel” is clicked, and a proper connection is made between your PC
and your equipment, the CDT will be connected. A proper connection can be verified by looking at the
Connect/Disconnect Button on the tool’s main toolbar.
After successful connection to the equipment’s system, the Main Screen will show. The following figure is
an example (configured default windows may be different):
Figure 6
The CDT is ready for use at this time.
-7-
CANLink Diagnostic Tool Toolbar Functionality
Toolbar Functionality
-8-
CANLink Diagnostic Tool Toolbar Functionality
On the CANLink Diagnostic Tool there are three or four buttons used on the main toolbar
based on access privileges. The four-button configuration is shown in the diagram
below:
Figure 7
EXIT BUTTON:
CONNECT/DISCONNECT BUTTON:
The Connect/Disconnect button is used to either connect/disconnect the CANLink
Diagnostic Tool to/from your equipment. The button will appear in one of two ways
depending on whether there is a communications link between the CDT and your PC.
This is shown below:
MULTI-VIEW BUTTON:
The MULTI-VIEW button is used to group up to 20 parameters from any window
(except Modules and EEPROM) in one Multi-View window.
ADDING/REMOVING Parameters:
To enable selection of parameters for the Multi-View window, click the Multi-View button. After clicking
it will appear as follows.
-9-
CANLink Diagnostic Tool Toolbar Functionality
The blue border indicates that the CDT is ready to select parameters for the Multi-View
window. To select a parameter, open the data window containing the parameter of
interest (see Data Windows section), and right-click on it. A Multi-View window will
pop up containing the parameter.
TIP: The Multi-View button works best for large systems with many inputs, outputs, variables, etc, where
it is inconvenient to monitor several parameters simultaneously within their respective data windows (See
Data Windows).
If more parameters are desired for the Multi-View window, continue right-clicking on
other desired parameters. Every time a parameter is added to the Multi-View window,
that parameter will turn blue in its original data window. Right-clicking a parameter that
has been previously added will cause that parameter to be removed from the Multi-View
window.
Note that the Multi-View window has a limit of twenty parameters. Once all desired
parameters have been added, click the “RUN – Multi-View” button at the top of the
Multi-View window. See figure below:
Figure 8
The button will now read “STOP – Multi-View”, and all selected parameters will be periodically updated.
Figure 9
If you want to add more parameters to a running Multi-View window, click the “STOP – Multi-View”
button, click the Multi-View button on the toolbar to highlight it in blue, right-click on desired parameters
as before and then click the “RUN – Multi-View” button. To close a Multi-View window, simply click the
“X” button on the upper right.
- 10 -
CANLink Diagnostic Tool Toolbar Functionality
NOTE: To differentiate between parameter types added to the Multi-View window, the parameters
corresponding icon is also added to the list.
TIP: Notice that only one parameter at a time can be “checked” in its checkbox. Doing this will sound an
audible tone when that parameter has changed value.
- 11 -
CANLink Diagnostic Tool Data Windows
Data Windows
- 12 -
CANLink Diagnostic Tool Data Windows
Description:
A data window is used to arrange similar type parameters in a spreadsheet format. Related information for
each parameter is included in its respective row. When the CDT is connected, the state/value of each
parameter will be periodically updated. To open a window for viewing, go to the “View” pull-down at the
upper left of the CDT and select the desired window.
Figure 10
If a window becomes “hidden” behind other windows, it may be brought to the top by selecting the desired
window from the “Window” pull-down at the upper left of the CDT.
Figure 11
If specific windows are desired to open as default whenever the CDT is connected, follow these steps:
• Open all desired default windows.
• Size and place windows in desired locations.
• From the “File” pull-down on the upper left, select “Save Window Setup”.
- 13 -
CANLink Diagnostic Tool Data Windows
MODULES Window:
Description
The Modules window includes CANLink modules on your equipment. The Name, Status, and CAN
Status can be observed from this window.
TIP: Viewing a module’s status is the best starting point when troubleshooting a system problem. If a
module is “Missing”, all of its inputs and outputs will not be contributing to the system’s control. Ensuring
proper communications between all system members is an imperative first step (check wiring and power).
CAN Status:
° OK: system is communicating correctly
° CAN1 Bad: Dual CAN system only, utilizing the second CAN bus (CAN2), CAN1 is not functioning
properly
° CAN2 Bad: Dual CAN system only, utilizing the first CAN bus (CAN1), CAN2 is not functioning
properly
° Unknown: status unknown, module may be “Missing”
Versions Button: Clicking the “Versions” button at the bottom of the Modules window will generate a pop
up window showing the software version of each CANLink module, as shown below:
- 14 -
CANLink Diagnostic Tool Data Windows
Figure 14
- 15 -
CANLink Diagnostic Tool Data Windows
INPUTS Window:
Description
The Inputs window contains all the connected CANLink module inputs for the equipment. It does NOT
include inputs from other devices on your system such as CAN joysticks, encoders, etc. that may be listed
in the Variables window. Within the Inputs window, the Name, Value and Units can be observed. Also,
there are two pull-down menus to the right of the View/Sort label at the top on the Inputs window.
Figure 15
Name: Each input is given a name by the equipment’s OEM, and appears in this column.
Value: In this column, the values of all inputs will be displayed. It will either be a numeric value for analog
inputs, or ON/OFF for digital inputs.
View/Sort: If your equipment has many inputs, such that they cannot all fit in the Inputs window at once,
you can use the View/Sort pull-down menus to view inputs in two convenient ways (besides viewing them
all). The first way is to sort out all inputs for a given module on the system. To do this, first pull down on
the left pull-down menu (which defaults to ALL) and select “Module”. Then pull down on the other menu
and select the module of interest. At that point all the inputs for that module only will appear in the Inputs
window.
Figure 16
- 16 -
CANLink Diagnostic Tool Data Windows
Figure 17
The other way to View/Sort is by predetermined groups. To do this, pull down on the left pull-down and
select “Group”. Then pull down on the right pull-down menu and select a group. Your equipment’s OEM
predetermines the types of groups and which inputs listed within a group.
Figure 18
PINOUT Information: Pinout information can be obtained for any input by double-clicking on the input
name, a pop-up window will appear showing pinout information.
Figure 19
- 17 -
CANLink Diagnostic Tool Data Windows
OUTPUTS Window:
Description
The Outputs window has within it all the connected CANLink module outputs for the equipment. It
does NOT include outputs from other devices not controlled by a CANLink module. For all outputs listed
within the Outputs window, the Name, On/Off/Duty, and Units can be observed. In addition, Current
Feedback and/or Status and/or Flash Status may be observed if the module’s hardware supports it. There
are two pull-down menus to the right of the View/Sort label at the top on the Outputs window, used for
sorting.
Figure 20
Name: Each output is given a name by the equipment’s OEM, and appears in this column.
Value:
° On/Off: If an output is digital, it will show either ON or OFF depending on its state.
° PWM Duty Cycle: The value commanded is a percentage ranging from 0% to 100%.
° Constant Current: The value commanded is a current value in mA.
Current Feedback (Cur Fdbk): This column displays the current through the output, given in mA.
Status: The status shows how a particular output “appears” to the module it is on.
° Normal: output attached to normal load
° Open: no load attached to output
° Short GND: output shorted to ground
° Short BATT: output shorted to battery
° OverCurrent: load attached to output is drawing excess current
° Grounded: servo on output is shorted to ground
- 18 -
CANLink Diagnostic Tool Data Windows
Flash: Output Flashing is a means of commanding an output to turn on and off automatically. If Flash is
enabled, it will display “On” in this column.
PINOUT Information: Pinout information can be obtained for any output by double-clicking on the
output name. See INPUTS Window section for example.
- 19 -
CANLink Diagnostic Tool Data Windows
VARIABLES Window:
Description
The “Variables” window is where the Server Module variable information can be displayed. For example,
it can be from another device communicating with the Server via CAN such as a CAN joystick. For all
variables listed within the Variables window, the Name, Value and Units can be observed. Also, there are
two pull-down menus to the right of the View/Sort label at the top on the Variables window, used for
sorting.
Figure 21
Name: Each variable is given a name by the equipment’s OEM, and appears in this column.
Value:
° Digital: ON or OFF
° Other: Various numeric values
PINOUT Information: Pinout information can be obtained for any variable by double-clicking on the
variable name. See INPUTS Window section for example.
- 20 -
CANLink Diagnostic Tool Data Windows
Figure 22
NOTE: When debugging J1939 values, system must be reset to ensure debugged values are fully reset.
- 21 -
CANLink Diagnostic Tool Data Windows
Figure 23
- 22 -
CANLink Diagnostic Tool Data Windows
Figure 24
Figure 25
- 23 -
CANLink Diagnostic Tool Data Windows
Within the EEPROM window there are three columns, five buttons, and a Value window.
Columns: The first column is the Parameter column, which simply shows the name of the parameter. The
second column is the Value column, and it shows the value actually read from the various EERPROM
locations. The third column, the Default column, has values in it which are predetermined by your system’s
OEM, and cannot be changed. These values can be used individually as a reference or can be used for
wholesale replacement of all values if necessary.
Functions
Once you open the EEPROM window, all three columns appear full of information. The only information
you can edit is the Value column. Should you want to edit a parameter, simply double-click on the
parameter name. At that point, the row of that parameter name will be highlighted, and the value of that
parameter will appear in the Value window on the lower left. Enter in a new value in the Value window.
SET Button (access based): Once a new value is entered into the Value window, you need to click the
SET button to cause the system to operate with the new value. Once you do this, you should notice your
new value is also in the Value column of the EEPROM window for the highlighted parameter. You can
keep entering new values and “SETTING” them into the Value column as much as you want, for as many
parameters as you want, and every time a new value is entered in, the system will now run using your new
values. In this way, a system can be tweaked quickly without committing/saving the trial and error values.
Once you are satisfied with a set of values, you’ll need to save your new settings. Clicking the EXIT button
at this point will generate a pop up window asking if you want to save your changes, at which point you
can choose either YES or NO. Otherwise, you can save your new settings with the SAVE ALL button.
SAVE ALL Button (access based): The SAVE ALL button will take all the values currently in the Value
column, and save them to their proper place in EEPROM. If you don’t save the new values, the next time
the modules are reset, your new values will be lost, and the old saved values will be reloaded.
READ Button: At any time while the EEPROM window is active, you can click on the READ button to
replace all values in the Value column with all currently saved EEPROM values. It can be useful if you’ve
been making numerous changes without saving, and you decide you want to return to the previous saved
state.
SET ALL TO FACTORY DEF(aults) Button (access based): During system development, a set of “best
guess” values for each EEPROM parameter is determined and used for factory defaults. They are nominal
values, which are intended as a basis from which to start the tuning process. At times, should the tuning
process go awry, you may want to click this button to copy all the values in the Default column into the
Value column. If you choose to restore the defaults, you’ll still need to save them by clicking the Save All
button. Great care should be given before restoring the defaults.
IMPORTANT: IF YOU RESTORE THE DEFAULTS, YOUR SYSTEM WILL RETURN TO AN UN-
TUNED STATE WHERE ALL CALIBRATIONS WILL BE LOST.
EXIT Button: The EXIT button will close the EEPROM window. If any values were “SET” into the Value
column, you will be asked if you want to save the changes made (YES or NO?).
- 24 -
CANLink Diagnostic Tool Data Windows
Figure 26
Write EEPROM to File Button: The Write EEPROM to File button will read the current EEPROM
values and write them to a text file. The user will be prompted to supply a file name and file location.
- 25 -
CANLink Diagnostic Tool Debug
Debug
- 26 -
CANLink Diagnostic Tool Debug
The Debug feature of the CANLink Diagnostic Tool is one of its most useful features. It allows for
artificial manipulation of Inputs, Outputs, Variables, and J1939 data. For this reason, however, the
following must be restated:
The Debug button, if available, is located on the main toolbar for the CANLink Diagnostic Tool and
appears like the following.
If debugging is desired, click on this button. This button allows you to select items for debugging, similar
to how you select items for Multi-View. After clicking, the button will appear like the following:
The red border indicates that the tool is ready to select items. Next, open the window containing the
parameter of interest, find the desired parameter, and right-click on the parameter. At this point, there are
different steps to debugging, depending on the type of parameter selected (Input, Output, etc). It is best to
discuss each type separately.
Debugging Outputs:
Debugging outputs is more complicated than debugging inputs. The complexity comes in when considering
four different options for debugging outputs, which are Value, Current, Status, and Flash. As with selecting
Inputs, you can select outputs for debugging by right clicking on the parameter of interest to have it appear
in the Debug window. However, with outputs, you may be prompted to select, via a pop up window, from
Value, Current, Status, and Flash, and appear as follows:
- 27 -
CANLink Diagnostic Tool Debug
Figure 27
Debug options will be based on whether the output has been set up for Current Feedback, Output Status, or
Output Flash, and/or your level of access privileges to the CANLink Diagnostic Tool. Unavailable features,
the check-boxes for the unavailable features will be grayed out.
Figure 28
To run in Debug Mode, click “TURN DEBUG ON”. Now the button should read “TURN DEBUG OFF”.
See figure:
Figure 29
- 28 -
CANLink Diagnostic Tool Debug
Values can be changed prior to running in Debug Mode or during. Click “TURN DEBUG OFF” to stop
Debug Mode. On stopping Debug Mode, based on access privileges, the system may enter into Safe Mode
and you may be prompted to automatically reset the system.
Figure 30
After resetting the system the CDT will become disconnected. A prompt will ask if you will want to
reconnect.
Figure 31
After reconnecting, the CDT is ready for normal operation.
- 29 -
CANLink Diagnostic Tool Misc. CDT Operations
- 30 -
CANLink Diagnostic Tool Misc. CDT Operations
Menu Bar:
Comm
When the CDT is not communicating, this is where the Comm Port is selected
(defaulted to Comm1). Once selected, this setting is stored and used on next
execution of the CDT.
Figure 32
About
Clicking on the About menu, the CDT will display version information of the CDT.
Figure 33
Figure 34
- 31 -
CANLink Diagnostic Tool Misc. CDT Operations
Figure 35
Figure 36
While in Safe Mode, some parameters configured for Safe Mode will not update. These
parameters are fixed until Safe Mode has been reset. Click “RESET ESTOP” to run the system back in
normal mode. All parameters will update periodically after resetting E-STOP.
- 32 -
CANLink Diagnostic Tool Misc. CDT Operations
FAQ’s
Figure 37
3) Some features are not available on my CDT software, why?
° Your password does not allow access to those features.
° The system was not configured to allow those features.
4) How can I obtain new/change passwords, obtain a new IOc file, or change access levels?
° Contact the equipment’s OEM for assistance.
- 33 -
®
Company Information
Hydro Electronic Devices, Inc.
1715A Innovation Way Hartford, WI 53027
Web Site
http://www.hedonline.com
©
Hydro Electronic Devices, Inc. 2005
The company assumes no responsibility for any errors which may occur in this document, reserves the right to change information detailed
herein at any time without notice, and does not make any commitment to update the information contained herein.
Marks bearing ® and/or ™ are registered trademarks and trademarks for Hydro Electronic Devices, Inc.
- 34 -
©
Hydro Electronic Devices, Inc. 2005