X2E OABR2CAN User manual
OABR2CAN
Media Gateway
User Manual
Version: 1.8 / November 2019
© 2019 X2E GmbH
This user manual is protected by copyright; all usual rights reserved. Reproduction of this user manual, even in
part, is only permitted with the approval of X2E GmbH. Any infringement will result in liability for damages and
may result in criminal prosecution.
All product names and brands used in this user manual are the property of their respective owners.
User Manual OABR2CAN
3
Table of contents
Introduction.............................................................................................4
Intended use............................................................................................4
Delivery contents .....................................................................................4
General safety instructions......................................................................5
Product overview.....................................................................................6
Identification.............................................................................................6
Connections and controls ........................................................................6
Installation...............................................................................................9
Mounting..................................................................................................9
Connecting...............................................................................................9
Gateway configuration ..........................................................................11
Install XORAYASuite................................................................................12
Start Gateway configuration ..................................................................13
Buttons...................................................................................................14
Gateway-Settings...................................................................................15
Create and save configuration...............................................................15
Connect to gateway...............................................................................16
Transfer configuration............................................................................17
Update firmware.....................................................................................17
Disconnect gateway...............................................................................17
Cleaning................................................................................................18
Repair...................................................................................................18
Disposal................................................................................................18
Appendix...............................................................................................19
Technical specifications.........................................................................19
Message structure .................................................................................19
Pin assignments of the connection cable ..............................................20
User Manual OABR2CAN
4
Introduction
Intended use
OABR2CAN is an automotive media gateway between one OPEN Alliance BroadR-Reach®
(OABR) interface and two high-speed CAN interfaces. A configurable routing table stores the
information of how the data is transferred between the interfaces.
You may only operate the gateway within the scope of the technical specifications provided
in this user manual. Additionally, the use in hazardous areas is not allowed.
The gateway meets the requirements of the EMC Directive of the European Union if the con-
necting cable supplied is used. The interface connection lines may be extended up to a maxi-
mum of 30 m, the voltage supply line, with sufficient cross section, up to 3 m.
You can find the declaration of conformity at the end of this user manual. Exact names of the
compliant product variants are available on request.
Delivery contents
OABR2CAN Media Gateway
connection cable (optional)
user manual
XORAYASuite
USB driver
Check to ensure that the delivery is complete and all hardware components are in sound
condition. If the delivery is incomplete or supplied components are damaged, contact X2E
immediately. Do not use damaged components.
User Manual OABR2CAN
5
General safety instructions
The OABR2CAN Media Gateway is only intended for use by qualified personnel. Read the
user manual and especially this chapter thoroughly before operating.
CAUTION
Electric shock due to damaged components
Damages to the gateway or the connection cable can result in electric
shock.
Check all components regularly for damages.
Only connect the gateway if all components are undamaged.
CAUTION
Device damage due to vibrations, dirt or liquids
Excessive vibrations, dirt or liquids may result in malfunction or destruction
of the gateway.
Avoid exposing the gateway to excessive vibrations, dirt or liquids.
Keep the gateway clean, especially plugs and sockets to ensure a
reliable contact.
Never open the gateway.
CAUTION
Device damage due to electrostatic discharge
Electronic components can be destroyed by electrostatic discharge.
Avoid touching connectors and connector pins.
Ground yourself before carrying the gateway in your hands.
Operate the gateway in an ESD-compliant environment.
User Manual OABR2CAN
6
Product overview
Identification
The identification plate is located on the bottom side of the OABR2CAN Media Gateway.
It contains information about:
Typ device type
Rev hardware revision
S/N serial number
DMF date of manufacture
This user manual applies to the OABR2CAN Media Gateway in hardware revision 1.01.
Connections and controls
The front side contains LEDs, the service interface and the combined connection for power,
OABR and CAN.
The control elements are located on the back side.
Front view
Back view
User Manual OABR2CAN
7
Activity LED for OABR (A)
Colour Meaning
green interface ready
green (blinking) data transmission on this interface
yellow USB bootloader mode
Connection for power, OABR and CAN (B)
Pin Function
1 CAN_1_H
2 CAN_1_L
3 CAN_2_H
4 CAN_2_L
5 KL30(Ubatt)
6 KL31(GND)
7 OABR_N
8 OABR_P
Service interface (C)
Use the Micro USB interface to change the configuration or to update the firmware. For fur-
ther information, refer to the chapter Gateway configuration.
The pin assignments conform to the USB standard.
General status LED (D)
Colour Meaning
blue gateway in initialisation phase
green gateway ready
red error
User Manual OABR2CAN
8
LED for CAN (E)
Colour Meaning
blue at least one CAN interface in initialisation phase
green at least one CAN interface ready
red (blinking) data transmission on at least one CAN interface
Link LED for OABR (F)
Colour Meaning
red connection established
yellow USB bootloader mode
DIP switches (G)
No Function
1 switch the OABR interface between master (up) or
slave (down)
2 switch the OABR interface between full-out (up) and
half-out (down)
3 activate (up) or deactivate (down) sleep/wake mode via
CAN
Reset button (H)
This button is used to:
restart the gateway
switch the gateway into USB bootloader mode (further information in the chapter Con-
nect to gateway)
User Manual OABR2CAN
9
Installation
Mounting
CAUTION
Device damage due to overheating
Overheating may result in malfunction or destruction of the gateway.
Do not operate the gateway outside the specified temperature range.
Do not operate the gateway in the vicinity of heat sources.
Ensure adequate air circulation.
Do not cover the gateway with other objects.
Mount the gateway in such a way that it does not pose a hazard at any time.
Connecting
DANGER
Electric shock due to improper connection
Introducing the 4-mm plugs of the supplied connection cable into low-volt-
age sockets can be fatal.
Never introduce the 4-mm plug into low-voltage sockets.
CAUTION
Device damage due to wrong power supply
A wrong power supply can result in damage or destruction of the gateway.
Only connect the gateway to power supplies that correspond to the
technical specifications.
Pay attention to the correct polarity when connecting.
Disconnect service interface during standard operating mode
Make sure that the service interface (C) is disconnected in standard operat-
ing mode. Pull the plug if necessary and connect it again before changing
the configuration or updating the firmware.
User Manual OABR2CAN
10
The following instructions refer to the connection cable provided by X2E. If you use other ca-
bles, connect accordingly.
Plug the connection cable into the socket (B).
Connect the cable labelled OABR to an OABR device.
Connect one or both cables labelled CAN1 and CAN2 to CAN busses.
Requirements for the DC power supply
The DC power supply must provide a continuous current of 120 mA. Use a
regulated power supply or the vehicle battery and pay attention to the re-
quired voltage and current levels.
Connect the black cable labelled KL31(GND) to 0 V or ground.
Connect the red cable labelled KL30(Ubatt) to a DC power supply in the specified
range.
Ensure that all connectors are firmly attached.
Turn on the power supply.
The gateway indicates its readiness by green illumination of the general status LED (D). As
soon as data is received at the OABR interface or the CAN interfaces, the data is converted
and sent according to the routing table configuration.
Energy management
The OABR2CAN Media Gateway features an intelligent energy manage-
ment that reduces the current consumption depending on the connected
CAN busses.
To activate the sleep/wake mode, DIP switch (G) No 3 needs to be ON
(= top position).
If there is no activity on the CAN busses within a configurable number of
seconds (see chapter Gateway-Settings), the gateway switches into sleep
mode. If there is activity again, it wakes up back to standard operating
mode.
User Manual OABR2CAN
11
Gateway configuration
With the tool Gateway configuration, part of X2E's XORAYASuite, you change the configura-
tion and update the firmware. The XORAYASuite is a collection of programs to configure and
control XORAYA dataloggers and additional devices like the OABR2CAN Media Gateway.
Supported operating systems:
Microsoft® Windows® 7 (32 Bit or 64 Bit)
Microsoft® Windows® 8 (32 Bit or 64 Bit)
Microsoft® Windows® 10 (32 Bit or 64 Bit)
Hardware requirements:
Processor speed: at least 1 GHz
RAM: at least 2 GB
Hard disk space: approx. 130 MB available
Software requirements:
Microsoft® .NET Framework Version 4.5 or higher
User Manual OABR2CAN
12
The OABR2CAN Media Gateway supports three modes depending on the routing direction:
OABR to CAN
CAN to OABR
CAN to CAN
These modes are set by configuring the receiving and sending interfaces in Gateway config-
uration. Can 1, Can 2, Ethernet 1 and Ethernet 2 are available.
Can 1 and Can 2 represent both physical CAN interfaces. Ethernet 1 and Ethernet 2 are logi-
cal partitions of the physical OABR interface. The partitioning is realised with UDP ports
(30501 and 30502 by default). For the routing from OABR to CAN or vice versa, each CAN
interface is assigned to a UDP port.
Example:
Can 1
Ethernet 1: UDP port 30501
Can 2
Ethernet 2: UDP port 30502
CAN messages are tunnelled as UDP packets through the SOME/IP protocol. For further in-
formation on SOME/IP, refer to the chapter Message structure.
Install XORAYASuite
Start the XORAYASuite installation wizard and follow the instructions.
Make sure that the component Gateway configuration is installed.
User Manual OABR2CAN
13
Start Gateway configuration
Start the XORAYASuite.
Click in the Windows notification area.
Select Extra tools > Gateway configuration.
User Manual OABR2CAN
14
Buttons
The following table displays a short overview of the toolbar buttons and the equivalent menu
commands. You find detailed step-by-step instructions on the subsequent pages.
Function Menu command
creates a new project Project
> New
loads an existing project (*.xgc) Project
> Load
saves the current project to your PC:
as a project file (*.xgc)
as a configuration file compatible with the
gateway (*.cfg.hex)
as AUTOSAR XML files (*.arxml)
Project
> Save
closes the current project Project
> Close
creates a new interface mapping -
deletes the selected interface mapping -
connects to the gateway or disconnects an estab-
lished connection Hardware
> Connect
loads a firmware file (*.hex) that overwrites the
firmware of the connected gateway
deletes the configuration in the process
Hardware
> Flash Firmware
loads a configuration file (*.cfg.hex) that overwrites
the configuration of the connected gateway
the firmware remains unchanged
Hardware
> Flash CFG
saves the configuration file (*.cfg.hex) of the con-
nected gateway to the PC Hardware
> Get CFG
displays device information about the connected
gateway Hardware
> Info
jumps to the next occurrence of the search term -
jumps to the previous occurrence of the search
term -
sorts the message list alphabetically -
sorts the message list by CAN-ID -
User Manual OABR2CAN
15
Gateway-Settings
Gateway-Settings are general settings that apply to all interface mappings of the current pro-
ject.
Setting Function
IP IPv4 address of the gateway
SubNet IPv4 subnet address of the gateway
Gateway IPv4 gateway address of the gateway
Multicast IPv4 address of the multicast group the gateway should
join
Variant freely selectable letter to label the current configuration
Sleep timeout number of seconds without CAN activity that puts the
gateway into sleep mode
requirement: DIP switch No 3 is ON (= top position)
Create and save configuration
Click to create a new project.
Configure the general Gateway-Settings (see chapter Gateway-Settings).
Click to create a new interface mapping.
Under Receive - RX, select the receiving Interface.
Load a DatabaseFile (DBC, AUTOSAR or FIBEX) that contains definitions of the
messages to route.
Depending on the selected receiving interface, specify the Baudrate or the Port.
Under Send - TX, select the sending Interface.
Depending on the selected sending interface, specify the Baudrate, the Port or op-
tionally a VLan ID.
Click OK.
The interface mapping is added to the table. In the lower-left part of the window, the mes-
sages from the DBC, AUTOSAR or FIBEX file are listed.
User Manual OABR2CAN
16
Select a message and click to add this message to the routing table.
Repeat this step for up to 255 further messages if required.
or
Click somewhere in the message list, then and Yes to route all messages of the
interface unfiltered.
or
Click somewhere in the message list, then and No to add all messages from the
list (max. 256).
The number of routed messages is displayed in the table column Info.
Target IP
If the sending interface is OABR, so Ethernet 1 or Ethernet 2, then specify
the Target IP that can also be a multicast address. This setting is saved for
every message individually.
Click to create further interface mappings if required.
Click to save the configuration.
Navigate to the target directory and specify a File name.
Click Save.
Connect to gateway
Before you connect the gateway in the software, you must activate the USB bootloader
mode:
Make sure that the correct USB driver is installed.
Connect the gateway to the power supply (see chapter Connecting).
Turn on the power supply.
Connect the gateway via service interface (C) to your PC.
Press the reset button (H) with a pointed object.
The gateway indicates USB bootloader mode by yellow illumination of the LEDs (A) and (F).
Click to connect to the gateway.
An established connection is indicated by a blue border around the icon:
User Manual OABR2CAN
17
Transfer configuration
Establish a connection to the gateway (see chapter Connect to gateway).
Click to load a saved configuration.
Navigate to the directory that contains the configuration file and select the File name.
Click Open.
The gateway configuration is being overwritten.
Click to verify that the Configuration Version and the Configuration Variant
are as expected.
Update firmware
Establish a connection to the gateway (see chapter Connect to gateway).
Click to load the firmware.
Navigate to the directory that contains the firmware file and select the File name.
Click Open.
The gateway firmware is being updated.
Click to verify that the Firmware Version is as expected.
Firmware-Update deletes configuration
For that reason, you have to transfer a configuration again after the suc-
cessful firmware update.
Disconnect gateway
Click .
Disconnect properly
Always click the disconnect button before you exit Gateway configuration or
pull the USB cable. Otherwise the gateway stays in USB bootloader mode
and is not routing messages.
User Manual OABR2CAN
18
Cleaning
CAUTION
Device damage due to entering liquids
Entering liquids may result in malfunction or destruction of the gateway.
Disconnect the gateway from the power supply before cleaning.
Make sure that no liquids enter the gateway.
Clean the gateway with a damp, soft cloth as needed.
Repair
CAUTION
Device damage from opening the device
Unauthorised opening may result in malfunction or destruction of the gate-
way.
Never open the gateway.
Maintenance and repair must be carried out by X2E personnel only.
In case of malfunctions or damages, please contact X2E via e-mail to get information
Disposal
Within the European Union, the disposal of electrical devices is determined
by national rules that are based on the directive 2012/19/EU of the Euro-
pean Parliament and of the Council on waste electrical and electronic equip-
ment (WEEE). Accordingly, electrical and electronic equipment may not be
disposed of in household waste.
Outside the European Union, please contact your local authority so as to
comply with the correct method of disposal for electrical devices.
User Manual OABR2CAN
19
Appendix
Technical specifications
Dimensions (H x W x D) 21 mm x 56 mm x 104 mm
Supply voltage 5 V to 28 V
Current consumption max 120 mA (at 12 V)
Current consumption (standby) max 4 mA (at 12 V)
CAN interface baud rate 100, 125, 250, 500 or 1000 kbit/s
CAN interface termination 120 Ω
Temperature range -40 °C to +65 °C
Message structure
The OABR2CAN Media Gateway wraps up to three SOME/IP messages in one Ethernet
packet. For the tunnelling of CAN messages, the SOME/IP header is defined as follows:
The complete identifier is encoded in the field CAN-ID in LSB-first order. The 29th Bit (la-
belled with e) is an indicator for an Extended Identifier.
Examples:
Standard Identifier 0x3E
SOME/IP: 0x0000003E
Extended Identifier 0x6A
SOME/IP: 0x2000006A
Length refers to the area starting at bit position 64. If the SOME/IP message transports a
CAN-Payload of 8 Bytes, Length is 16 Bytes and the whole message is 24 Bytes long.
The fields Client ID and Session ID have to be filled with 0x0 when tunnelling with
SOME/IP, as defined by the specification.
Protocol Version is the SOME/IP version, currently 0x1.
Interface Version is currently 0x0.
Message Type is NOTIFICATION, so 0x2.
Return Code is OK, so 0x0.
User Manual OABR2CAN
20
Pin assignments of the connection cable
Pin Function
1 CAN_1_H
2 CAN_1_L
3 CAN_2_H
4 CAN_2_L
5 KL30(Ubatt)
6 KL31(GND)
7 OABR_N
8 OABR_P
Pin Function
2 CAN_1_L
7 CAN_1_H
CAN1
Pin Function
2 CAN_2_L
7 CAN_2_H
CAN2
Pin Function
2 OABR_N
7 OABR_P
OABR
Colour Function
red KL30(Ubatt)
black KL31(GND)
Ubatt/GND
Table of contents
