Difference between revisions of "HANtune/Quick Start"

From OpenMBD
Jump to: navigation, search
Line 82: Line 82:
 
''Hint: Try to use multi-select! Some editors and viewers are capable of showing more than just one signal or parameter.''
 
''Hint: Try to use multi-select! Some editors and viewers are capable of showing more than just one signal or parameter.''
  
−
== using HANtune as a generic CAN dashboard ==
 
  
−
{{HANtune}}
 
  
 +
==Connect to your controller==
  
−
HANtune can be used to present CAN-traffic in a human readable format. That means that the raw CAN-data is converted to physical values and presented along with the appropriate name and unit. To be able to do this, a descriptive file is needed which contains this information: the DBC file.
 
  
−
These files have the following convention:
+
In the upper menu, click "Communication". A submenu will appear, click on "Communication Settings".
  
  
−
CAN-Message: The entire message frame, belonging to one CAN-ID
+
[[File:Communicaton HANtune_Settings.png|400px]]
  
−
CAN-Signal: One CAN-Message contains one or more signals. A signal has a unit and name, e.g. oilTemp [°C]
 
  
−
To start using HANtune as a CAN-dashboard, the following two elements are needed:
+
The Communication Settings window will appear. Please notice the four tabs. The first tab contains the general settings. The other three contain the communication medium specific settings.
 +
Currently there are four ways to connect to your controller: using XCP on USB, Ethernet or CAN or using CAN-Only. The latter doesn't require an ASAP2 file but does require a DBC file to be loaded. Depending on which of these communication media is chosen, go to the corresponding tab and check the corresponding settings. [http://openmbd.com/wiki/HANtune/Communication Click here to learn more about the Communication Settings.]
  
  
−
A CAN database file (DBC) which matches the messages on the CAN-bus. This file with the .dbc file extention following the .dbc (quasi-) standard. This file defines the identifier, name, scaling, offset, etc. of CAN massages, enabling HANtune to present the raw CAN-data in a human readable format.
+
[[File:HANtune_Communicaton Settings Window.png|400px]]
  
  
−
* In the side-tab “Project Data” there is a folder named “DBC files”. Right click this folder and choose “Add DBC file”
+
Hit the F5 key or click on the connect button at the lower left corner. The button will turn green when a connection is established.
−
* Browse to the DBC (*.dbc) file which you want to use, select it and press “Open”
 
−
* The file has now been added to your project but is not loaded. To load, double click on the DBC file which you want to load or right click and choose “load file”
 
  
−
(For more info go to: Chapter xx how to add a DBC file)
 
  
−
 
+
[[File:HANtune_Conncted.png|400px]]
−
A Layout which contains tabs with editors and/or viewers. A default Layout called “Unnamed” is already available and loaded. You can find the CAN messages in the “CAN elements” side tab.
 
−
Editors: can be used to send CAN-messages to the CAN-bus
 
−
Viewers: can be used to visualize CAN-messages from the CAN-bus
 
  
  
−
===To create an editor (send CAN-messages):===
+
Click connect
−
* Go to the tab “CAN Elements”
 
−
* Search for the CAN-signal which needs to be sent
 
−
* Drag-and-drop the CAN-signal to your layout (empty white space)
 
−
* Choose the right type of editor
 
−
For more info on how to use editors see '''INSERT LINK HERE!!!'''
 
−
 
 
−
 
 
−
===To create a viewer (visualize CAN-messages):===
 
−
* Go to the tab “CAN elements”
 
−
* Search for the CAN-signal which needs to be showed
 
−
* Drag-and-drop the CAN-signal to your layout (empty white space)
 
−
* Choose the right type of viewer
 
−
 
 
−
 
 
−
For more info on how to use viewers see '''INSERT LINK HERE!!!'''
 
−
You are now ready to connect to the target. Check the communication settings by clicking the menu item “Communication” (top of screen), “Communication settings”. If these settings are correct and your target is powered on and connected to the PC, press F5 and click “Connect and request” to connect.
 
−
For more info on establishing a connection see: chapter 0 how to make a connection with a controller
 
−
To save your project: click “File”, “Save Project as…” in the menu. Choose a filename and the path where to save your project and click “Save”. Your project will be saved as a .hml file.
 
−
 
 
−
''Hint: Try to use multi-select! Some editors and viewers are capable of showing more than just one signal or parameter.''
 
−
 
 
−
 
 
−
 
 
−
 
 
−
 
 
−
[[File:Communicaton HANtune_Settings.png|400px]]
 
