HMS AnyBus-X J1939 User manual

HALMSTAD • CHICAGO • KARLSRUHE • TOKYO • BEIJING • MILANO • MULHOUSE • COVENTRY • PUNE • COPENHAGEN
HMS Industrial Networks
Mailing address: Box 4126, 300 04 Halmstad, Sweden
Visiting address: Stationsgatan 37, Halmstad, Sweden
Connecting DevicesTM
E-mail: [email protected]
www.hms-networks.com
Anybus X-gateway
Ethernet to J1939 Gateway
User Manual
Part No.AB7665
For Firmware Revision 2.07.01 and Later
Manual Revision 1.20
Doc: HMSI-168-27

Table of Contents i
© 2014 HMS Industrial Networks AB Doc: HMSI-168-27
Table of Contents
Preface......................................................................... iv
Important User Information ................................... iv
Related Documentation........................................... v
Support.................................................................... v
................................................................................ v
Anybus X-gateway Module Description ................ 1-1
Overview .................................................................... 1-1
Theory of Operation ................................................... 1-2
J1939 Features .......................................................... 1-3
Ethernet Features ...................................................... 1-3
IT-Features................................................................. 1-4
System Requirements ................................................ 1-5
Hardware Description................................................. 1-6
Installation................................................................ 2-1
Installation and Operation Requirements ................... 2-1
Power and Network Connections ............................... 2-2
Connecting Power...................................................... 2-3
Connecting J1939 ...................................................... 2-4
Connecting to Ethernet .............................................. 2-5
Configuration Port Connector..................................... 2-5
Configuration ........................................................... 3-1
Anybus X-gateway Configuration Tool (BWConfig) ... 3-1
Ethernet Network Configuration ................................. 3-6
J1939 Network Configuration................................... 3-15
J1939 I/O Configuration ........................................... 3-18
Example Application ............................................... 4-1
Scenario #1 - EtherNet/IP .......................................... 4-1
Ethernet Network Configuration ................................. 4-2
J1939 Network Configuration..................................... 4-2
J1939 I/O Configuration ............................................. 4-3
Scenario #2 - Modbus/TCP ........................................ 4-6

Table of Contents ii
© 2014 HMS Industrial Networks AB Doc: HMSI-168-27
Ethernet Network Configuration ................................. 4-7
J1939 Network Configuration..................................... 4-7
J1939 I/O Configuration ............................................. 4-8
EtherNet/IP Interface .............................................. 5-1
Product Features........................................................ 5-1
CIP Objects ................................................................ 5-1
CIP Messaging ........................................................... 5-2
I/O Messaging ............................................................ 5-3
Assembly Objects and Connections........................... 5-4
I/O Data Summary ..................................................... 5-9
Using ControlLogix with the Gateway ...................... 5-11
Modbus/TCP Interface............................................ 6-1
Supported Commands ............................................... 6-1
Supported Exception Codes ...................................... 6-2
Modbus/TCP Addressing ........................................... 6-3
I/O Data Content ........................................................ 6-5
I/O Data Summary ................................................... 6-10
I/O Data Format ....................................................... 6-12
J1939 Interface......................................................... 7-1
Address Management ................................................ 7-1
Communications Methods.......................................... 7-2
Message Transmission .............................................. 7-3
Receiving Messages .................................................. 7-6
Transport Protocol for Large Messages ..................... 7-8
J1939 Diagnostic Messages ...................................... 7-9
Bus-Off Reset Option ............................................... 7-13
Offline Detection....................................................... 7-14
J1939 Baud Rate ..................................................... 7-17
File System................................................................ 8-1
File System Conventions............................................ 8-1
Security ...................................................................... 8-2
Structure..................................................................... 8-4
Default Files ............................................................... 8-5
Virtual File System ..................................................... 8-6

Table of Contents iii
© 2014 HMS Industrial Networks AB Doc: HMSI-168-27
System Files............................................................... 8-6
Configuration Files ..................................................... 8-7
Password Files......................................................... 8-11
Other Files................................................................ 8-13
Anybus X-gateway Web Page Files ......................... 8-17
IT Functionality ....................................................... 9-1
Default User Accounts ............................................... 9-1
The FTP Server.......................................................... 9-2
The Telnet Server ...................................................... 9-2
HTTP Server .............................................................. 9-8
SSI Functionality ........................................................ 9-9
Email Client .............................................................. 9-25
Displaying I/O Data on a Web Page......................... 9-26
Status and Diagnostics........................................... 10-1
Anybus X-gateway LEDs ......................................... 10-1
J1939 Status Codes................................................. 10-4
Diagnostic Web Pages............................................. 10-5
Status Assembly ...................................................... 10-5
Specifications.......................................................... 11-1
Environmental Specifications ................................... 11-1
EMC Directive Compliance ...................................... 11-1
Electrical Specifications............................................ 11-1
Mechanical Specifications ........................................ 11-2
I/O Data Sizes .......................................................... 11-3
J1939 Specifications ................................................ 11-3
Connectors.............................................................. 12-1
Power ....................................................................... 12-1
J1939 ....................................................................... 12-2
Ethernet RJ45 .......................................................... 12-3
Configuration RS-232 9 Pin D-Subminiature............ 12-4

