HMS IXXAT CANbridge User manual

CANbridge
CAN-to-CAN Gateway
USER MANUAL
4.01.0120.20000 2.1 en-US ENGLISH

Important User Information
Disclaimer
The information in this document is for informational purposes only. Please inform HMS Industrial Networks of any
inaccuracies or omissions found in this document. HMS Industrial Networks disclaims any responsibility or liability
for any errors that may appear in this document.
HMS Industrial Networks reserves the right to modify its products in line with its policy of continuous product
development. The information in this document shall therefore not be construed as a commitment on the part of
HMS Industrial Networks and is subject to change without notice. HMS Industrial Networks makes no commitment
to update or keep current the information in this document.
The data, examples and illustrations found in this document are included for illustrative purposes and are only
intended to help improve understanding of the functionality and handling of the product. In view of the wide range
of possible applications of the product, and because of the many variables and requirements associated with any
particular implementation, HMS Industrial Networks cannot assume responsibility or liability for actual use based on
the data, examples or illustrations included in this document nor for any damages incurred during installation of the
product. Those responsible for the use of the product must acquire sufficient knowledge in order to ensure that the
product is used correctly in their specific application and that the application meets all performance and safety
requirements including any applicable laws, regulations, codes and standards. Further, HMS Industrial Networks will
under no circumstances assume liability or responsibility for any problems that may arise as a result from the use of
undocumented features or functional side effects found outside the documented scope of the product. The effects
caused by any direct or indirect use of such aspects of the product are undefined and may include e.g. compatibility
issues and stability issues.
CANbridge User Manual 4.01.0120.20000 2.1 en-US

CANbridge User Manual 4.01.0120.20000 2.1 en-US
Table of Contents Page
1 User Guide ........................................................................................................................... 3
1.1 Related Documents ..........................................................................................................3
1.2 Document History ............................................................................................................3
1.3 Conventions....................................................................................................................4
2 Safety Instructions .............................................................................................................. 5
2.1 Information on EMC .........................................................................................................5
2.2 General Safety Instructions................................................................................................5
3 Scope of Delivery ................................................................................................................ 6
4 Product Description and Features...................................................................................... 6
5 Installation........................................................................................................................... 7
5.1 Connectors Aluminium Version...........................................................................................7
5.2 Connectors Industrial DIN Rail Version ................................................................................. 9
6 Configuration..................................................................................................................... 11
6.1 Starting and Operating the Download Tool CANBcfg ............................................................ 11
6.2 Creating the Configuration............................................................................................... 12
6.3 Load Configuration to Device ........................................................................................... 17
6.4 Show Current Configuration............................................................................................. 18
6.5 Standard Configuration ................................................................................................... 18
6.6 Configuration Example.................................................................................................... 19
7 Operation........................................................................................................................... 20
7.1 Automatic Baud Rate Detection Sequence.......................................................................... 20
7.2 Power LED (PWR)........................................................................................................... 20
7.3 CAN 1/CAN 2 LED........................................................................................................... 20
7.4 SER/COM LED................................................................................................................ 21
8 Additional Components .................................................................................................... 21
8.1 CAN Bus Termination...................................................................................................... 21
9 Technical Data ................................................................................................................... 22
10 Support/Return Hardware................................................................................................ 23
10.1 Support........................................................................................................................ 23
10.2 Return Hardware ........................................................................................................... 23

CANbridge User Manual 4.01.0120.20000 2.1 en-US
11 Disposal.............................................................................................................................. 23
A Regulatory Compliance ..................................................................................................... 25
A.1 EMC Compliance (CE) ..................................................................................................... 25
A.2 FCC Compliance Statement.............................................................................................. 25
A.3 Disposal and recycling..................................................................................................... 26