−
 
 
−
 
 
−
[[File:HANtune_Communicaton Settings Window.png|400px]]
 
−
 
 
−
 
 
−
[[File:HANtune_Conncted.png|400px]]
 
  
  
 
[[File:HANtune_ConnectToTarget.png|400px]]
 
[[File:HANtune_ConnectToTarget.png|400px]]

Revision as of 14:44, 5 May 2017


HANtune can be used for tuning and calibration, using the XCP protocol or as a generic CAN-dashboard. herefore this quick-start contains two sections: one for tuning and calibration and one for HANtune as CAN-dashboard. This section is intended for first time users.

Creating a Layout

For tuning and calibration, using the XCP protocol, an ASAP2 file is needed and a Layout is to be created. An ASAP2 File (.a2l) contains all the data about each signal and parameter which the controller uses. HANtune can read this data and allow the user to use it in HANtune. This could be a file which is automatically generated after compiling your Simulink model or one which is provided elsewhere.


In order to load a layout into HANtune, please follow these steps:

  • In the side-tab “Project Data” (1) there is a folder named “ASAP2 files” (2). Right click this folder and choose “Add ASAP2 file” (3)

(Using HANtune for CAN-only? Click "Project Data"(1), right click "DBC files", choose "Add DBC file")

HANtune ImportAsap2.png


  • Browse to the ASAP2 (*.a2l) file which you want to use, select it and press “Open”

(Using HANtune for CAN-only? Select the DBC (*.dbc) file which you want to use, select it and press “Open”)

HANtune OpenAsap2.png


  • The file has now been added to your project but is not loaded. To load, double click on the ASAP2 file which you want to load or right click and choose “load file”

(Using HANtune for CAN-only? Double click the DBC file or right click and choose “load file”)

HANtune LoadAsap2.png


Click here for more info about the ASAP2 tide-tab


A Layout which contains tabs with editors and/or viewers. A default Layout called “Unnamed” is already available and loaded. You can find the parameters and signals under the ASAP2 elements side-tab. Editors: can be used to send parameters to the target Viewers: can be used to visualize signals from the target

To create an editor (change parameters):

Editors can be used to send parameters or CAN-Messages to the controller or CANbus, respectively.

  • Go to the side-tab “ASAP2 Elements” (using CAN-Only? Click "CAN Elements" instead)
  • Search for the parameter which needs to be showed and drag and drop it into your layout (empty white space)

HANtune DragAndDropParameter.png

  • Choose the right type of editor

HANtune DragAndDropMenu Editor.png

  • The editor will appear on screen

HANtune DragAndDropSliderEditor.png

Click here to learn more about Editors.

To create a viewer (visualize signals):

Viewers can be used to monitor signals sent by the controller or read CAN-Messages from the CANbus.

  • Go to the tab “ASAP2 Elements” (using CAN-Only? Click "CAN Elements" instead)
  • Search for the signal which needs to be showed and drag and drop it into your layout (empty white space)

HANtune DragAndDropSignal.png

  • Choose the right type of viewer

HANtune DragAndDropMenu.png

  • The viewer will appear on screen

HANtune DragAndDropGauge.png

Click here to learn more about Viewers.

You are now ready to connect to the target. Check the communication settings by clicking the menu item “Communication” (top of screen), “Communication settings”. If these settings are correct and your target is powered on and connected to the PC, press F5 and click “Connect and request” to connect. For more info on establishing a connection see: chapter 0 how to make a connection with a controller To save your project: click “File”, “Save Project as…” in the menu. Choose a filename and the path where to save your project and click “Save”. Your project will be saved as a .hml file.


Hint: Try to use multi-select! Some editors and viewers are capable of showing more than just one signal or parameter.


Connect to your controller

In the upper menu, click "Communication". A submenu will appear, click on "Communication Settings".


Communicaton HANtune Settings.png


The Communication Settings window will appear. Please notice the four tabs. The first tab contains the general settings. The other three contain the communication medium specific settings. Currently there are four ways to connect to your controller: using XCP on USB, Ethernet or CAN or using CAN-Only. The latter doesn't require an ASAP2 file but does require a DBC file to be loaded. Depending on which of these communication media is chosen, go to the corresponding tab and check the corresponding settings. Click here to learn more about the Communication Settings.


HANtune Communicaton Settings Window.png


Hit the F5 key or click on the connect button at the lower left corner. The button will turn green when a connection is established.


HANtune Conncted.png


Click connect


HANtune ConnectToTarget.png

Retrieved from "http://openmbd.eu/wiki/index.php?title=HANtune/Quick_Start&oldid=1917"