ON Semiconductor AMIS-49587 Getting Started With

©

S

A

u

A

M

G

e49

Pre

p

I

n

C

o

mod

e

p

res

e

U

T

h

•••

H

W

T

h

give

n

•••

•

S

W

B

e

JRE
‘jav

a

b

e i

nTh

b

e d

o

http:

/

4958

M

a

emiconductor Com

p

gust 31, 2011

IS4

9

tting s

t

587 Ev

a

ared by: Ind

troductio

ngratulations,

h

m demonstrat

i

nt document

w

npack yo

u

e evaluation ki

•

2 AMIS-

4

p

lugged on

D

•

2 USB se

r

•

This man

u

W

requir

e

e material nec

hereunder:

•

1 PC run

n

free.

•

2 AMIS-

4

•

2 USB ca

b

•

2 mains

c

connector.
connect to

L

require

fore starting t

h

6.13 or highe

r

.com/getjava’.

stalled automa

t

e User Interfa

c

wnloaded fro

m

/www.onsemi.
7

ins connection

onents Industries, L

L

– Rev. 008

587

arted

w

luatio

n

ustrial ASSP

n

ere is the AM

I

on kit from O

N

ill help you to

r materi

a

t contains the

fo

9587 evaluatio

aughter Boar

d

ial cables

al

ments

essary to run

a

ing Windows

9587 evaluatio

les

ables. To con

n

(not included)

ine and Neutr

a

ments

e PLC UI, ma

k

is installed

o

On MS Wind

o

ically.
e Software an

d

:.

com/PowerSol

u

D

a

C, 2011

ith th

e

kit

- ON Semic

o

S-49587 pow

e

Semiconduct

o

get the kit wor

k

l

llowing elem

e

n boards (Mot

h

)

communicati

o

XP or higher

w

n boards

ect to the M

o

. Please take

l.

e sure the Jav

a

r download a

n

ws based plat

f

most recent d

o

tions/product.

ughter Board

Mothter Boar

AMIS

-

nductor

r line carrier

r, Inc.. The
ing quickly.

nts:
er Board and

n with the ki

t

ith 2 USB p

o

ther Board m

care to corre

c

Runtime Eng
d install it fr

o

orms the JRE

w

cumentation c

a

do?id=AMIS-

USB con

n

d

1

is

rts

ain

tly

ine

m
ill

n

c

odo

I

MdeDi

o

f

m

ection

AMIS-49587
RESET

The USB p

o

nverter. A de

d

wnload it fro

m

http://www.ft

d

Setting u

Once you get

t

Step 1:
Connect the b

o

Step 2:
Connect the P

L

Step 3

:

Power the PL

C

PORTANT
monstration
sconnect the

b

it. Be sure
anipulate it.

USB con

n

Mains conne

c

http://onse

m

rt communic

a

icated USB

d

the FTDI we

b

ichip.com/FT

D

p the har

d

he above liste

d

th PLC MOD

E

C MODEM

m

MODEM.

REMARK:

2

board. Kee

p

oard from t

h

that only tr

a

ection

tion

Publication

i.com

tes with a

F

river is need

e

site:

rivers.htm.

ware

elements, you

M’s to the US

ains plug to th

e

30V mains

a

the board

e mains befo

r

ained people

Order Number

:

AMIS-49587

TDI serial

U

d for this. Y

o

need to:

B ports of the

P

mains.

re present o

n

in a safe

e any manipu

l

are authoriz

e

ART

u can

C.

the

area.

ation

d to

AMIS-49587

http://onsemi.com

2

Setting up the software

The kit is delivered with a CDROM. Insert the CDROM in the
CD drive. For MS Windows based platforms, an installer
application is available: ONSemiPLCInstall.exe. The installer
application checks if the required Java Runtime Engine is installed.
If it is not, the installer will start downloading it from the Sun
website and install it.

For non MS Windows based platforms see SW requirements.

When the required Java Runtime Engine is installed, installation
of the ON Semiconductor PLC Modem application will proceed.

1.4.7

| AMIS49587 GUI application note.pdf

| plcui.chm

| PlcUi.jar

| rxtxSerial.dll

| Slave 7.1.plc.xml

| Master 7.1.plc.xml

| Spy 7.1.plc.xml

|

\---lib

AbsoluteLayout.jar

appframework-1.0.3.jar

RXTXcomm.jar

swing-worker-1.1.jar

PlcUi.jar is the main application, ‘AMIS49587 GUI application
note.pdf’ is this manual and ‘Master 7.1.plc.xml’ and ‘Slave

7.1.plc.xml’ are MODEM configuration files. Plcui.chm is the
source code documentation.

