www.rkjava.de
A B C D E F G I J N O P Q R S T U Z

A

AFTER_STX_NO_DLE - Static variable in class de.rkjava.serial.j3964r.J3964REvent
After STX no DLE
AFTER_STX_NO_DLE_WITHIN_QVZ - Static variable in class de.rkjava.serial.j3964r.J3964REvent
After STX no DLE within QVZ
addJ3964RListener(J3964RListener) - Method in class de.rkjava.serial.j3964r.J3964R
Adds a J3964RListener
addS5DataListener(S5DataListener) - Method in class de.rkjava.serial.rk512.DefaultS5Model
 
addS5DataListener(S5DataListener) - Method in interface de.rkjava.serial.rk512.S5Model
Adds a S5DataListener.
addS7DataListener(S7DataListener) - Method in class de.rkjava.serial.rk512.DefaultS7Model
 
addS7DataListener(S7DataListener) - Method in interface de.rkjava.serial.rk512.S7Model
Adds a S7DataListener

B

BYTES_ERROR - Static variable in class de.rkjava.serial.rk512.Rk512toPLC
-10000
byte2Hex(byte) - Static method in class de.rkjava.serial.j3964r.J3964R
gives you a byte as a HEX-View

C

CANCEL_AFTER_SIX_TRIES - Static variable in class de.rkjava.serial.j3964r.J3964REvent
Only used, if (STXafterNAK == true)
CANCEL_AFTER_TREE_TRIES - Static variable in class de.rkjava.serial.j3964r.J3964REvent
-3
close() - Method in class de.rkjava.serial.j3964r.J3964R
closing the connection.
close(String) - Static method in class de.rkjava.serial.rk512.Rk512toPLC
Closed the serial interface portName.
closeAll() - Static method in class de.rkjava.serial.rk512.Rk512toPLC
Closed all serial interfaces.

D

DLE - Static variable in class de.rkjava.serial.j3964r.J3964R
0x10
DefaultS5Model - class de.rkjava.serial.rk512.DefaultS5Model.
This class is a simple S5Model to handle S5-data
DefaultS5Model(int, int, int, int) - Constructor for class de.rkjava.serial.rk512.DefaultS5Model
Creates an object, that represents S5-data
DefaultS7Model - class de.rkjava.serial.rk512.DefaultS7Model.
This class is a simple S7Model to handle S7-data
DefaultS7Model(int, int, int, int) - Constructor for class de.rkjava.serial.rk512.DefaultS7Model
Creates an object, that represents S7-data
dataReceived(J3964REvent) - Method in interface de.rkjava.serial.j3964r.J3964RListener
Will be called, when new data arrived
You will get the data with e.getBytes()
dataSend(J3964REvent) - Method in interface de.rkjava.serial.j3964r.J3964RListener
Will be called, when the transmission is finished
About success or unsuccess of the transmission, you will be informed with the call e.getErrorNo()
de.rkjava.serial.j3964r - package de.rkjava.serial.j3964r
de.rkjava.serial.j3964r-package:
For direct data exchange in form of a byte array via serial interface with 3964R protocol
It uses the Communication API 2.0 from Sun, which you must have installed.
de.rkjava.serial.rk512 - package de.rkjava.serial.rk512
de.rkjava.serial.rk512-package:
For data exchange with Simatic S5- or S7-PLC's (MPI-protocol by using for example Helmholz-Adapter SSW7-RK512) and other Hardware using the Rk512-protocol.

E

ETX - Static variable in class de.rkjava.serial.j3964r.J3964R
0x03

F

FETCH_ACKNOWLEDGE_ERROR - Static variable in class de.rkjava.serial.rk512.Rk512toPLC
-10003
fetch(long) - Method in class de.rkjava.serial.rk512.Rk512toPLC
This method fetchs the data from the PLC and puts it into your S5Model/S7Model.

G

getAmmountBytes() - Method in class de.rkjava.serial.rk512.DefaultS7Model
 
getAmmountBytes() - Method in interface de.rkjava.serial.rk512.S7Model
Returns the ammount of the databytes
getAmmountWords() - Method in class de.rkjava.serial.rk512.DefaultS5Model
 
getAmmountWords() - Method in interface de.rkjava.serial.rk512.S5Model
Returns the ammount of the datawords
getBit(int, int) - Method in class de.rkjava.serial.rk512.DefaultS5Model
Returns the value of a Bit as boolean.
getBit(int, int) - Method in class de.rkjava.serial.rk512.DefaultS7Model
Returns the value of a Bit as boolean.
getBytes() - Method in class de.rkjava.serial.j3964r.J3964REvent
The data as a byte-array
getBytes() - Method in class de.rkjava.serial.rk512.DefaultS7Model
 
