Microscan DN120 DeviceNet User Manual

DN120 DeviceNet

Gateway

User’s Manual

DN120

PN 84-210010 Rev A

DN120 DeviceNet Gateway User’s Manual

Table of Contents

CHAPTER 1 – OVERVIEW ..................................................................................................................................... 4

CHAPTER 2 – INSTALLATION ............................................................................................................................. 5

OUNTING

IRING

DeviceNet Interface............................................................................................................................................. 6

Serial Channel Interface ..................................................................................................................................... 6

Wiring Examples................................................................................................................................................. 7

CHAPTER 3 – THEORY OF OPERATION........................................................................................................... 8

ATEWAY OPERATION

DeviceNet Object Model ..................................................................................................................................... 8

DeviceNet Interface............................................................................................................................................. 9

Serial Channel Interface ................................................................................................................................... 10

............................................................................................................................................................... 5

..................................................................................................................................................................... 6

............................................................................................................................................. 8

Asynchronous Serial Communication .............................................................................................................................11

Status Information ...........................................................................................................................................................11

Receiving Messages ........................................................................................................................................................12

Stream Mode ..............................................................................................................................................................12

Block Mode................................................................................................................................................................12

Returning Received Data............................................................................................................................................13

Padding Message Data ...............................................................................................................................................13

Re-sending Received Data .........................................................................................................................................14

Transmitting Messages....................................................................................................................................................15

Synchronization...............................................................................................................................................................15

Receive Sequence Number.........................................................................................................................................15

Transmit Sequence Number .......................................................................................................................................15

Synchronous Handshake Protocol..............................................................................................................................16

CHAPTER 4 – GATEWAY CONFIGURATION.................................................................................................18

ONFIGURE DEVICENET INTERFACE

....................................................................................................................... 18

DeviceNet Baud Rate Switch............................................................................................................................. 18

MAC ID Switches.............................................................................................................................................. 18

Serial Channel Baud Rate / Option Switch ....................................................................................................... 19

OWER UP GATEWAY

............................................................................................................................................. 19

DeviceNet Status LEDs ..................................................................................................................................... 19

Serial Channel Status LEDs.............................................................................................................................. 20

Register EDS File.............................................................................................................................................. 20

ONFIGURE SERIAL CHANNEL

ONFIGURE DEVICENET MASTER SCAN LIST

................................................................................................................................21

......................................................................................................... 26

Poll Consume Size............................................................................................................................................. 26

Poll Produce Size..............................................................................................................................................26

CHAPTER 5 – DEVICENET SPECIFICATIONS................................................................................................27

EVICENET MESSAGE TYPES

EVICENET CLASS SERVICES

EVICENET OBJECT CLASSES

................................................................................................................................. 27

IDENTITY OBJECT ............................................................................................................................................. 28

ROUTER OBJECT................................................................................................................................................ 29

DEVICENET OBJECT.......................................................................................................................................... 30

ASSEMBLY OBJECT........................................................................................................................................... 31

CONNECTION OBJECT ...................................................................................................................................... 32

SERIAL STREAM OBJECT................................................................................................................................. 34

CHAPTER 6 – RSNETWORX CONFIGURATION EXAMPLE....................................................................36

ONFIGURE DEVICENET INTERFACE

Microscan Systems, Inc.

....................................................................................................................... 37

DN120 DeviceNet Gateway User’s Manual

ONNECT

ONFIGURE SERIAL CHANNEL

ONFIGURE DEVICENET MASTER SCAN LIST

CHAPTER 7 – CONFIGURATION EXAMPLES................................................................................................ 59

XAMPLE

CHAPTER 8 – TROUBLESHOOTING ................................................................................................................. 68

& R

EGISTER

EDS F

ILE

........................................................................................................................... 37

................................................................................................................................45

......................................................................................................... 52

1 – R

ECEIVING FIXED-LENGTH DATA

.................................................................................................... 59

Barcode Scanner...............................................................................................................................................59

DN120 Gateway................................................................................................................................................ 59

2 – R

ECEIVING PRE-DELIMITED DATA

................................................................................................... 61

Barcode Scanner...............................................................................................................................................61

DN120 Gateway................................................................................................................................................ 61

3 – R

ECEIVING POST-DELIMITED DATA

................................................................................................. 63

Barcode Scanner...............................................................................................................................................63

DN120 Gateway................................................................................................................................................ 63

4 – T

RANSMITTING FIXED-LENGTH DATA

.............................................................................................. 65

Bar Code Scanner ............................................................................................................................................. 65

DN120 Gateway................................................................................................................................................ 65

5 – T

RANSMITTING VARIABLE-LENGTH DATA

....................................................................................... 67

Bar Code Scanner ............................................................................................................................................. 67

DN120 Gateway................................................................................................................................................ 67

APPENDIX A – PRODUCT SPECIFICATIONS..................................................................................................69

EVICENET INTERFACE

ERIAL CHANNEL

NVIRONMENTAL

.......................................................................................................................................... 69

................................................................................................................................................... 69

APPENDIX B – DEVICENET TEMPLATE.........................................................................................................70