User Guide 3 (28)
1 User Guide
Please read the manual carefully. Make sure you fully understand the manual before using the
product.
1.1 Related Documents
Document Author
Installation Guide VCI Driver HMS
1.2 Document History
Version Date Description
2.0 October 2016 Revised and edited in new design.
2.1 June 2019 Layout changes, new disclaimer
1.2.1 Trademark Information
Ixxat®is a registered trademark of HMS Industrial Networks. All other trademarks mentioned in
this document are the property of their respective holders.
CANbridge User Manual 4.01.0120.20000 2.1 en-US

User Guide 4 (28)
1.3 Conventions
Instructions and results are structured as follows:
►instruction 1
►instruction 2
→ result 1
→ result 2
Lists are structured as follows:
• item 1
• item 2
Bold typeface indicates interactive parts such as connectors and switches on the hardware, or
menus and buttons in a graphical user interface.
This font is used to indicate program code and other
kinds of data input/output such as configuration scripts.
This is a cross-reference within this document: Conventions, p. 4
This is an external link (URL): www.hms-networks.com
Safety advice is structured as follows:
Cause of the hazard!
Consequences of not taking remediate action.
How to avoid the hazard.
Safety signs and signalwords are used dependent on the level of the hazard.
This is additional information which may facilitate installation and/or operation.
This instruction must be followed to avoid a risk of reduced functionality and/or damage
to the equipment, or to avoid a network security risk.
Caution
This instruction must be followed to avoid a risk of personal injury.
WARNING
This instruction must be followed to avoid a risk of death or serious injury.
CANbridge User Manual 4.01.0120.20000 2.1 en-US

Safety Instructions 5 (28)
2 Safety Instructions
2.1 Information on EMC
Risk of interference to radio and television if used in office or home environment!
Use exclusively included accessories. Use exclusively shielded cables.
Make sure that the shield of the interface is connected with the device plug and the plug
on the other side.
Aluminium Version
►Make sure, that the CAN bus that is connected to the CANbridge has a shielded lead.
►Make sure, that the shield braiding is laid flat on the connector housing.
Shield connections of CAN 1, CAN 2, serial interface RS232 and power supply are connected with
one another in the device.
Industrial DIN Rail Version
To achieve the highest interference immunity:
►Ground the shield of the two CAN busses on the assembly plate.
►Connect the ground terminal (PE) of the CANbridge to next available grounding.
Via parallel connection of a resistor and a capacitor the grounding connection is connected
internally to the GND of CAN 1, CAN 2 and of supply voltage.
Fig. 1 Shield concept industrial DIN rail version
2.2 General Safety Instructions
►Protect product from moisture and humidity.
►Protect product from too high or too low temperature (see Technical Data, p. 22).
►Protect product from fire.
►Do not paint the product.
►Do not modify or disassemble the product. Service must be carried out by HMS Industrial
Networks.
►Store products in dry and dust-free place.
CANbridge User Manual 4.01.0120.20000 2.1 en-US

Scope of Delivery 6 (28)
3 Scope of Delivery
Included in scope of delivery:
• CANbridge
• User Manual
• CD with download tool CANBcfg.exe and VCI Installation Guide
• configuration cable
• aluminium and automotive version: power supply cable
4 Product Description and Features
The CANbridge is a universal, intelligent CAN topology component, that allows the coupling of
two CAN networks, also with different bit rates or frame formats. CAN messages are received by
one network and transmitted in the other network, according to filter and implementation rules.
The CAN messages can be filtered based on CAN identifiers. Certain CAN messages can be
forwarded and others discarded. With this mechanisms the bus load can be reduced in the
associated network by transmitting only the messages that are of interest.
The baud rates of the CAN busses are freely configurable. Additionally the CANbridge provides
automatic baud rate detection. To configure the CANbridge a configuration file is used. The
configuration is created in ASCII code and loaded on the CANbridge with a download tool via the
serial interface.
Features and highlights:
• 2 x CAN high-speed connection (ISO 11898-2)
• Automotive version: optional 1 x CAN high-speed and 1 x CAN low-speed connection (ISO
11898-3)
• optionally galvanically isolated
• configuration via serial interface (RS232, optional RS485)
• CAN ID filtering
Versions
• Industrial DIN rail: plastic housing
• Industrial aluminium: aluminium housing
• Automotive: aluminium housing
CANbridge User Manual 4.01.0120.20000 2.1 en-US