getBytes() - Method in interface de.rkjava.serial.rk512.S7Model
Returns the databytes
getCpuNo() - Method in class de.rkjava.serial.rk512.DefaultS5Model
 
getCpuNo() - Method in class de.rkjava.serial.rk512.DefaultS7Model
 
getCpuNo() - Method in interface de.rkjava.serial.rk512.S5Model
Returns the Cpu-Number
getCpuNo() - Method in interface de.rkjava.serial.rk512.S7Model
Returns the Cpu-No
getCurrentOwner() - Method in class de.rkjava.serial.rk512.PortInUseException
 
getDbNo() - Method in class de.rkjava.serial.rk512.DefaultS5Model
 
getDbNo() - Method in class de.rkjava.serial.rk512.DefaultS7Model
 
getDbNo() - Method in interface de.rkjava.serial.rk512.S5Model
Returns the Number of the datablock
getDbNo() - Method in interface de.rkjava.serial.rk512.S7Model
Returns the Number of the datablock
getErrorMessage(int) - Static method in class de.rkjava.serial.rk512.Rk512toPLC
If fetch or send returns a number not 0, this method tells you what kind of error you got.
getErrorNo() - Method in class de.rkjava.serial.j3964r.J3964REvent
Gives the J3964REvent.NO_ERROR, if no error
getFirstByteNo() - Method in class de.rkjava.serial.rk512.DefaultS7Model
 
getFirstByteNo() - Method in interface de.rkjava.serial.rk512.S7Model
Returns the Number of the first databyte in the datablock
getFirstWordNo() - Method in class de.rkjava.serial.rk512.DefaultS5Model
 
getFirstWordNo() - Method in interface de.rkjava.serial.rk512.S5Model
Returns the Number of the first dataword in the datablock
getMPI(String) - Static method in class de.rkjava.serial.rk512.Rk512toPLC
Returns the MPI-status for portName.
getPortName() - Method in class de.rkjava.serial.rk512.NoSuchPortException
 
getPortName() - Method in class de.rkjava.serial.rk512.PortInUseException
 
getPortNames() - Static method in class de.rkjava.serial.j3964r.J3964R
The systems provided interfaces
getSpeed() - Method in class de.rkjava.serial.j3964r.J3964R
Gets the baudrate
getSpeed(String) - Static method in class de.rkjava.serial.rk512.Rk512toPLC
The current speed of serial interface portName
getWords() - Method in class de.rkjava.serial.rk512.DefaultS5Model
 
getWords() - Method in interface de.rkjava.serial.rk512.S5Model
Returns the datawords

I

isPort(String) - Static method in class de.rkjava.serial.rk512.Rk512toPLC
Tests whether portName exist or not.

J

J3964R - class de.rkjava.serial.j3964r.J3964R.
With a instance of J3964R you can send data in form of a byte array and register your J3964RListener to be informed about incoming data.
J3964R(String, int, int, int, int) - Constructor for class de.rkjava.serial.j3964r.J3964R
Creates and starts an object of this class
It can exchange data via specified serial interface with 3964R protocol.
J3964R(String, int) - Constructor for class de.rkjava.serial.j3964r.J3964R
Creates and starts an object of this class
It can exchange data via specified serial interface with 3964R protocol.
J3964R(String, int, J3964RListener) - Constructor for class de.rkjava.serial.j3964r.J3964R
Creates and starts an object of this class
It can exchange data via specified serial interface with 3964R protocol.
J3964REvent - class de.rkjava.serial.j3964r.J3964REvent.
An object of this class will be transfered to a J3964RListener by calling his methods J3964RListener.dataReceived(J3964REvent) or J3964RListener.dataSend(J3964REvent)
J3964REvent(Object, Byte[]) - Constructor for class de.rkjava.serial.j3964r.J3964REvent
Creates new J3964REvent
J3964REvent(Object, int) - Constructor for class de.rkjava.serial.j3964r.J3964REvent
Creates new J3964REvent
J3964RListener - interface de.rkjava.serial.j3964r.J3964RListener.
You should implement this Interface to be informed about new data and if your transmission was successful or unsuccessfull
J3964RNextInDataListener - interface de.rkjava.serial.j3964r.J3964RNextInDataListener.
You should implement this Interface to be informed about the next new incoming data
An object of this class can be used at sendData(...)