APPENDIX C – ASCII CHARACTER CODES.................................................................................................... 71

Microscan Systems, Inc.

DN120 DeviceNet Gateway User’s Manual

(

)

(

)

Chapter 1 – Overview

This document describes how to install, configure, and operate the DN120 series of serial to DeviceNet gateways. The following products are covered in this user manual:

Part Number Serial Channel DN120 RS232 full duplex

The DN120 gateways allow you to easily interface a wide variety of serial devices to any DeviceNet industrial control network. Each gateway contains the feature-packed D.I.P. DeviceNet core. Standard DN120 products are tightly packaged and sealed in a rugged industrial case. Board-level and customized gateways are also available upon request.

Serial Status LEDs

Serial Baud Rate

Switch

Rotar

DeviceNet MAC ID

Switches

Rotar

DeviceNet Status LEDs

(NET, MOD)

(RX, TX)

DeviceNet Baud Rate

Switch

Rotar

DN120

Isolated Serial Channel

male DB9 connector

Product Features

• 500V isolated serial channel

• RS232 with RTS/CTS flow control

• XON/XOFF software flow control

• 300, 600, 1200, 2400, 4800, 9600, 19200 bps serial data rates

• Configurable parity

• 64 byte transmit and receive FIFO buffers

• Powered from DeviceNet 24VDC

• Loss-of-ground protection circuitry

• DeviceNet slave mode supports POLL and EXPLICIT messages

• Rotary switches set DeviceNet baud rate and MAC ID

• Rotary switch sets serial data rate

• 4 bi-color status LEDs

• Encapsulated circuit board in compact industrial case

ounting Holes

DeviceNet Channel

male 5-pin micro connector

Microscan Systems, Inc.

DN120 DeviceNet Gateway User’s Manual

Chapter 2 – Installation

This chapter describes how to install and connect the DN120 gateway to a DeviceNet network and your serial device.

Mounting

Mount on a horizontal or vertical surface. While the RTV encapsulation protects its circuitry, the DN120 serial channel connector is not rated for NEMA4 / IP65 environments. Mount the gateway in a suitable location or enclosure for your application. The gateway will generate up to

1.4W of heat, so provide sufficient clearance and airflow to maintain 0°C to 70°C operating temperature range. Use two screws (not provided) in the 0.19 inch mounting holes shown below to fasten the DN120 to the mounting surface.

1.25

ll dimensions

are inches

0.65 0.45

3.80

4.30

3.30

0.50

0.12 Mtg. Ho les 1.225 (2) 0.19 DIA.

0.725

0.625 DIA. On Case Wall

1.225

Microscan Systems, Inc.

0.70

0.542

1.10

DN120 DeviceNet Gateway User’s Manual

Wiring

The DN120 requires two connections – one to the DeviceNet network (male 5-pin micro connector) and one to the target serial device (male DB9 connector). Follow all applicable electrical codes in your area when mounting and wiring any electrical device.

All power is received from the DeviceNet network. The DN120 draws up to 50mA from the 24VDC power supply. Select your DeviceNet cables and power supply so that it can provide sufficient current for all networked devices at their peak operating power.

DeviceNet Interface

Male 5-Pin Micro Connector

V+

V-

PIN SIGNAL COLOR DESCRIPTION 1 DRAIN NONE Cable shield or drain wire. 2 V+ RED DeviceNet 24VDC(+) power. 3 V- BLACK DeviceNet 24VDC(-) power. 4 CAN_H WHITE Communication signal. 5 CAN_L BLUE Communication signal.

Serial Channel Interface

Male DB9 Serial Connector

DN120 (RS232)

PIN SIGNAL DESCRIPTION 1 NC No Connect. Do not connect any wires to NC pins. 2 RXD Receive Data. RS232 input signal. 3 TXD Transmit Data. RS232 output signal. 4 NC No Connect. 5 GND Ground. Common for RS232 signals. 6 NC No Connect. 7 RTS Request To Send. RS232 output signal. 8 CTS Clear To Send. RS232 input signal. 9 NC No Connect.

DRAIN CAN_L CAN

Microscan Systems, Inc.

DN120 DeviceNet Gateway User’s Manual

Wiring Examples

The following are typical DN120 gateway wiring configurations. Your RS232 or RS422/485 interface may vary. Refer to your device’s documentation for the required data and control signals.

Simple RS232 Interface

RS232

Serial

Device

RXD

TXD

GND

RXD

TXD

GND

DN120

DRAIN

VDC+

VDC-

CAN H

CAN L

RS232 Interface, HW Flow Control

RS232

Serial

Device

RXD

TXD

GND

RTS

CTS

RXD

TXD

GND

RTS

CTS

DN120

DRAIN

VDC+

VDC-

CAN H

CAN L

Microscan Systems, Inc.

DN120 DeviceNet Gateway User’s Manual

Chapter 3 – Theory of Operation

This chapter describes how the DN120 gateway operates. You should have a working knowledge of DeviceNet and asynchronous serial communications before continuing. The Open DeviceNet Vendors Association (www.odva.com) is a good source for general DeviceNet information. Refer to your serial device documentation for its protocol information.