Installation 7 (28)
5 Installation
5.1 Connectors Aluminium Version
Industrial and automotive version are available as aluminium version.
Fig. 2 Aluminium version
1Power supply
2Serial interface RS232
3 CAN 1
4 CAN 2
5.1.1 Power Connector
The CANbridge is protected against polarity reversal, under- and over-voltage.
• polarity reversal, under-voltage: device is switched off
• over-voltage: internal fuse is triggered
Pin Allocation
Pin no. Signal Lead color
1PWR + (9 V to 36 V DC, automotive: 7 V to
16 V)
White
2 GND - Brown
3Shield Shield
►Connect the power supply cable with the power connection and the power supply.
CANbridge User Manual 4.01.0120.20000 2.1 en-US

Installation 8 (28)
5.1.2 CAN Connectors
The signals of CAN 1 and CAN 2 are connected to D-Sub 9 connectors. In automotive version CAN
2 is available as CAN low speed.
Pin Allocation D-Sub 9 Connector
Pin no. Signal CAN connector, D-Sub 9
1—
2 CAN-Low
3 GND
4—
5—
6—
7CAN-High
8—
9—
5.1.3 Configuration Connector
The serial interface RS232 is used to configure the CANbridge. The signals are connected to a D-
Sub 9 connector.
Pin Allocation D-Sub 9 Connector
Pin no. Signal Serial interface RS232, D-Sub 9
1 DCD
2 RX
3 TX
4 DTR
5 GND
6 DSR
7 RTS
8 CTS
9 RI
5.1.4 Ground Connections
Version with galvanic isolation:
• GND of CAN 1 and CAN 2 isolated from rest of circuit
• GND of serial interface RS232 connected to GND of power supply
• shield connections of CAN 1, CAN 2, serial interface RS232 and power supply connected
with each other
Version without galvanic isolation:
• all GND connections (CAN 1, CAN 2, serial interface RS232 and power supply) connected
with each other
• shield connections of CAN 1, CAN 2, serial interface RS232 and power supply connected
with each other
CANbridge User Manual 4.01.0120.20000 2.1 en-US

Installation 9 (28)
5.2 Connectors Industrial DIN Rail Version
Fig. 3 Industrial DIN rail version
1 PE
2Power supply
3 CAN 1
4Serial interface RS232
5 CAN 2
Pins are labelled continuously on the device, starting with PE, labelled as 1.
5.2.1 Power Connector
The CANbridge is protected against polarity reversal, under- and over-voltage.
• polarity reversal, under-voltage: device is switched off
• over-voltage: internal fuse is triggered
Pin Allocation
Pin no. Signal
2PWR + (9 V to 36 V DC)
3 GND -
►Unplug the connector.
►Connect the cables.
►Plug the connector into the housing.
CANbridge User Manual 4.01.0120.20000 2.1 en-US

Installation 10 (28)
5.2.2 CAN Connectors
Pin Allocation D-Sub 9 Connector, CAN 1 and CAN 2
Pin no. Signal CAN 1 connector
4/7 CAN-High
5/8 CAN-Low
6/9 GND
5.2.3 Configuration Connector
The serial interface RS232 is used to configure the CANbridge. The signals are connected to a D-
Sub 9 connector.
Pin Allocation D-Sub 9 Connector
Pin no. Signal Serial interface RS232, D-Sub 9
1 DCD
2 RX
3 TX
4 DTR
5 GND
6 DSR
7 RTS
8 CTS
9 RI
5.2.4 Ground Connections
Version with galvanic isolation:
• GND of CAN 1 and CAN 2 isolated from rest of circuit
• GND of serial interface RS232 connected to GND of power supply
• shield connections of CAN 1, CAN 2, serial interface RS232 and power supply connected
with each other
Version without galvanic isolation:
• all GND connections (CAN 1, CAN 2, serial interface RS232 and power supply) connected
with each other
• shield connections of serial interface RS232 and PE (power connector, pin 1) connected with
each other
CANbridge User Manual 4.01.0120.20000 2.1 en-US