Preface iv
© 2014 HMS Industrial Networks AB Doc: HMSI-168-27
Preface
Important User Information
The data and illustrations found in this document are not binding. We reserve the
right to modify our products in line with our policy of product development. The
information in this document is subject to change and should not be considered as
a commitment by HMS Industrial Networks. HMS Industrial Networks assumes
no responsibility for errors that may appear in this document
There are many applications of the Anybus X-gateway module. Those responsible
for the use of this device must satisfy themselves that all necessary steps have
been taken to verify an application meets all performance and safety requirements
including any applicable laws, regulations, codes, and standards.
The illustrations and samples in this guide are intended solely for the purpose of
example. HMS Industrial Networks does not assume responsibility or liability for
actual use based upon the examples shown in this publication.
FAIL-SAFE OR CRITICAL OPERATIONS
This product is not designed, intended, authorized, or warranted
to be suitable for use or resale as control equipment in, or for
other applications related to, hazardous or potentially-hazardous
environments or applications requiring high-availability or fail-
safe performance, such as in the operation of nuclear facilities,
aircraft navigation or communications systems, air traffic con-
trol, life support, public works, weapons systems, or any other
application in which the failure of a product could lead to prop-
erty damage, death, personal injury, or environmental damage.

Preface v
© 2014 HMS Industrial Networks AB Doc: HMSI-168-27
Related Documentation
Modbus/TCP is a trademark of Modbus.org.
EtherNet/IP is a trademark of ODVA.
Microsoft, MS-DOS, and Windows are trademarks of Microsoft Corporation.
Support
For technical support, FAQ:s etc, please see www.anybus.com
Document Name Author Web Page
EtherNet/IP Specification ODVA www.odva.org
Common Industrial Protocol (CIP) Specification ODVA www.odva.org
Modbus Application Protocol Specification Modbus-IDA www.modbus.org
Modbus Messaging on TCP/IP Implementation
Guide
Modbus-IDA www.modbus.org
J1939 Recommended Practice SAE www.sae.org
Table 1-1 Related Documentation

Chapter 1 Anybus X-gateway Module Description 1-1
© 2014 HMS Industrial Networks AB Doc: HMSI-168-27
Anybus X-gateway Module Description
Overview
The Anybus Ethernet to J1939 X-gateway allows you to monitor and control data
on a J1939 heavy duty vehicle network from an Ethernet device. Data from J1939
messages are mapped to I/O table locations, making them accessible to the Ether-
net network. The EtherNet/IP and Modbus/TCP protocols are supported. The X-
gateway acts as an EtherNet/IP Adapter, allowing J1939 data to be transferred to
an EtherNet/IP Scanner device using I/O or explicit messages. The module acts
as a Modbus/TCP server, allowing J1939 data to be addressed as Modbus registers
by a Modbus/TCP client device.
Examples of applications of the Ethernet to J1939 X-gateway:
• An interface used on a diesel generator package to access engine parame-
ters from a Programmable Logic Controller (PLC).
• An on-vehicle gateway used to interface the J1939 vehicle network to an
on board industrial automation based control system.

Anybus X-gateway Module Description 1-2
© 2014 HMS Industrial Networks AB Doc: HMSI-168-27
Theory of Operation
The Anybus X-gateway provides centralized data storage, the “PassageWayTM”,
for data that is shared between the J1939 and Ethernet networks. Data is placed
into the PassageWay by one network interface, allowing the data to be read
through the other network interface.
The X-gateway appears as a single device on either network using standard proto-
col mechanisms. No special, or extended, protocol features are required of the
devices on either network to read and write the data flowing through the Passage-
Way; all cross-network activity is transparent to the devices on either network.
Figure 1-1 Anybus X-gateway PassageWay Operation
Ethernet Network
J1939 Network
PassageWay
Input
Table
Output
Table
Receive PGNs
Send PGNs
Read Inputs
Write Outputs