Gateway Operation

The DN120 gateway receives asynchronous serial messages over its serial channel and returns the received bytes as input data to the DeviceNet master. The gateway transmits bytes sent as output data from the DeviceNet master out its serial channel. The following diagram shows the major gateway components.

DC:DC Power Conversion

• 24VDC DeviceNet power input

DeviceNet Poll Command

output data

• VDC for Core & DeviceNet channel

• isolated VDC for serial channel

5-pin male

micro connector

DeviceNet Poll Response

input data

DeviceNet Channel

• 24VDC power

• communications

DeviceNet Object

or Rotary Switches

Configures the DeviceNet interface baud rate and

AC ID address.

Gateway Core

• microcontroller

• RAM

• Flash ROM

Serial Channel

• communications

• flow control

Serial Stream Object

Configures the serial channel.

eceives and transmits seria messages. Controls optional synchronization.

Male DB9 connector

serial

messages

DeviceNet Object Model

The DeviceNet Specification defines an Object Model that consists of Objects and Attributes. An Object is a predefined software process, and an Object Attribute is a data value used or generated by that process. An Object Instance is one occurrence of an Object, operating on its unique set of Attribute values. The DN120 gateway has six different Object Classes, or types.

Five are standard objects defined by the DeviceNet Specification (Identity, Router, DeviceNet,

Assembly, Connection). One is a device-specific object defined for the DN120 gateway (Serial Stream). The Serial Stream Object configures and controls the serial channel. It receives and

packages serial data into DeviceNet input bytes, and transmits DeviceNet output bytes as serial data. Chapter 5 contains detailed information on each DeviceNet object class, instance, and their associated attributes.

Microscan Systems, Inc.

DN120 DeviceNet Gateway User’s Manual

DeviceNet Interface

The DN120 gateway operates as a DeviceNet slave. It supports Explicit Messages and Polled I/O Messages of the predefined master/slave connection set. The Explicit Unconnected Message Manager (UCMM) is not supported.

There are four independent processes operating in a DN120 gateway application. The first process is the exchange of input and output data between the user application program and the DeviceNet master. The second process is the exchange of input and output data between the gateway and DeviceNet master, using Polled I/O messaging. The third process is receiving serial messages and converting it to input data. The fourth process is converting output data and transmitting it as serial messages.

The DeviceNet Polled I/O Message process consists of the DeviceNet master sending output data to the DN120 in the form of a Poll Command message, and the DN120 returning input data to the DeviceNet master in a Poll Response message. The output and input data bytes are typically mapped into data files inside the DeviceNet master. These data files are exchanged with the user application program. The application processes the received input data from the gateway and writes new output data to the DeviceNet master, which sends them to the gateway.

The Polled I/O data exchange typically occurs at a faster rate than the serial transmit and receive operation, because the DeviceNet baud rate is much greater than the serial channel baud rate. The DN120 has transmit and receive buffers to handle the slower serial processes. The gateway also provides synchronization features to ensure delivery of received messages to the application program, and transmission of application messages out the serial channel.

DeviceNet Poll Response

input data

DeviceNet Poll Command

output data

DeviceNet

Master

Application

Program

DN120

Gateway

Receive

Message Packet

Transmit

Message Packet

Serial

Device

Microscan Systems, Inc.

DN120 DeviceNet Gateway User’s Manual

The DN120 configuration defines the number of output bytes in a Poll Command message, and the number of input bytes in a Poll Response message. Each Poll Command and Poll Response message can contain up to 2 overhead bytes for DN120 status and data synchronization information. The remaining bytes contain output data to be transmitted out the serial channel, or input data received by the serial channel.

The following diagram shows how the input and output bytes map into the Poll Response and Poll Command messages. The gateway supports a maximum of 67 output bytes in a Poll Command message, and a maximum of 67 input bytes in a Poll Response message.

DeviceNet Master Mapping of DeviceNet Poll Command and Poll Response Data

DeviceNet Master Outputs DeviceNet Poll Command Message Data

Status Clear

output bytes

output byte output byte output byte output byte output byte output byte output byte output byte output byte output byte output byte

output bytes

DeviceNet Master Inputs DeviceNet Poll Response Message Data

input bytes

input byte input byte input byte input byte input byte input byte input byte input byte input byte input byte input byte

input bytes

(if enabled)

Status

(if enabled)

TX Sequence Number (if

enabled)

RX Sequence Nu mber (if

enabled)

Other Output Bytes

(1-65 bytes)

Other Input Bytes

(1-65 bytes)

Serial Channel Interface

The DN120 serial channel consists of an asynchronous serial transmitter and receiver. The serial

interface is configured and controlled by the Serial Stream Object. The Serial Stream Object

attributes configure the serial channel baud rate, parity, and flow control. This configuration applies to both the serial transmitter and receiver. The DN120 gateway has separate 64-byte serial transmit and receive FIFO buffers, allowing full duplex operation when supported by the physical layer media.

Microscan Systems, Inc.

DN120 DeviceNet Gateway User’s Manual