Configuration 11 (28)
6 Configuration
The Windows console program CANBcfg.exe is available for the configuration the CANbridge
(included on delivery CD).
6.1 Starting and Operating the Download Tool CANBcfg
The program is operated via call parameters.
►Make sure that CANBcfg.exe is installed locally with writing permission.
►Open Windows Start menu and start the command line.
►Go to the directory where CANBcfg.exe is stored.
►Start CANBcfg.exe.
→ List of parameters is shown.
Fig. 4 List of parameters in CANBcfg
►Define the COM port in use with Windows device manager.
If a USB serial adapter is used, the COM port in use can be changed by plugging in and off
the adapter or rebooting the computer.
►Execute CANBcfg.exe with the required parameters.
Parameters
Parameter Description
-a <filename> Downloads the configuration file <filename>.
-c2 Uses COM port 2 instead of COM port 1 (default).
-i<Name> Uses COM port <Name> instead of COM port 1 (default) (e.g. —iCOM7 if COM port 7 in use).
-g Generates a configuration file template.
-y Forces automatic configuration download.
-v Shows the current Bridge configuration.
Example
Download the file template.cfg automatically to device via COM port 7:
CANBcfg —a template.cfg —iCOM7 —y
CANbridge User Manual 4.01.0120.20000 2.1 en-US

Configuration 12 (28)
6.2 Creating the Configuration
6.2.1 Creating a Template with Download Tool
►Start CANBcfg.exe (see Starting and Operating the Download Tool CANBcfg, p. 11).
►Enter parameter -g (CANBcfg —g).
→ File template.clg is created.
►Open the file template.clg with the text editor.
►Save the file under a different name to prevent overwriting when generating a new
template.
►Adjust the configuration settings in the template with the text editor.
►Make sure, that the frame format is always set.
In repeater mode both formats are received and transmitted, but the frame format must be defined.
►Terminate the last configuration line in the configuration file with Return. Otherwise the
instruction is not executed.
►Load the configuration on the device (see Load Configuration to Device, p. 17).
Template of Configuration File
[General]
ProductName = CANbridge ;! DO NOT CHANGE THIS LINE !
TemplateVersion = 01.01.00 ;! DO NOT CHANGE THIS LINE !
RepeaterFunctionality = yes ;yes, no
AutoBaudAttemptTimeout = no ;no, 1 ... 600 (in seconds)
CANBusOffRecovery = no ;no, 1 ... 60 (in seconds)
[User]
ConfigAlias = "Repeater + Auto Baud (no Tx)"
[CANBus1]
BaudRate = Auto ;Auto, 1000, ..., 20, 0x00/0x0)
FrameFormat = std ;std, ext
UseGatewayTable = no ;yes, no
[CANBus2]
BaudRate = Auto ; Auto, 1000, ..., 20, 0x00/0x0C
FrameFormat = std ; std, ext
UseGatewayTable = no ; yes, no
[CAN1GatewayTable]
0x0 = 0x0 ;normal id retransmission with the
0x1 = 0x1 ;same identifier on both sides
0x3 = 0x3 ;all possible entries are listed
0x4 = 0x4
…
[CAN2GatewayTable]
0x0 = 0x0 ;normal id retransmission with the
0x1 = 0x1 ;same identifier on both sides
0x3 = 0x3 ;all possible entries are listed
0x4 = 0x4
…
CANbridge User Manual 4.01.0120.20000 2.1 en-US