Anybus X-gateway Module Description 1-3
© 2014 HMS Industrial Networks AB Doc: HMSI-168-27
J1939 Features
• Transmission and reception of all types of fixed-length J1939 messages,
including PDU1, PDU2, broadcast and destination specific.
• Monitoring of DM1 (active diagnostics) and DM2 (previously active
diagnostics) messages.
• Complete network address management including address claim, protec-
tion, and yield on higher priority conflict.
• Network address can be self-configurable over a range of addresses.
• J1939 Transport Protocol for transmission and reception of large mes-
sages (9 - 1785 bytes). Both connection based (RTS/CTS) and broadcast
(BAM) are supported.
• Configurable CAN bus-off reset option will reset the network interface
and attempt to return to online when a CAN bus-off condition is detected.
Ethernet Features
• Supports the EtherNet/IP protocol, Adapter Class with I/O Server, and
Message Server.
• Supports the Modbus/TCP protocol with up to 8 simultaneous connec-
tions. Conforms to the Modbus/TCP specification 1.0.
• IP address configuration may be done using DHCP/Bootp, web page, or
the Anybus X-gateway Configuration Tool.

Anybus X-gateway Module Description 1-4
© 2014 HMS Industrial Networks AB Doc: HMSI-168-27
IT-Features
• The X-gateway features a flexible file system with two security lev-
els.The size available for user files is approximately 1.4 MB.
• An FTP server provides easy file management using standard FTP clients.
• A Telnet server featuring a command line interface similar to the
MSDOS™ environment.
• A a flexible HTTP server (Web server) with Server Side Includes (SSI)
functionality. These are commands to the web server embedded in the
• HTML code. This enables the user to access the IN/OUT area using a cus-
tomizeable web page interface.
• Firmware updates of the X-gateway using the RS232 port and Anybus X-
gateway Configuration Tool.
• Email client capability.

Anybus X-gateway Module Description 1-5
© 2014 HMS Industrial Networks AB Doc: HMSI-168-27
System Requirements
The following hardware and software components are needed to use the Anybus
Ethernet to J1939 X-gateway.
Required Hardware
• Anybus X-gateway module.
• J1939 network connection.
• Ethernet cabling.
• PC or controller with access to the Ethernet network.
• 24 VDC power connection
• PC with an RS-232 communications port or USB serial adapter to execute
Anybus X-gateway Configuration Tool (BWConfig).
• RS-232 null-modem cable to connect PC running BWConfig to the Any-
bus X-gateway.
Optional Hardware
• DIN rail to mount the X-gateway.
Required Software
• Anybus X-gateway Configuration Tool software (BWConfig) to config-
ure the Anybus X-gateway.
• BWConfig requires that the PC be running Microsoft Windows 98, NT,
2000, or XP.

Anybus X-gateway Module Description 1-6
© 2014 HMS Industrial Networks AB Doc: HMSI-168-27
Hardware Description
All connections, whether power or fieldbus, to the X-gateway are made on one
end of the module. Phoenix-style connectors are provided for power and J1939
connections. An RJ-style connector is provided for Ethernet connection. There is
a 9-pin D-Subminiature connector for the auxiliary RS-232 port that is used for
device configuration. See “Installation” Page 2-1 for more details on the connec-
tors.
There is an 8 position DIP switch on the end of the module that can be used to
select a portion of a default IP address that may be used to permit an intranet con-
nection. See “Ethernet Network Configuration” Page 3-6 for more details on con-
figuring the IP address using the switches.
On the front of the X-gateway module are 6 LEDs that are used for status indica-
tion. These LEDs provide visual status for the overall module, the J1939 interface,
and the Ethernet interface. See “Anybus X-gateway LEDs” Page 10-1 for details
on how the LEDs are used.
The back of the module has a DIN rail mount to allow the module to be mounted
on a DIN rail.

Chapter 2 Installation 2-1
© 2014 HMS Industrial Networks AB Doc: HMSI-168-27
Installation
Installation and Operation Requirements
•Power, input and output (I/O) wiring must be in accordance with Class 1, Divi-
sion 2 wiring methods - article 501-4(b) of the National Electric Code,
NFPA 70 and in accordance with local codes.
•Warning - Explosion Hazard - Substitution of components may impair suitabil-
ity for Class 1, Division 2.
•Warning - Explosion Hazard - When in hazardous locations turn off power
before replacing or wiring modules.
•Warning - Explosion Hazard - Do not disconnect equipment unless power has
been switched off or the area is known to be nonhazardous.
•Terminal tightening torque must be between 5-7 lbs-in (0.5-0.8 Nm).
•For use in Class 2 circuits only.
•Suitable for surrounding temperature of 65 degrees C maximum.
•Use 60/75 C copper wire only.

Installation 2-2
© 2014 HMS Industrial Networks AB Doc: HMSI-168-27
Power and Network Connections
The power and network connections to the X-gateway are made on the end of the
module. Figure 2-1 indicates the location of each connector.
Figure 2-1 Anybus X-gateway Power and Network Connections
J1939 Power Configuration
Ethernet
Ethernet IP Address