Asynchronous Serial Communication

Devices communicating on an asynchronous serial link exchange information one bit at a time. Each bit is transmitted for a specific period of time, defined by the baud rate. Devices use internal timing circuitry to generate the baud rate. There is no clocking signal between devices

to synchronize the serial data flow, hence the term asynchronous serial communications.

Serial data bits are organized into bytes. When a data byte is asynchronously transmitted, it is preceded by a start bit, followed by the data bits, an optional parity bit, and one or more stop bits. There can be a variable transmission delay between successive data bytes, since each byte is framed by its own start and stop bits. The receiver starts saving bits after is receives a valid start bit (0), and stops when it receives the expected number of stop bits (1). The data byte’s leastsignificant bit is transmitted first (data bit 0), and the most-significant bit is last (data bit N).

[ start bit ] [ data bit 0 ] [ data bit 1 ] … [ data bit N ] [ optional parity bit ] [ stop bit(s) ]

The parity bit detects single-bit errors in the transmission. The parity bit is calculated and inserted by the transmitter. The receiver calculates the parity of an incoming byte, and compares it to the parity bit sent by the transmitter. If the two bit values do not match, then at least one serial bit value was corrupted during transmission.

Flow control enables the receiving device to regulate the rate of incoming data. Hardware flow control uses RTS/CTS signals between the devices to control the rate of transmission. Software flow control uses serial characters XON/OFF to control the rate. CTS Detect Mode uses the CTS signal to enable serial communications. Flow control helps prevent data loss, if the receiving device cannot store incoming data fast enough, or if its Receive Buffer is full and cannot accept more data until existing data is processed.

The DN120 supports baud rates from 300 to 19200 bits per second. It supports 8 data bits with no parity, 7 data bits with parity, and 1 stop bit. The DN120 model supports RTS/CTS, XON/XOFF, and CTS Detect Mode flow control options.

Status Information

The gateway can be configured to return serial channel status information in the Poll Response message, and receive error-clearing commands in the Poll Command message. When enabled,

the Status byte is returned as an input byte, and the Status Clear byte is received as an output

byte. These bytes contain 8 status bits, defined below. Each bit represents either an error or state condition for the serial transmitter and receiver. Clearing the associated error bit in the

Status Clear output byte will reset Receive Parity Error, Receive Buffer Overflow, Framing

Error, and Transmit Buffer Overflow error conditions.

Microscan Systems, Inc.

Status / Status Clear Bytes

DN120 DeviceNet Gateway User’s Manual

Bit Status (1st input byte) Status Clear (1st output byte) 0 Transmit Channel Blocked not used 1 Transmit Buffer Empty not used 2 Receive Parity Error Set = 0 to clear Receive Parity Error condition 3 Receive Buffer Empty not used 4 Receive Buffer Overflow Set = 0 to clear Receive Buffer Overflow condition 5 Framing Error Set = 0 to clear Framing Error condition 6 Transmit Buffer Overflow Set = 0 to clear Transmit Buffer Overflow condition 7 CTS Signal State (1 = asserted) not used

A user application can use the Transmit Buffer Empty and Receive Buffer Empty status bits to monitor the transmitter and receiver states. However, the DN120 gateway also has three data

synchronization features (Receive Sequence Number, Transmit Sequence Number, Handshake

Protocol) that an application can use to better monitor the serial operations. Receiving Messages

The DN120 gateway has two modes for receiving serial data: Stream Mode and Block Mode. Stream Mode is best suited for applications with fixed-length serial messages, but it can also be

used to capture any stream of serial data. Block Mode is intended for both fixed and variable- length message applications, where a Delimiter byte denotes the beginning or end of a message.

Stream Mode

Stream Mode saves all received message bytes in the Receive Buffer. There is no defined beginning or end to the message stream. The only limitation is the gateway must send bytes

from the Receive Buffer to the DeviceNet master (Poll Response message) faster than it saves new message bytes in the Receive Buffer, or the 64-byte buffer may eventually overflow.

Incoming data stream

Stream Mode

0x45 0x62 0x02 0x31 0x32 0x32 0x42 0x45 0x02 0x42 0x43 0x44 …

essage Bytes

Block Mode

Block Mode uses a configurable Delimiter byte to signal the start or end of a new message packet. The Delimiter cannot be used in any other part of the message, or it would be incorrectly interpreted as the start or end of a message. The gateway can be configured to save the Delimiter byte in the Receive Buffer, or discard it. In Block Mode, the gateway does not return any new

message data to the DeviceNet master until the entire serial message has been received.

The Pre-Delimiter Block Mode configuration expects the Delimiter at the start of a message. When a Delimiter byte is received, the gateway saves all subsequent bytes in the Receive Buffer until another Delimiter is received (signaling the start of another message), or until the Maximum

Receive Size number of bytes has been saved. All bytes received after the Maximum Receive Size and before the next Delimiter are discarded. In this mode, the maximum number of bytes in a single message is defined by the Maximum Receive Size attribute.

Incoming data stream

Microscan Systems, Inc.

0x45 0x62 0x02 0x31 0x32 0x32 0x42 0x45 0x02 0x42 0x43 0x44 …