Configuration 13 (28)
6.2.2 Adjusting the General Settings [General]
The TemplateVersion shows the version number of the ASCII file structure, used for
compatibility check and must not be changed.
Repeater Mode
Parameter Description
RepeaterFunctionality = no Repeater Mode deactivated.
RepeaterFunctionality = yes Messages are transmitted unchanged.
Entries in FrameFormat and CANGatewayTable are
ignored.
Autobaud Timeout Detection
It is possible to set a timeout for the automatic baud rate detection. When a baud rate is
detected on one bus the timeout time starts. When this time expires and no baud rate is
detected on the second bus, the detected baud rate is adopted to the second bus. Transmitting
is attempted. If an error occurs during transmission, the device is switched off.
The parameter is only relevant if automatic baud rate detection is set for at least one CAN bus.
Parameter Description
AutoBaudAttemptTimeout = no Default configuration, no timeout is set, device remains in
automatic baud rate detection until baud rate is detected
on both busses.
AutoBaudAttemptTimeout = <value in
seconds>
Value: maximally 600 seconds
Bus Off Recovery
Defines the behavior of the CANbridge when a CAN bus goes into bus off state. With a restart
CAN message buffers of both CAN busses are cleared.
Parameter Description
CANBusOffRecovery = no Bus stays in bus off, until device is switched off.
CANBusOffRecovery = <value in seconds> Device is restarted after specified time is expired.
Value: 1 to 60 seconds
6.2.3 Adjusting the User Settings [User]
Sets the name of the configuration, stored in device. Can be read with download tool.
Parameter Description
ConfigAlias = <name> Character chain of up to 31 characters
Default value: “Repeater + Auto Baud (No Tx)”
CANbridge User Manual 4.01.0120.20000 2.1 en-US

Configuration 14 (28)
6.2.4 Adjusting the CAN Bus Settings [CANBus1],[CANBus2]
Settings can be adjusted for CAN 1 and CAN 2 separately.
Baud Rate
Parameter Description
BaudRate = Auto Automatic baud rate detection activated, for more
information see Automatic Baud Rate Detection, p. 14)
BaudRate = <CiA baud-rate> Set predefined CiA baud rate. The following values (in
kBit/s) are possible: 20, 50, 100, 125, 250, 800, 1000
BaudRate = <BTR0/BTR1> Set baud rate via bus timing register, for more information
see Setting of Bus Timing Register, p. 14
Automatic Baud Rate Detection
Automatic baud rate detection is exclusively possible if at least two nodes per bus are
active.
Possible Baud Rates
Baud rate (CiA) BTR0 (hex) BTR1 (hex)
1000 kBit/s 0x00 0x14
800 kBit/s 0x00 0x16
500 kBit/s 0x00 0x1C
250 kBit/s 0x01 0x1C
125 kBit/s 0x03 0x1C
100 kBit/s 0x04 0x1C
50 kBit/s 0x09 0x1C
20 kBit/s 0x18 0x1C
It is possible to set a timeout for the automatic baud rate detection (see Autobaud Timeout
Detection, p. 13). For information about automatic baud rate detection sequence indicated by
LEDs see Automatic Baud Rate Detection Sequence, p. 20.
Setting of Bus Timing Register
HMS Industrial Networks recommends using the predefined standard baud rates. If user defined baud
rates are used, make sure that the entered values are valid.
If the baud rate is set with the bit timing register BTR0 and BTR1 of the controller, baud rates
that are not defined by CiA can be used.
Values for the bit timing register BTR0 and BTR1 are determined according to the specifications
for the CAN controller SJA 1000 with 16 MHz clock frequency (for more information see
datasheet of SJA 1000).
Example
For 200 kBit/s:
BaudRate = 0x04/0x14
CANbridge User Manual 4.01.0120.20000 2.1 en-US

