Visual CAN Mapping

<< Click to Display Table of Contents >>

Navigation:  CAN >

Visual CAN Mapping

Visual CAN Mapping (VCM) is a graphical view for mapping objects.  With Visual CAN Mapping there is an easy and comfortable way to create or adjust mapped variables.

Via drag and drop it is easy to add/move or remove variables  in the table. So it is possible to update the mapping object very fast.

hmtoggle_plus1Overview

The Visual CAN Mapping view is divided in 3 views.

1. VCM Table: Here you can see all mapped variable and it is possible to add / move or remove them by drag and drop.

2. VCM Toolbar: In the toolbar you can "Add", "Move Up", "Move Down" and "Delete" variables. Within there is the possibility of a full search after variables and which will be shown at the Variable Tree. In addition you can drag variables from Variable Tree to the VCM Table.

3. VCM Configure Mapping Table: If  variable is selected at the VCM Table, the properties of the mapping will be shown here. The table is similar to the table at the tab "Configure Mapping"

VCM_complete_number
hmtoggle_plus1Open Visual CAN Mapping view

Visual CAN Mapping is available for all protocols (CANopen, J1939 and CANFreestyle)

It can be opened at the dialog "Configure Mappings...".

To open Visual CAN Mapping please navigate to:

   Communication - Protocols -

      (1) CANFreestyle     or

      (2) CANopen            or

      (3) J1939

           - (4) Configure Mappings...

vcm_menu_protocolsvcm_menu_configure_mappings

 

A new dialog "Configure Mappings Dialog" will be opened.

Afterwards you can open the VCM by selecting a (1) "Mapping Object" and clicking on (2)"Visual CAN Mapping" on the tab.

 

open_vcm_table

 

Alternatively, you can use the three shortcuts in the tool bar.

clip0054
hmtoggle_plus1VCM Toolpanel

vcm_toolpanel_overview

 

(1) Button panel for add, delete, move variable mappings. The buttons will be disabled/enabled depending on the state of the VCM table.

(2) Search field to search after variables

(3) Variables tree with all variables which can be mapped to current mapping object. The variable tree will be update automatically when the search field changes.

There are 2 possibilities to add variables/constants

 

1. Add variable/constant with "Add" button.

toolpanel_add

 

1a Add variable

By clicking on "Add" (1) a new dialog will be opened. In the dialog you can select a variable which is allowed to map to the current mapping object.

 

add_var

 

You can filter the variable in 2 categories:

   - filter by "Owner" (1)

   - filter by "Group" (2)

After changing the filter types the possible variables are shown in the last combo box "Variables" (3).

 

By clicking "OK" the selected variable will be added to the current mapping object.

 

1b. Add constant

By clicking on "Add" a new dialog will be opened.

 

add_const

 

If you want to add a constant you have to select the check box "Constant" (1). All other fields will become disabled.

By clicking "Add"  a constant will be added to the current mapping object.

 

Note 1:

If a variable is selected the new variable/constant will be added at the start bit of the selected variable. All other variables will be moved as much as the length of the added variable.

If no variable is selected the new variable will be added after the last mapped variable.

 

If there is not enough space for the original length of the variable the mapped length will be reduced.

If the mapping object is full mapped the add button will be disabled. When it is tried to drag and drop a variable from variable tree the variable will not be added to the mapping object.

 

2. Add variable from variable tree

 

2a Add variables via drag and drop from variable tree

A comfortable way for adding variables is to drag and drop them from the variable tree. All available variables will be shown in the tree sorted by groups.

To add a variable to the mapping object you can drag one and drop them at a cell of the table.

 

2b. Add constants via drag and drop from variable tree.

If you want to add a constant from variable tree you can select a constant form group "Constants" (only for CANFreestyle and J1939). For CANopen the group "Constants" is replaced with the group "Dummy Variables".

It works as same as for variables (see above 2a.).

 

Note 2:

Constants are not available for CANopen mappings and J1939 delimiter mappings.

The length of the constant can be changed by clicking on the constant at the VCM table. Afterwards you can update the length at the VCM Configure Mapping table.

For more information about the VCM Configure Mapping table look here.

Like with adding a variable there are also several ways to delete a variable:

 