DN120 DeviceNet Gateway User’s Manual

Pre-Delimiter Mode

0x02 0x31 0x32 0x32 0x42 0x45

0x02 0x42 0x43 0x44 …

elimiter = 0x02

elimite

essage Bytes

elimite

essage Bytes

The Post-Delimiter Block Mode configuration expects the Delimiter at the end of a message. The gateway saves all received bytes in the Receive Buffer until a Delimiter is received. In this

mode, the maximum number of bytes in a single message is limited by the Receive Buffer size

(64 bytes), not the Maximum Receive Size attribute.

Incoming data stream

Post-Delimiter Mode

elimiter = 0x02

0x45 0x62 0x02 0x31 0x32 0x32 0x42 0x45 0x02 0x42 0x43 0x44 …

0x45 0x62

essage Bytes

0x02

elimite

0x31 0x32 0x32f 0x42 0x45

essage Bytes

0x02

elimite

0x42 0x43 0x44 …

essage Bytes

Returning Received Data

When the gateway receives a Poll Command message, it removes some or all of the bytes currently in the Receive Buffer and returns them as input bytes in a Poll Response message.

The Maximum Receive Size attribute defines the maximum number of bytes that can be returned

in a single Poll Response message. If the Receive Buffer contains more bytes than can fit into one Poll Response message, the remaining bytes are returned in subsequent Poll Response

messages. RX Message is the string of valid message bytes returned in a single Poll Response message. The RX Message byte string can be formatted as either a Short_String (byte array with

byte = length) or a Byte Array (no length byte). The number of bytes in an RX Message string

can be less than or equal to the Maximum Receive Size, but never larger. When the number is

less, the remaining Poll Response input bytes are either padded or undefined.

In Stream Mode, the gateway will always try to fill Poll Response message with bytes from the Receive Buffer. The only time the RX Message size is less than the Maximum Receive Size is

when there are no more bytes in the Receive Buffer.

In Block Mode, the gateway will not return any data in a Poll Response message unless it has a

complete serial message saved in the Receive Buffer. If the message sizes are small, the gateway may have several messages saved in the Receive Buffer, depending upon how fast the DeviceNet master polls the gateway for data. The messages are returned one at a time in a Poll Response message, regardless of their size. If the message is large, then it is returned in multiple Poll Response messages.

Padding Message Data

Microscan Systems, Inc.

DN120 DeviceNet Gateway User’s Manual

If the number of RX Message bytes currently in the Receive Buffer is less than the Maximum Receive Size number, then the remaining input bytes are undefined. The gateway can optionally

fill the unused input bytes with a Pad character. The Pad characters can be added at the

beginning or end of the message.

oll Response Message Data

Status

1. The are enough message bytes in Receive uffer to fill Poll Response.

2. The are not enough message bytes in eceive Buffer to fill Poll Response. Unused

input bytes are undefined.

3. The are not enough message bytes in eceive Buffer to fill Poll Response. Pad bytes

are added after message bytes.

4. The are not enough message bytes in eceive Buffer to fill Poll Response. Pad bytes

are added before message bytes.

eceive Sequence Numbe

other input bytes

RX Message bytes

RX Message bytes undefined

RX Message bytes

Pad Bytes

RX Message Bytes

Pad Bytes

If configured for Pre-Delimiter Block Mode and the Delimiter byte is saved, the Pad characters are added either after the last valid message byte (right justification) or before the Delimiter byte

(left justification).

If configured for Post-Delimiter Block Mode and the Delimiter byte is saved, the Pad characters

are added either before the first valid message byte (left justification), or after the last valid

message byte but before the Delimiter byte (right justification).

Re-sending Received Data

The DN120 gateway can be configured to return received message bytes only once in a Poll Response message, and return no data (null value) in subsequent Poll Response messages until new message bytes are received. For the Short_String data type, a null value consists of the length byte = 0. For the Byte Array data type, a null value consists of no data.

The gateway can also be configured to always return received message bytes in a Poll Response message. If no new bytes in the Receive Buffer, then the last received bytes are returned. If new

bytes are in the Receive Buffer, then they are returned. The gateway provides Receive Sequence Number or Handshake Protocol synchronization options to indicate whether the returned bytes

represent old or new data.

Microscan Systems, Inc.

DN120 DeviceNet Gateway User’s Manual

Transmitting Messages

The Serial Stream Object receives output bytes (TX Message) from the DeviceNet master in a

Poll Command message. It saves the output bytes in the Transmit Buffer, to be transmitted when the serial channel is available. The maximum number of bytes that can be sent in one Poll

Command message is defined by the Maximum Transmit Size attribute. The Transmit Buffer can

hold up to 64 bytes. Because the DeviceNet Polled I/O data exchange may occur many times faster than the transmission of serial data, the application may need to synchronize the transmit data exchange with the gateway.

The number of output bytes in the Poll Command message is fixed. The Status Clear and Transmit Sequence Number bytes are always sent, if enabled. The remaining number of bytes in the Poll Command is defined by the Maximum Transmit Size attribute. If the number of TX Message bytes sent is less than the Maximum Transmit Size number, then the remaining output

