HMS Anybus X-gateway User manual

+$/067$'&+,&$*2.$5/658+(72.<2%(,-,1*0,/$1208/+286(&29(175<381(&23(1+$*(1
HMS Industrial Networks
Mailing address: Box 4126, 300 04 Halmstad, Sweden
Visiting address: Stationsgatan 37, Halmstad, Sweden
Connecting Devices
TM
E-mail: [email protected]
Web: www.anybus.com
Anybus X-gateway
J1939 to Modbus Interface
User Manual
Part No.AB7612
For Firmware Revision 2.06.01 and Later
Manual Revision 1.20
Doc.Id. HMSI-168-25

Table of Contents i
© 2012 HMS Industrial Networks AB Doc.Id. HMSI-168-25
Table of Contents
Preface......................................................................... iii
Important User Information ................................... iii
Related Documentation.......................................... iv
Anybus X-gateway Module Description ................ 1-1
Overview .................................................................... 1-1
Theory of Operation ................................................... 1-2
J1939 Features .......................................................... 1-3
Modbus Features ....................................................... 1-3
System Requirements ................................................ 1-4
Hardware Description................................................. 1-5
Installation................................................................ 2-1
Installation and Operation Requirements ................... 2-1
Power and Network Connector .................................. 2-2
Configuration Port Connector..................................... 2-4
Configuration ........................................................... 3-1
Anybus Configuration Tool (BWConfig) ..................... 3-1
Modbus Network Configuration .................................. 3-6
J1939 Network Configuration..................................... 3-7
J1939 I/O Configuration ........................................... 3-10
Modbus Interface..................................................... 4-1
Network Communication ............................................ 4-1
Supported Modbus Functions .................................... 4-2
Diagnostic Subfunctions............................................. 4-3
Modbus Addressing ................................................... 4-7
Diagnostic Registers .................................................. 4-9
Interaction with I/O Tables ....................................... 4-10
Example Application ............................................... 5-1
Scenario ..................................................................... 5-1
Modbus Network Configuration .................................. 5-2
J1939 Network Configuration..................................... 5-3
J1939 I/O Configuration ............................................. 5-4

Table of Contents ii
© 2012 HMS Industrial Networks AB Doc.Id. HMSI-168-25
J1939 Interface......................................................... 6-1
Address Management ................................................ 6-1
Communications Methods.......................................... 6-2
Message Transmission .............................................. 6-3
Receiving Messages .................................................. 6-6
Transport Protocol for Large Messages ..................... 6-8
J1939 Diagnostic Messages ...................................... 6-9
Bus-Off Reset Option ............................................... 6-13
Offline Detection....................................................... 6-14
J1939 Baud Rate ..................................................... 6-17
Status and Diagnostics............................................. 7-1
Anybus X-gateway LEDs ........................................... 7-1
Status Codes.............................................................. 7-3
Specifications............................................................ 8-1
Environmental Specifications ..................................... 8-1
EMC Directive Compliance ........................................ 8-1
Electrical Specifications.............................................. 8-1
Mechanical Specifications .......................................... 8-2
I/O Data Sizes ............................................................ 8-3
Modbus Specifications ............................................... 8-3
J1939 Specifications .................................................. 8-3
Connectors................................................................ 9-1
Power and Network 15-Pin D-Subminiature............... 9-1
Configuration 25-Pin D-Subminiature......................... 9-2
Support ................................................................... 10-1

Preface iii
© 2012 HMS Industrial Networks AB Doc.Id. HMSI-168-25
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 iv
© 2012 HMS Industrial Networks AB Doc.Id. HMSI-168-25
Related Documentation
Modbus is a trademark of Modbus.org.
Microsoft, MS-DOS, and Windows are trademarks of Microsoft Corporation.
Document Name Author Web Page
Modbus Protocol Specification 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
© 2012 HMS Industrial Networks AB Doc.Id. HMSI-168-25
Anybus X-gateway Module Description
Overview
The X-gateway J1939 to Modbus Interface (JMI) allows you to monitor and con-
trol data on a J1939 heavy duty vehicle network using a Modbus RTU master
device. Data from J1939 messages are mapped to I/O table locations, making
them addressable using standard Modbus read and write commands.
Examples of JMI applications:
• 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
© 2012 HMS Industrial Networks AB Doc.Id. HMSI-168-25
Theory of Operation
The JMI provides centralized data storage, the “PassageWayTM”, for data that is
shared between the J1939 and Modbus networks. Data is placed into the Passage-
Way by one network interface, allowing the data to be read through the other net-
work interface.
The JMI appears as a single device on either network using standard protocol
mechanisms. No special, or extended, protocol features are required of the devices
on either network to read and write the data flowing through the PassageWay; all
cross-network activity is transparent to the devices on either network.
Figure 1-1 JMI PassageWay Operation
Modbus RTU Network
J1939 Network
PassageWay
Input
Table
Output
Table
Receive PGNs
Send PGNs
Read Inputs
Write Outputs