Configuration 15 (28)
Frame Format
Parameter Description
FrameFormat = std Standard (11 bit identifier)
FrameFormat = ext Extended (29 bit identifier)
Mapping Table
Parameter Description
UseGatewayTable = yes Mapping tables of [CAN1GatewayTable] resp.
[CAN2GatewayTable] are used.
UseGatewayTable = no Mapping tables are not used, all messages are transmitted
unchanged.
6.2.5 Setting Mapping Tables [CAN1GatewayTable],[CAN2GatewayTable]
For each CAN bus a different mapping table is available. The CAN 1 and CAN 2 mapping tables
define if a message is forwarded or filtered out. If a message is forwarded the identifier can be
changed. The data of the message remains unchanged.
0x0 = 0x0
0x100 = 0x200
►Enter the identifier of the message to be received on the left.
►Enter the identifiers to be used when transmitting to the other CAN bus on the right.
Identifiers that are not listed or do not have an entry on the left are not forwarded.
Make sure that repeater mode is off (RepeaterFunctionality = no) and mapping
tables are enabled for CAN 1 and CAN 2 (UseGatewayTable = yes).
Data is interpreted differently depending on the setting of the frame format.
If both CAN busses are set to frame format standard:
• 11 bit identifiers left and right
• 2048 entries possible
If frame format standard is translated in extended:
• 11 bit identifiers on the left
• 29 bit identifiers on the right
• 2048 entries possible
If both CAN busses are set to frame format extended:
• 29 bit identifiers left and right
• 128 entries possible
CANbridge User Manual 4.01.0120.20000 2.1 en-US

Configuration 16 (28)
If frame format extended is translated in standard:
• 29 bit identifiers on the left
• 11 bit identifiers on the right
• 128 entries possible
All possible identifiers are listed in the template, mapped 1 to 1:
►If configuration with only 128 possible entries is used, delete surplus entries.
Example
• Standard frames set for CAN 1.
• Extended frames set for CAN 2.
[CAN1GatewayTable]
0x0=0x0 ; These messages are forwarded to the
0x1=0x1 ; other segment (CAN2) with the
0x2=0x2 ; same identifiers
…
0x100=0x200 ; These messages are forwarded to CAN2
0x101=0x1005abc ; with the identifiers given
0x102=0x202 ; on the right side
…
0x7fa= ; The identifiers that are not listed
0x7fb=no ; or that do not have a
0x7fc= ; numerical value on the right side
0x7fd= ; are not forwarded to CAN2
CANbridge User Manual 4.01.0120.20000 2.1 en-US

Configuration 17 (28)
6.3 Load Configuration to Device
►Connect the serial interface RS232 of the CANbridge and the serial interface of the
computer with a null modem cable.
►Call CANBcfg.exe with parameter —a <filename> —i<name> (e.g. CANBcfg —a
myconfig.cfg —iCOM7).
→ Program starts.
►To confirm the question to carry out the download, press key y.
→ Download is started via specified serial interface.
or
►To automate the download add parameter —y when calling CANBcfg.exe (e.g CANbcfg —a
myconfig.cfg –iCOM7 —y).
→ Configuration is directly downloaded to the CANbridge.
Fig. 5 Load configuration to device
CANbridge User Manual 4.01.0120.20000 2.1 en-US

Configuration 18 (28)
6.4 Show Current Configuration
►To read the current configuration, add parameter —v (e.g CANbcfg —v).
→ File and configuration name are displayed.
Fig. 6 Show configuration
6.5 Standard Configuration
Standard configuration of CANbridge:
• automatic baud rate detection activated
• repeater mode activated
• both frame formats (standard and extended) are processed simultaneously
[General]
TemplateVersion = 01.01.00 ;!Do not change this!
RepeaterFunctionality = yes
AutoBaudAttemptTimeout = no
CANBusOffRecovery = no
[USER]
ConfigAlias = “CAN-Bridge AutoBaud Repeater”
[CANBus1]
BaudRate = Auto
FrameFormat = std ;FrameFormat is ignored
UseGatewayTable = no ;UseGatewayTable is ignored
[CANBus2]
BaudRate = Auto
FrameFormat = ext ;Frameformat is ignored
UseGatewayTable = no ;UseGatewayTable is ignored
[CAN1GatewayTable] ;Gatewaytable is ignored
[CAN2GatewayTable] ;Gatewaytable is ignored
CANbridge User Manual 4.01.0120.20000 2.1 en-US