bytes are undefined. The gateway uses the Short_String length to determine the valid number of bytes to transmit. If Byte Array format is used, all the bytes are transmitted.

oll Command Message Data

Status Clear Transmit Sequence Number other output bytes

1. TX Message bytes fill Poll Command

message.

2. TX Message is smaller than Poll Command

message. Unused output bytes are undefined.

TX Message bytes

TX Message bytes undefined

Synchronization

To ensure that no information is lost between the gateway’s serial channel and the user

application program, the DN120 has three synchronization options: Receive Sequence Number, Transmit Sequence Number, and Handshake Protocol.

Receive Sequence Number

When enabled, the gateway returns a Receive Sequence Number input byte in the DeviceNet Poll Response message. The 8-bit Receive Sequence Number is incremented by the gateway whenever it returns new data in the input bytes. The user application uses the Receive Sequence Number to signal the receipt of new message data. Valid numbers are 0-255.

Transmit Sequence Number

When enabled, the gateway receives a Transmit Sequence Number output byte in the DeviceNet Poll Command message. The gateway will not send the TX Message bytes out the serial channel unless the 8-bit Transmit Sequence Number is different than the last received value. Valid

numbers are 0-255.

Microscan Systems, Inc.

DN120 DeviceNet Gateway User’s Manual

Synchronous Handshake Protocol

The gateway can be configured with a more robust transmit and receive synchronization process.

The Handshake protocol requires the user application to acknowledge the receipt of new RX Message input bytes. The protocol also requires the gateway to acknowledge the transmission of the last TX Message output bytes. When enabled, both the Receive Sequence Number input byte and Transmit Sequence Number output byte are used. They are segmented into four 4-bit

numbers, shown below. Valid numbers are 1 to 15, with 0 reserved to reset the gateway’s numbers.

Transmit Sequence Number byte

Receive Acknowledge Number Transmit Request Number

Bits 4-7 (upper nibble) Bits 0-3 (lower nibble)

eceive Sequence Number byte

Receive Request Number Transmit Acknowledge Number

Bits 4-7 (upper nibble) Bits 0-3 (lower nibble)

The Receive Request Number is incremented by the gateway when it returns new RX Message

input bytes in the Poll Response Message. The gateway will increment from 15 to 1, skipping 0.

The user application acknowledges receipt of this RX Message by setting the Receive

Acknowledge Number equal to the Receive Request Number. The updated Receive Acknowledge Number is sent back to the gateway in the next Poll Command Message. When the Receive Acknowledge Number equals the Receive Request Number, the gateway can return the next set of RX Message. If the user application sends 0 as the Receive Acknowledge Number, the gateway

resets its Receive Request Number to 0.

The following ladder-logic rung shows how the user application program can monitor the

gateway’s Receive Request Number (RX Rqst Num), save the new RX Message bytes, and set Receive Acknowledge Number (RX Ack Num) equal to Receive Request Number (RX Rqst

Num).

id gateway increment the RX Rqs um, indicating new data?

Compare Function: RX Rqst Num <> RX Ack Num

Copy Function: <byte array> = RX Message

Copy Function: RX Ack Num = RX Rqst Num

Microscan Systems, Inc.

DN120 DeviceNet Gateway User’s Manual

The Transmit Request Number is incremented by the user application when it sends new TX Message output bytes in the Poll Command Message. After the gateway transmits these TX Message bytes, it sets the Transmit Acknowledge Number equal to the Transmit Request Number,

acknowledging the transmission. The updated Transmit Acknowledge Number is returned in the next Poll Response Message. If the user application sends 0 as the Transmit Request Number, the gateway ignores the TX Message output bytes and resets its Transmit Acknowledge Number

to 0.

The following ladder-logic rungs show how the user application program writes a new TX

Message value, increments the Transmit Request Number (TX Rqst Num), and waits for the Transmit Acknowledge Number (TX Ack Num) to equal the Transmit Request Number (TX Rqst Num). Note the application must wrap the Transmit Request Number from 15 to 1.

id gateway finish (acknowledge)

transmitting the last message?

Compare Function: TX Ack Num == TX Rqst Num

Write next output bytes to transmit.

Copy Function: TX Message = <byte array>

f TX Rqst Number greater than 15,

then reset number to 1 (1-15 range)

Compare Function: TX Rqst Num == 16

ncrement TX Rqst Num (new data)

Addition Function: TX Rqst Num = TX Rqst Num + 1

Write Function: TX Rqst Num = 1

Microscan Systems, Inc.

DN120 DeviceNet Gateway User’s Manual

Chapter 4 – Gateway Configuration

This chapter describes how to configure and operate the DN120 gateway. You configure the gateway by reading and writing attribute values over its DeviceNet interface. There are a variety of DeviceNet configuration tools available. Simple configuration tools use GET_ATTRIBUTE and SET_ATTRIBUTE explicit message commands to read and write attribute values, addressing each attribute by its Object, Instance, and Attribute numbers. This information is contained in Chapter 5. More sophisticated configuration tools use EDS files to simplify attribute configuration. You can configure the gateway using pull-down menus, buttons, and data entry fields from the gateway’s Electronic Data sheet (EDS) file. Chapter 6 contains a configuration example using the Rockwell Software RSNetworx program.