All other files are supporting libraries.

Running the Graphical user interface

The graphical user interface consists of 3 types of windows. The
main window allows the user to open a configuration file for a PLC
MODEM and implements a log of messages that traces user
activities and MODEM events. This event log can be cleared or
saved into a text file from the file menu. When a correct MODEM
configuration file is opened, a new window will appear,
implementing a user interface tailored to the type of configuration
that is opened (master, slave, monitor or spy). Master and slave
windows look very similar. Only the area where the MODEM’s
status is displayed is different. The application limits the number
of master or slave windows to 6.

The logging level can be set from 0 to 3 to choose the level of
detail of the log messages. Level 3 gives most details. The status
fields of the master and slave windows will update when the button
‘Update Status’, Reset’ or ‘Write Config’ are clicked or,
automatically, when the status pane is activated.

Figure 1 Main Window

Figure 2 Master Window

The MODEM’s can be forced to disconnect (lose
synchronization) by clicking the ‘De-sync’ button. The ‘Reset’
button shall be clicked when the modem is in an unknown state or
the user would like to start from a not configured MODEM.

When parameters, listed in the configuration file and exposed in
the GUI are changed, these changes can be saved into a new
configuration file by picking ‘Save Configuration’ from the master
or slave window file menu, or by pressing ‘CTRL-S’ (for now,
only the communication port and the MAC layer filter setting can
be changed from the GUI).

Note that all MODEM’s settings can be modified by editing the
configuration file in a text editor. The configuration file is an
XML file. Each MODEM parameter is encapsulated in parameter
name and value keywords. All parameters are to be coded in
hexadecimal numbers. Below is an example that shows how the
local MAC address is set to 0x555:

<LocalMac>

<Bits>16</Bits>

<Value>555</Value>

<Note>Number within FIMA to LIMA range</Note>

</LocalMac>

Only the value between <Value> and </Value> should be changed.
New settings can be activated by loading the new configuration file
from the main window.

The current PLC GUI implements a simple chat, data loop or file
transfer application between a master and a client. Before being
able to exchange data, one master configuration and at least one
slave configuration needs to be opened from the main window on
one or more PC’s.

To start communication, the following steps need to be executed
for both the master and the slave(s) windows:

Common to all 3 communication examples are:

1) Pick the serial port that is connecting the PLC master

MODEM. Only the serial communication ports available in
the PC are listed. Success or failure to open the chosen
communication port can be monitored in the log that is
displayed in the main window.

2) Click the ‘Reset’ button to bring the MODEM into a

known, not configured state.

3) Click the ‘Write Config.’ button to send the configuration

parameters to the MODEM. Check the main window log to
find out if this step completed without errors.

AMIS-49587

http://onsemi.com

3

Chat Application

When the Chat application is chosen:

1) Type the address of the MODEM to whom you would like

to send a message in the ‘Destination Address’ field. The
MODEM address is coded in the configuration file and
displayed in the status area.

2) Type a message in the bottom single line text field and hit

‘Enter’.

When the first message is sent from the master window, the
slave will synchronize with the master and display the message it
received in its text frame above its text input field. Follow the log
in the main window to check if all goes well. The first message
always needs to be initiated from the master window. When the
slave is properly synchronized, messages can be transmitted from
slave to master.

Depending on the previous state of the master, the first message
may fail to deliver. Initiate the send request again.

Figure 3 Master Window, configured with chat trace

Figure 4 Slave Window with chat trace

Data Loop Application

In the data loop application a constant data frame is sent from
one node (master or slave) and is received by the addressed node.
The receiver node can be configured to send the data back to the
sending node, implementing a data loop.

To setup a data loop, make sure the configuration file is written
to the MODEMs and in one node:

1) Check the ‘Enable loop’ checkbox to make this node into a

receiver and loop node.

In the window of the transmitter node:

2) Enter the frame length. The maximum is 247 bytes, the

minimum is 13 bytes.

3) Enter the number of times the data needs to be transmitted

4) Enter the destination address

5) Check the ‘Wait for looped data’ checkbox to make sure the

transmitter doesn’t send a new frame before receiving the
looped data.

6) Click the start button

Figure 5 Initiator node of the data loop

The LLC layer counters indicate the number of transmitted and
received frames. The approximate bit rate is calculated at the end
of transmit and receive sequence.

Figure 6 Receiving and looping node

By clicking the ‘Update Data Counters’ button, the MAC layer
counters that are kept in the MODEM are retrieved. The number
of received frames is the total of ‘CRC OK’ and ‘CRC NOK’
frames. All counter values can be reset by clicking the ‘Reset’
button.

The current implementation of the data loop does not check for
errors in the looped data.