N

NAK - Static variable in class de.rkjava.serial.j3964r.J3964R
0x15
NO_ERROR - Static variable in class de.rkjava.serial.j3964r.J3964REvent
0
NoSuchPortException - exception de.rkjava.serial.rk512.NoSuchPortException.
 
NoSuchPortException(String) - Constructor for class de.rkjava.serial.rk512.NoSuchPortException
 

O

open(String) - Static method in class de.rkjava.serial.rk512.Rk512toPLC
Opens the serial interface portName.

P

PortInUseException - exception de.rkjava.serial.rk512.PortInUseException.
 
PortInUseException(String, String) - Constructor for class de.rkjava.serial.rk512.PortInUseException
 

Q

QVZ - Static variable in class de.rkjava.serial.j3964r.J3964R
acknowledgement delay time
Defaultvalue: 2000ms.

R

RVZ - Static variable in class de.rkjava.serial.j3964r.J3964R
response dalay time
Defaultvalue: 3000ms.
Rk512toPLC - class de.rkjava.serial.rk512.Rk512toPLC.
This is the class to communicate with RK512-protocol (even MPI-protocol by using for example Helmholz-Adapter SSW7-RK512) via serial interface with a PLC (S7, S5, ... ) using the de.rkjava.serial.j3964r-package.
Rk512toPLC(S7Model, String, byte, byte) - Constructor for class de.rkjava.serial.rk512.Rk512toPLC
Creates an instance of Rk512toPLC
Rk512toPLC(S7Model, String) - Constructor for class de.rkjava.serial.rk512.Rk512toPLC
Creates an instance of Rk512toPLC
Rk512toPLC(S5Model, String, byte, byte) - Constructor for class de.rkjava.serial.rk512.Rk512toPLC
Creates an instance of Rk512toPLC
Rk512toPLC(S5Model, String) - Constructor for class de.rkjava.serial.rk512.Rk512toPLC
Creates an instance of Rk512toPLC
removeJ3964RListener(J3964RListener) - Method in class de.rkjava.serial.j3964r.J3964R
Removes a J3964RListener.
removeS5DataListener(S5DataListener) - Method in class de.rkjava.serial.rk512.DefaultS5Model
 
removeS5DataListener(S5DataListener) - Method in interface de.rkjava.serial.rk512.S5Model
Removes a S5DataListener
removeS7DataListener(S7DataListener) - Method in class de.rkjava.serial.rk512.DefaultS7Model
 
removeS7DataListener(S7DataListener) - Method in interface de.rkjava.serial.rk512.S7Model
Removes a S7DataListener
run() - Method in class de.rkjava.serial.j3964r.J3964R
Don't use run() or start(), the Thread starts automatically within the constructor!

S

S5DataListener - interface de.rkjava.serial.rk512.S5DataListener.
An object, which implemets this interface and which is registered at a S5Model, will be informed about all changes at the data
S5Model - interface de.rkjava.serial.rk512.S5Model.
When DefaultS5Model is not complete for your whishes, you can implement this interface by your self
S7DataListener - interface de.rkjava.serial.rk512.S7DataListener.
An object, which implemets this interface and which is registered at a S7Model, will be informed about all changes at the data
S7Model - interface de.rkjava.serial.rk512.S7Model.
When DefaultS7Model is not complete for your whishes, you can implement this interface by your self
SEND_ACKNOWLEDGE_ERROR - Static variable in class de.rkjava.serial.rk512.Rk512toPLC
-10002
STX - Static variable in class de.rkjava.serial.j3964r.J3964R
0x02
STXafterNAK - Static variable in class de.rkjava.serial.j3964r.J3964R
The 3964R specification is not clear: Therefore two possibilities for "STXafterNAK"
Defaultvalue: true.
s5StructureChanged(EventObject) - Method in interface de.rkjava.serial.rk512.S5DataListener
Will be called, when changes apears in cpuNo, dbNo, firstWordNo and/or ammountWords
s5ValuesChanged(EventObject) - Method in interface de.rkjava.serial.rk512.S5DataListener
Will be called when values are changed in the datablock
But no changes at cpuNo, dbNo, firstWordNo and/or ammountWords.
s7StructureChanged(EventObject) - Method in interface de.rkjava.serial.rk512.S7DataListener
Will be called, when changes apears in cpuNo, dbNo, firstByteNo and/or ammountBytes
s7ValuesChanged(EventObject) - Method in interface de.rkjava.serial.rk512.S7DataListener
Will be called, when values are changed in the datablock
But no changes at cpuNo, dbNo, firstByteNo and/or ammountBytes.
send(long) - Method in class de.rkjava.serial.rk512.Rk512toPLC
This method sends the data from your S5Model/S7Model and puts it into the PLC.
sendAcknowledge(J3964REvent) - Method in interface de.rkjava.serial.j3964r.J3964RNextInDataListener
Will be called one time from sendData() of class J3964R, when the next new telegram followed the sending arrived
You will get the data of the arrived telegram with e.getBytes()
sendAcknowledge(J3964REvent) - Method in class de.rkjava.serial.rk512.Rk512toPLC
This method must be implemted for J3964RNextInDataListener, do not call it!
sendData(Byte[]) - Method in class de.rkjava.serial.j3964r.J3964R
Sends the data with 3964R-protocol to the serial interface.
sendData(Byte[], J3964RNextInDataListener) - Method in class de.rkjava.serial.j3964r.J3964R
Sends the data with 3964R-protocol to the serial interface
The J3964RNextInDataListener will be informed about the next incoming data one time.
serialEvent(SerialPortEvent) - Method in class de.rkjava.serial.j3964r.J3964R
Don't use this method
It will be use by javax.comm.SerialPortEventListener
setBit(int, int, boolean) - Method in class de.rkjava.serial.rk512.DefaultS5Model
Sets the value of a bit
setBit(int, int, boolean) - Method in class de.rkjava.serial.rk512.DefaultS7Model
Sets the value of a bit
setBytes(byte[]) - Method in class de.rkjava.serial.rk512.DefaultS7Model
 