Configure DeviceNet Interface

Set the DeviceNet Baud Rate and MAC ID Address using the rotary switches. Configure switches before connecting to the DeviceNet network. There is either a small triangular indicator or white indicator on the switch. Use a small screwdriver to align that indicator with the desired setting. Remove the DN120 cover if necessary to access the rotary switches.

DeviceNet Baud Rate Switch

Valid settings are 125K, 250K, 500K, or PGM. When PGM is selected, the DN120 uses the baud rate saved in its retentive memory. A valid baud rate must be stored before the PGM selection can be used. The baud rate is stored from the previous DN120 power cycle. It can also be set over the network (DeviceNet Object Baud Rate attribute).

POSITION SETTING POSITION SETTING 0 125 Kbps 5 invalid 1 250 Kbps 6 invalid 2 500 Kbps 7 invalid 3 invalid 8 invalid 4invalid 9PGM

MAC ID Switches

The two MAC ID switches represent decimal numbers from 00 to 99. The LSB switch selects

the Ones digit and the MSB switch selects the Tens digit. Valid MAC IDs are 00 to 63. Setting

a MAC ID address greater than 63 forces the gateway to use the MAC ID saved in retentive memory. A valid MAC ID must first be stored before this feature can be used. The MAC ID is stored from the previous DN120 power cycle. It can also be set over the network (DeviceNet Object MAC ID attribute).

MSB LSB Address MSB LSB Address 0 0 to 9 00 to 09 6 4 to 9 stored address 1 0 to 9 10 to 19 7 0 to 3 stored address 2 0 to 9 20 to 29 8 0 to 9 stored address 3 0 to 9 30 to 39 9 0 to 9 stored address 4 0 to 9 40 to 49 5 0 to 9 50 to 59 6 0 to 3 60 to 63

Microscan Systems, Inc.

DN120 DeviceNet Gateway User’s Manual

Serial Channel Baud Rate / Option Switch

The DN120 gateway has a rotary switch for the serial channel. This switch has different functions for the DN120 models.

The DN120 model uses the rotary switch to select the RS232 channel baud rate. Valid settings are 300, 600, 1200, 2400, 4800, 9600, 19200 bits per second, and PRG (table below). When

PRG is selected, the DN120 uses the Baud Rate attribute in the Serial Stream Object. A valid

baud rate must be written over DeviceNet to this attribute.

POSITION SETTING POSITION SETTING 0 9600 bps 5 300 bps 1 4800 bps 6 19200 bps 2 2400 bps 7 invalid 3 1200 bps 8 invalid 4 600 bps 9 PRG

Power Up Gateway

Connect the gateway to a DeviceNet network to power up the gateway.

DeviceNet Status LEDs

The DN120 gateway has two bi-color status LEDs (NET and MOD) that indicate operational

status. During power-up, the LEDs cycle through a sequence of alternating red and green. After

power-up, the NET LED should be flashing green (or solid green if allocated to a DeviceNet master) and the MOD LED should be solid green. If this does not occur, disconnect from

DeviceNet and verify all the switch settings. See Chapter 8 for additional troubleshooting topics.

State DeviceNet Status LED (NET)

Off No power.

Flashing Red Configuration error. Check DeviceNet switch settings.

Solid Red Unrecoverable error.

Flashing Green Device not allocated to a DeviceNet master.

Solid Green Normal runtime, device allocated as a slave.

State Module Status LED (MOD)

Off No power.

Flashing Red Configuration error. Check object attribute settings.

Solid Red Unrecoverable error.

Flashing Green Not defined.

Solid Green Normal Operation.

Microscan Systems, Inc.

DN120 DeviceNet Gateway User’s Manual

Serial Channel Status LEDs

The gateway has two bi-color LEDs to indicate serial channel activity. The TX LED flashes green when a packet is being transmitted. The RX LED flashes green when a packet is being

received. A fault is indicated by solid red. After power-up, both LEDs should be off.

State Transmit Status LED (TX)

Off No data being transmitted

Flashing Red Not defined

Solid Red Transmit error (parity or overrun error)

Flashing Green Data being transmitted

Solid Green Not defined

State Receive Status LED (RX)

Off No data being received

Flashing Red Not defined

Solid Red Receive error (parity or overrun error)

Flashing Green Data being received

Solid Green Not defined

If using a DeviceNet configuration tool that supports Electronic Data Sheet (EDS) files, you should now register the gateway’s EDS file with the software. The latest EDS file versions can be downloaded from www.mksinst.com. Select the EDS file that matches your gateway’s part number and firmware version. Follow your configuration tool instructions to register EDS file.

Microscan Systems, Inc.

DN120 DeviceNet Gateway User’s Manual

Configure Serial Channel

The Serial Stream Object attributes control the DN120 serial channel. These settings apply to all