Anybus X-gateway Module Description 1-3
© 2012 HMS Industrial Networks AB Doc.Id. HMSI-168-25
J1939 Features
• Transmission and reception of all types of J1939 messages, including
PDU1, PDU2, broadcast and destination specific.
• 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.
• Configurable diagnostic tables provide monitoring of J1939 diagnostic
messages for active and previously active diagnostics (DM1 and DM2).
Modbus Features
• Modbus RTU slave.
• RS-485 half-duplex (2 wire) serial interface.
• Configurable baud rates of 4800, 9600, and 19200 bps.
• Configurable for no, odd, or even parity and 1 or 2 stop bits.
• Support of all commonly used Modbus functions for reading and writing
I/O data and diagnostics.
• Overall module, Modbus, and J1939 status and diagnostics accessible
through Modbus diagnostic functions and addressable registers.

Anybus X-gateway Module Description 1-4
© 2012 HMS Industrial Networks AB Doc.Id. HMSI-168-25
System Requirements
The following hardware and software components are needed to use the X-gate-
way J1939 to Modbus Interface.
Required Hardware
• Anybus X-gateway JMI module.
• J1939 network connection.
• Modbus RTU network connection.
• Modbus RTU master device.
• 24 VDC power connection
• PC to execute Anybus X-gateway Configuration Tool (BWConfig).
• RS-232 null-modem cable to connect PC running BWConfig to the JMI.
Optional Hardware
• DIN rail to mount the JMI.
Required Software
• Anybus Configuration Tool software (BWConfig) to configure the JMI.
For support of all features described in this manual, the revision of
BWConfig should be v1.6 or later.
• BWConfig requires that the PC be running Microsoft Windows 98, NT,
2000, or XP.

Anybus X-gateway Module Description 1-5
© 2012 HMS Industrial Networks AB Doc.Id. HMSI-168-25
Hardware Description
The Anybus X-gateway J1939 to Modbus Interface has a 15-pin D-Subminiature
connector for power and network connections. This connector has pins for module
power, J1939 CAN connections, and Modbus RS-485 connections. See “Installa-
tion” Page 2-1 for details on using this connector.
A 25-pin D-Subminiature connector is provided for connection to a PC running
the Anybus Configuration Tool. This is a standard RS-232 DTE connection and
will require a null-modem cable (pins 2 and 3 swapped) to connect the module to
a PC serial port or USB serial adapter. See “Installation” Page 2-1 for details on
using this connector.
The front of the module has a set of 3 LEDs that are used for status indication.
These LEDs provide visual status for the overall module, the J1939 interface, and
the Modbus interface. See “Status and Diagnostics” Page 7-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
© 2012 HMS Industrial Networks AB Doc.Id. HMSI-168-25
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
© 2012 HMS Industrial Networks AB Doc.Id. HMSI-168-25
Power and Network Connector
The power and network connector is the 15-pin D-Subminiature female connector
on the end of the X-gateway. Connections to be made are illustrated in Figure 2-1.
Power Connection
The X-gateway requires 24 volts DC power. Power is applied to pins 9 and 10 of
the 15-pin D-Sub connector. The module will start immediately when power is
applied (There is no On/Off switch on the module).
Figure 2-1 Power and Network Connector
(9) 24 VDC Common
(10) 24 VDC +
(11) Modbus RS-485 A
(12) Modbus RS-485 B
J1939 CAN High (15)
J1939 CAN Low (14)
J1939 CAN Shield (13)

Installation 2-3
© 2012 HMS Industrial Networks AB Doc.Id. HMSI-168-25
Modbus Network Connection
The RS-485 signals for the Modbus network are connected to pins 11 and 12 of
the 15-pin D-Sub connector. The “A” signal should be connected pin 11, the “B”
to pin 12.
The A and B signal lines should be connected to the A and B connections respec-
tively on all devices on the network. The signal lines should not be swapped on
any device connection.
Note: Some RS-485 equipment uses “+” and “-” descriptors to label the signal
lines. The “-” corresponds to “A”. The “+” corresponds to “B”.
J1939 Network Connection
The J1939 CAN lines are connected to pins 14 and 15, with the CAN shield con-
nected to pin 13 of the 15-pin D-Sub connector. CAN Low is connected to pin 14,
CAN High to pin 15.
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.