setBytes(byte[]) - Method in interface de.rkjava.serial.rk512.S7Model
Sets new databytes
Attention: It must be valid: data.length = getAmmountbytes()
setMPI(String, boolean) - Static method in class de.rkjava.serial.rk512.Rk512toPLC
Tells the package whether you are using an RK512-MPI-Adapter at portName, like Helmholz-Adapter SSW7-RK512) or not.
setNewStructure(int, int, int, int) - Method in class de.rkjava.serial.rk512.DefaultS5Model
Sets a new structure.
setNewStructure(int, int, int, short[]) - Method in class de.rkjava.serial.rk512.DefaultS5Model
 
setNewStructure(int, int, int, int) - Method in class de.rkjava.serial.rk512.DefaultS7Model
Sets a new structure.
setNewStructure(int, int, int, int, byte[]) - Method in class de.rkjava.serial.rk512.DefaultS7Model
 
setNewStructure(int, int, int, short[]) - Method in interface de.rkjava.serial.rk512.S5Model
Sets a new structure together with new datawords
Every registered S5DataListener will be informed via s5StructureChanged()
setNewStructure(int, int, int, int, byte[]) - Method in interface de.rkjava.serial.rk512.S7Model
Sets a new structure together with new databytes.
setSpeed(int) - Method in class de.rkjava.serial.j3964r.J3964R
Sets the baudrate
setSpeed(int, int, int, int) - Method in class de.rkjava.serial.j3964r.J3964R
Sets the baudrate
setSpeed(String, int) - Static method in class de.rkjava.serial.rk512.Rk512toPLC
Sets the speed of your serial interface portName
setWords(short[]) - Method in class de.rkjava.serial.rk512.DefaultS5Model
 
setWords(short[]) - Method in interface de.rkjava.serial.rk512.S5Model
Sets new datawords
Attention: It must be valid: data.length = getAmmountWords()

T

TIMEOUT - Static variable in class de.rkjava.serial.rk512.Rk512toPLC
-10001
toString() - Method in class de.rkjava.serial.rk512.NoSuchPortException
 
toString() - Method in class de.rkjava.serial.rk512.PortInUseException
 
trace - Static variable in class de.rkjava.serial.j3964r.J3964R
Defaultvalue: false.
trace - Static variable in class de.rkjava.serial.rk512.Rk512toPLC
Defaultvalue: false

U

UnsupportedCommOperationException - exception de.rkjava.serial.rk512.UnsupportedCommOperationException.
 
UnsupportedCommOperationException() - Constructor for class de.rkjava.serial.rk512.UnsupportedCommOperationException
Creates new UnsupportedCommOperationException

Z

ZVZ - Static variable in class de.rkjava.serial.j3964r.J3964R
character delay time
Defaultvalue: 180ms.

A B C D E F G I J N O P Q R S T U Z
www.rkjava.de