toolpanel_delete

 

1a. Clicking "Delete" button

The delete button is only enabled if at least one variable is selected at the VCM table.

All selected variables will be deleted when "Delete" is pressed. The position of other mapped variables will not change (except for CANopen).

 

1b. Delete variables via drag and drop

A second way to delete variables is to drag variables and drop them outside of the table.

 

1c. Delete variables with press of  "Del" key

Another way to delete variables is to press the "Del" key of the keyboard. Only the selected variables will be removed

 

1d. Delete variables via context menu

A variable can be removed by clicking with right mouse button on the variable and then choosing "Delete".

 

toolpanel_move

 

1. Move variable up/down with buttons

Selected variables can be moved in the VCM table via the buttons "Move Up" or "Move Down".

 

If a variable is moved down and behind the current variable is another variable, the variables switch there positions.

If there is no other variable behind the current selected on the variables moved by 1 bit.

 

For moving up it works the same way.

 

2. Trigger move up/down via mouse wheel

The move function can also be triggered with the mouse wheel. If you want to to move up or down selected variables, you have to press the left "Ctrl" key of the keyboard together with mouse wheel up or down.

 

Note:

If the current variable starts at bit 1. The button "Move Up" is disabled.

If the mapping object is full mapped and the last variable is selected the button "Move Down" is disabled.

If the last bit of mapping is mapped (e.g. bit 64 for CANFreestyle mapping) the mapping object is full mapped.

variable_tree

 

1. Structure

The variable tree contains all variables which can be mapped for the current mapping object.

 

At the searchfield (1) you can search after variables by their

   - names

   - groups

   - owners

   - index

   - subindex

 

The variable tree (2) will be updated in real time after the first input at the search field. Only variables which hit the search text will be shown.

To add a variable to the VCM table drag a varaible (3) and move it to the VCM table. After dropping the variable, it will be visible at the table.

 

2. Variable icons

With the help of the variable icons it can be seen if the variable is already mapped in one of the mappings of the current protocol.

There are 4 icons:

 

1.Variable is not mapped in any mapping

  var_not_mapped

 

2. Variables is mapped in at least one "receive" mapping

  var_mapped_rx

 

2. Variables is mapped in at least one "transmit" mapping

  var_mapped_tx

 

2. Variables is mapped in at least one "receive" and one "transmit" mapping

  var_mapped_rx_tx

 

3. Variable tool tip

If the mouse is moved to a variable at the variable tree a tool tip will be shown with the useful information

 

3a. Information for all variables

   - Variable Name

   - Group

   - Index

   - SubIndex

   - Access Type

   - Data Type

   - Length

   - Owner

 

3b. Information for mapped variables

If a variable is mapped, the mapping objects will be shown also at the tooltip.

 

In this example it is displayed that the variable "Engine OiI" is mapped at one

   - Receive Mapping     =>    "Rx:   Engine_Rx"

and it is mapped at one

   - Transmit Mapping     =>    "Tx:   Engine_Tx"

 

 

4 Variable tree context menu

 

var_tree_context_menu

 

There are 3 options at the context menu of the variable tree

 

(1) Collapse all

Only the groups of the variable will be shown

 

(2) Expand all

All groups with all variables will be shown

 

(3) Open Variable Manager...

The variable manager will be opened and the selected variable of the variable tree will be shown. At this dialog you can edit the variable.

If you want to learn more about the "Variable Manager" dialog please have a look here.

 

Note:

If a variable is opened at the variable manager which is already mapped, the variable is not complete editable. Properties like "Name", "Index", "SubIndex", "Data Type" and "Length" are not editable.

Once the variable is not mapped anymore, the variable will complete editable again.
hmtoggle_plus1VCM Table

vcm_table

- The column titles shows the bit number of the current byte and the row titles shows the appropriate byte.

- The table starts in the upper right corner with bit index 1, which represents the first bit of a mapping.

- At the end and start bit the name of mapped variable / constant is shown.

- Each mapped variable has its own color. Altogether there are 16 colors for variables and 4 grey colors for constants.

- Each variable (when selected) can be moved or removed at the table.

- Selected variables are shown with a bold black border and the color is lightly highlighted.