Installation 2-3
© 2014 HMS Industrial Networks AB Doc: HMSI-168-27
Connecting Power
The power connection is a 2-pin terminal block located on the end of the module.
The female terminal block connector is provided with the X-Gateway. Connec-
tions to be made are illustrated in Figure 2-2.
The X-gateway requires 24 volts DC power. The module will start immediately
when power is applied (There is no On/Off switch on the module).
Figure 2-2 Power Connection
24VDC Common
24 VDC +

Installation 2-4
© 2014 HMS Industrial Networks AB Doc: HMSI-168-27
Connecting J1939
The J1939 network connection is a 5-pin terminal block located next to the power
connection on the end of the module. The female terminal block connector is pro-
vided with the X-gateway. Connections to be made are illustrated in Figure 2-3.
The CAN High and Low signal lines should be connected to the CAN High and
Low connections respectively on all devices on the network. The signal lines
should not be swapped on any device connections.
Note: The 24VDC terminals on pins 1 and 5 are physically connected to the
power on the 2-pin power connector. The module may alternatively be powered
from these pins.
Figure 2-3 J1939 Connection
24VDC +
24VDC Common
J1939 CAN High
J1939 CAN Low
J1939 CAN Shield

Installation 2-5
© 2014 HMS Industrial Networks AB Doc: HMSI-168-27
Connecting to Ethernet
The Ethernet connection uses a standard RJ45 connector (not provided). This is
plugged into the socket on the end of the module.
Configuration Port Connector
The configuration port is the 9-pin D-Subminiature female connector on the end
of the X-gateway. The connector has a standard RS-232 DTE pin configuration.
The connections to be made as shown below.
The X-gateway is connected to a PC for configuration using a null-modem cable
and a 9 pole dsub gender-shifter (male-male). A null-modem cable has pins 2 and
3 swapped so that the PC’s Transmit line is connected to the X-gateway’s Receive
line, and the PC’s Receive line is connected to the X-gateway’s Transmit line.
Note: The Anybus X-gateway does not make use of the modem control signals
specified for a DTE connector. Connecting the module through devices, such as
isolation modules, which assume control of these lines may cause the BWConfig
communications to be unreliable.
Pin Connection
2 Receive Data
3 Transmit Data
5 Signal Ground

Chapter 3 Configuration 3-1
© 2014 HMS Industrial Networks AB Doc: HMSI-168-27
Configuration
This chapter describes how the Anybus Ethernet to J1939 X-gateway is config-
ured using the Anybus X-gateway Configuration Tool (BWConfig). Detailed
descriptions of each configurable parameter in the gateway are provided as well as
how they are set in the tool.
The next chapter walks the reader through the configuration of an example appli-
cation to illustrate how the configurable parameters are used in a real-world appli-
cation.
Anybus X-gateway Configuration Tool (BWConfig)
The Anybus X-gateway Configuration Tool allows you to configure the parame-
ters associated with the Ethernet and J1939 network interfaces as well as to set up
the contents and layout of the I/O table.
BWConfig is a Microsoft Windows application that communicates with a X-gate-
way over a standard RS-232 serial link using the PC serial port or USB serial
adapter. BWConfig is compatible with Microsoft Windows 98, NT, 2000, and XP.
Installing the Tool
Install BWConfig from the CD by running Setup.exe which is found in the CD's
root directory.
If you have downloaded BWConfig from the web site, unzip the downloaded file
into a temporary directory and run Setup.exe which is found in the temporary
directory.

Configuration 3-2
© 2014 HMS Industrial Networks AB Doc: HMSI-168-27
Connecting to the X-gateway Module
Connect the PC running BWConfig to the X-gateway module using a standard
Null-Modem (pins 2 and 3 swapped) serial cable between the PC serial port or
USB adapter and the 9-pin D-Sub connector on the module. It does not matter
which PC serial port you use, BWConfig will scan each available port and detect
the connection automatically. No serial port configuration is required; BWConfig
will automatically set the baud rate.
Starting the Tool
Launch BWConfig from the Anybus X-gateway Configuration folder in the Win-
dows Start Menu.
When BWConfig is started, it will attempt to locate a X-gateway module on one
of the PC serial ports. If a module is found, the status area of the tool will be
updated to show the module type and status of the module that was located.
If a module is not connected to the PC, or is powered off, when the tool is started,
the status area will indicate that no module was detected. Make sure that the mod-
ule is powered and the connection is made, then press the Refresh button on the
BWConfig tool bar; this will cause the tool to rescan the serial ports for a module.

Configuration 3-3
© 2014 HMS Industrial Networks AB Doc: HMSI-168-27
BWConfig User Interface
The Anybus X-gateway Configuration Tool’s user interface is shown below.
Figure 3-1 BWConfig User Interface