serial transmit and receive operations. Before you can set or change any gateway configuration settings, make sure the gateway is not in the DeviceNet master scanlist.

Serial Stream Object Instance Attributes (Class Code 64)

Number Name Data Type Value

3 Receive Data Short_String

Byte Array

4 Transmit Data Short_String

Byte Array

5 Status USINT Bit 0 – Transmit Channel Blocked

6 Baud Rate USINT 0 = 9600 bps 4 = 600 bps

7 Parity USINT 0 = no parity 5 = mark (force to 1)

8 Data Size USINT Read-only. 7 bits if parity enabled, 8 bits if no parity. 9 Stop Bits USINT Read-only. Fixed at 1 bit.

10 Flow Control USINT 0 = none 2 = CTS / RTS

11 Receive Count USINT Number of bytes in Receive Buffer. Any write clears buffer. 12 Transmit Count USINT Number of bytes in Transmit Buffer. Any write clears buffer. 13 Maximum Receive Size USINT Defines the maximum #bytes returned by RX Message read. 14 Data Format USINT Bit 0 – String Format (0 = Short_String, 1 = Byte Array)

15 Block Mode USINT Bit 0 – Pre/Post Delimiter (0 = pre-delimiter, 1 = post-delimiter)

16 Delimiter USINT Delimiter byte value 17 Pad Character CHAR Pad byte value 18 Maximum Transmit Size USINT Defines the maximum # bytes that can be transmitted. 19 Idle String Short_String 1-16 byte string transmitted when gateway receives a null Poll

Received message data. Returned in Poll Response Message.

Message data to transmit. Received in Poll Command Message.

Bit 1 – Transmit Buffer Empty Bit 2 – Receive Parity Error (set = 0 to clear) Bit 3 – Receive Buffer Empty Bit 4 – Receive Buffer Overflow Error (set = 0 to clear) Bit 5 – Framing Error (set = 0 to clear) Bit 6 – Transmit Buffer Overflow Error (set = 0 to clear) Bit 7 – CTS Signal State (1 = asserted)

1 = 4800 bps 5 = 300 bps 2 = 2400 bps 6 = 19200 bps 3 = 1200 bps

1 = even parity 6 = space (force to 0) 2 = odd parity

1 = XON / XOFF 4 = CTS Detect Mode

Bit 1 – Strip Parity Bits (0 = retain, 1 = strip) Bit 2 – Pad Justification (0 = left justify, 1 = right justify) Bit 3 – Pad Received Message (0 = no, 1 = yes)

Bit 1 – Strip Delimiter (0 = keep delimiter, 1 = strip delimiter) Bit 2 – Delimiter Enable (0 = no, 1 = yes) Bit 3 – Enable Receive Sequence Number (0 = no, 1 = yes) Bit 4 – Enable Transmit Sequence Number (0 = no, 1 = yes) Bit 5 – Re-send (0 = no, 1 = yes) Bit 6 – Synchronization (0 = no, 1 = handshake protocol)

(no input bytes). Short_String length = 0 for no Idle String.

Microscan Systems, Inc.

DN120 DeviceNet Gateway User’s Manual

20 Fault String Short_String 1-16 byte string transmitted when gateway’s Polled I/O

connection times out. Short_String length = 0 for no Fault String.

21 Status Enable USINT Set to any nonzero value to enable Status input byte. 22 Status Clear Enable USINT Set to any nonzero value to enable Status Clear output byte. 23 Four Wire USINT NA 24 Option Switch USINT NA

Receive Data – Data from the last valid message packet. Receive Data includes the Status and Receive Sequence Number bytes if enabled, and the RX Message bytes. The RX Message format

is either Short_String or Byte Array, defined by Data Format attribute. If no message data is available, the RX Message will be a null packet or Short_String with length = 0. Receive Data is

returned in the DeviceNet Poll Response Message.

eceive Data

Status

eceive Sequence Numbe

ata Format =

xxxxxxx0

Short_String data bytes Byte Array data bytesLength

RX Message

ata Format =

xxxxxxx1

Transmit Data – Data to transmit out the serial channel by the gateway. Transmit Data includes the Status Clear and Transmit Sequence Number bytes if enabled, and the TX Message bytes. Format is either Short_String or Byte Array, defined by Data Format attribute. Transmit Data is typically received in the DeviceNet Poll Command Message. Reading Transmit Data returns the

last byte in the Transmit Buffer.

Transmit Data

Status Clear Transmit Sequence Number TX Message

ata Format =

xxxxxxx0

Short_String data bytes Byte Array data bytesLength

ata Format =

xxxxxxx1

Status – Contains bit-mapped serial channel status and error bits for transmit and receive

operations. Clearing the bits indicated will clear the error condition.

Baud Rate – Sets the serial channel’s data or baud rate. Enter number from 1-6 to select

corresponding baud rate value. For DN120, the RS232 Baud Rate switch must be set to PRG before this attribute can be used to set the baud rate.

Microscan Systems, Inc.

+ 49 hidden pages

Microscan DN120 DeviceNet User Manual

Specifications and Main Features

Frequently Asked Questions

User Manual