- It is possible to select several mapped variables by selecting the first one and then press "Shift" and selecting afterwards another variable.All variables between are selected too.

- Selected variables are a variable block which can only be moved together.

- As long as you stay at the view "Visual CAN Mapping" all  add, remove, move steps and property changes can be reverted. If you want to undo the last step you can press "Ctrl + z" or "Ctrl + y" to redo the last step.

To move a variable via drag and drop, you can drag the first bit of the of a variable ("Bit 1" "Engine_Speed") and then move the mouse to "Bit 9")

If you drop the variable on "Bit 9" the variable "Engine Speed" and the "Constant" switch their positions.

 

vcm_table_move_var

 

After dropping the variable "Engine_Speed" at "Bit 9" they switch the position

vcm_table_drop_var_2

 

Now you can move the variable "Engine_Speed" to "Bit 17". If you try this you will get following picture (1):

 

vcm_table_move_var_3

 

The variables "Engine_Speed" and "Engine_Temp" can not switch their positions, because variable "Engine_Temp" has a length of 16 bits but the gap (Bit 9 - Bit 16) is only 8 bits.

For that reason the moved variable "Engine_Speed" is turned to red color, which means that the current position of the variable is not valid. If you try to drop the variable at "Bit 17",

the variable will go back to its last valid position at "Bit 9".

 

If you drop the variable "Engine Speed" at "Bit 25", "Engine Speed" and "Engine_Temp" will switch their positions (1).

 

vcm_table_move_var_4

 

Note:

Every time if the moved variable(s) can not be dropped on the current mouse position the variables will be turned to red color to demonstrate that the current position is invalid.

The variable(s) can only be moved if the gap is big enough to switch the variables.

If you want to move the variables e.g. to add a gap you have to select all variables and move them together.

If you want to delete some variables from the VCM table, you can select (1) them and then drop them outside of the table.

 

vcm_table_remove_var

 

The variables will turn  red if they are dragged out of the table. If you drop them outside they will be deleted.

 

vcm_table_delete_2

 

The position of the other variables will not be changed after the deleting. (Except for CANopen (CANopen does not allow gaps): For CANopen the other variables will be moved to the beginning of the table.

vcm_table_context_menu

 

There are 3 options at the context menu of the VCM table

 

(1) Delete

The selected variable(s) will be deleted.

 

(2) Open Variable Manager...

The variable manager will be opened and the selected variable of the variable tree will be shown. At this dialog you can edit the variable.

If you want to learn more about the "Variable Manager" dialog please have a look here.

 

(3) Reset Colors

Sometimes it can happen that variables have the same color. So it is difficult to differ them.

In that case the colors can be recalculated and all variables get different colors again.

 

Note:

The colors of mapped variables will not be stored.

If the tool is closed and started again, it could be that colors of mapped variables changes.

If the mouse hovers over a variable at the variable tree, a tool tip will be shown with the useful information

 

vcm_table_tooltip

 

Information for all mapped variables

   - Variable Name

   - Group

   - Length (Mapped Length)

   - Mask

   - Offset

   - Shift X Bits

   - Scale

   - Offset 2

If a variable is mapped to a mapping object and afterwards the length is reduced, the mapped variable gets an attention symbol ((1,2) attention_symbol).

This should help to identify mapped variables with a wrong length. If everything is fine, the attention icon can be ignored.

 

vcm_table_attention

 

At the tool tip (3) you can see the original length (16 bit) and the mapped length (8 bit).
hmtoggle_plus1VCM Configure Mapping Table

To change a property of a variable the "Configure Selected Variable Mapping" ((2) VCM Configure Mapping Table) table can be used.

The VCM Configure Mapping Table is only filled if only one variable is selected (1). If no variable or several variables are selected the VCM Configure Mapping Table keeps empty.

 

You can easily change the values at the VCM Configure Mapping Table like at the view "Configure Mapping".

If the "Byte Bit Position" (2) is changed the VCM table view will updated in real time. The same happens if the "Length" is updated.

It is also possible to make a current variable to a constant or change the variable.

 

For more information about the fields "Mask", "Offset1", ... please have a look at the appropriate protocols.

 

configure_table