Installation 2-4
© 2012 HMS Industrial Networks AB Doc.Id. HMSI-168-25
Configuration Port Connector
The configuration port is the 25-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 are shown in Figure 2-2.
If the PC running BWConfig has a 25-pin serial port, use a 25-pin to 25-pin null-
modem (pins 2 and 3 swapped) cable to connect the PC to the X-gateway. If the
PC has a 9-pin serial port (or USB serial adapter), use a 9-pin to 25-pin straight
through cable.
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.
Figure 2-2 Configuration Port Connector
(2) Transmit Data
(3) Receive DataSignal Ground (7)

Chapter 3 Configuration 3-1
© 2012 HMS Industrial Networks AB Doc.Id. HMSI-168-25
Configuration
This chapter describes how the Anybus X-gateway J1939 to Modbus Interface is
configured using the Anybus Configuration Tool (BWConfig). Detailed descrip-
tions of each configurable parameter in the JMI 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 Configuration Tool (BWConfig)
The Anybus Configuration Tool allows you to configure the parameters associ-
ated with the Modbus and J1939 network interfaces as well as to set up the con-
tents and layout of the I/O table.
BWConfig is a Microsoft Windows application that communicates with an Any-
bus X-gateway 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
© 2012 HMS Industrial Networks AB Doc.Id. HMSI-168-25
Connecting to the Anybus X-gateway Module
If the PC running BWConfig has a 25-pin serial port, use a 25-pin to 25-pin null-
modem (pins 2 and 3 swapped) cable to connect the PC to the X-gateway. If the
PC has a 9-pin serial port (or USB serial adapter), use a 9-pin to 25-pin straight
through cable. It does not matter which PC serial port you use, BWConfig will
scan each available port and detect the connection automatically.
Starting the Tool
Launch BWConfig from the Anybus Configuration folder in the Windows 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
© 2012 HMS Industrial Networks AB Doc.Id. HMSI-168-25
BWConfig User Interface
The Anybus Configuration Tool’s user interface is shown in Figure 3-1.
Figure 3-1 BWConfig User Interface

Configuration 3-4
© 2012 HMS Industrial Networks AB Doc.Id. HMSI-168-25
Display Panes
The BWConfig display is divided into 4 panes.
Tool Operations
The following operations are available through the BWConfig menus and tool bar.
X-gateway Configuration Module type and status information about the
X-gateway module that was detected.
Modbus Configuration Configuration of Modbus network parameters
and status of the network interface.
J1939 Configuration Configuration of J1939 network parameters
and status of the network interface.
J1939 I/O Configuration Configuration of the content and layout of the
I/O tables.
Open File Open a previously saved X-gateway configu-
ration.
Save File Save the current X-gateway configuration to a
file.
Refresh Device Status Refresh the module identity and status infor-
mation. This will update the current status
information shown by the tool. This can also
be used to start the detection process if a mod-
ule has not been detected by the tool, or the
connection has been changed to a different
module.
Upload Configuration Read the configuration that is currently stored
in the X-gateway module. This will overwrite
any configuration that is displayed on the
tool’s user interface.
Download Configuration Send the configuration shown on the tool’s
user interface to the X-gateway module.

Configuration 3-5
© 2012 HMS Industrial Networks AB Doc.Id. HMSI-168-25
Add I/O Point Add a new input or output data point to the
J1939 I/O configuration.
Edit I/O Point Change the parameters associated with the
selected input or output data point in the
J1939 I/O configuration.
Remove I/O Point Delete the selected input or output data point
from the J1939 I/O configuration.
Flash Update Perform a field upgrade of the X-gateway
module’s firmware.
Note: Care should be taken when upgrading
firmware, an incomplete update could cause
irreparable harm to the module.

Configuration 3-6
© 2012 HMS Industrial Networks AB Doc.Id. HMSI-168-25
Modbus Network Configuration
The Modbus network configuration contains the parameters used to control the
behavior of the Modbus serial interface. The parameters are described in Table 3-
1 below. Refer to Figure 3-1 to see how each parameter is displayed on the user
interface.
Parameter Description Allowable
Range
Network Address The address of the module on the Modbus net-
work. This is the slave address that the master
device will use when sending commands to
the module. All modules on the network must
have a unique address.
1 - 247
Baud Rate The network baud rate. All devices on the net-
work must use the same baud/parity/stop bits
configuration.
4800
9600
19200
Parity The serial communication parity configura-
tion. All devices on the network must use the
same baud/parity/stop bits configuration.
None
Even
Odd
Stop Bits The number of stop bits used in the serial
communication. All devices on the network
must use the same baud/parity/stop bits con-
figuration.
1 or 2
Watchdog
Time-out
The time in milliseconds after receiving a
message from the master before the module
detects that it is no longer connected to a mas-
ter. If a message is not received from the
Modbus master within the configured timeout
period, the module will revert to Idle mode.
(J1939 message transmission is suspended in
Idle mode.) The module will switch to, and
remain in, Run mode when messages are
being received from a master.
0 - 65535
Table 3-1 Modbus Network Configuration Parameters