stella.mxio

Class MoxaDigitalReadWrite

java.lang.Object

util.PropertyContainer

io.AbstractDriver

io.AbstractSimulatingDriver

stella.mxio.GenericMoxa

stella.mxio.MoxaDigitalReadWrite

All Implemented Interfaces:

Driver, Cloneable, EthReading, EthWriting, ExitCleaning, Initializable, Preserving, PropertySupplying, Simulating

public class MoxaDigitalReadWrite
extends GenericMoxa
implements EthWriting

Class to read the MOXA digital sensor E1210

Nested Class Summary

Nested classes/interfaces inherited from class stella.mxio.GenericMoxa

GenericMoxa.Mxiolib

Field Summary

Fields

Modifier and Type	Field and Description
private static long	DEFCACHETIME Default cache time of five seconds.
private static boolean	DEFPERSISTENT Default not persistent.
private static int	DEFREADCHANNELS Default 8 channels to read.
private static int	DEFWRITECHANNELS Default 8 channels to write.
static String	KEY_CACHETIME The life-time of the read cache.
static String	KEY_INITWRITE If set, we write this integer at startup.
static String	KEY_PERSISTENT If true, connection is held open after first open.
static String	KEY_READCHANNELS The number of digital ports to read simultaneously.
static String	KEY_WRITECHANNELS The number of digital port to write simultaneously.
private long	lastread The time of the last read.
private long	lastwrite The time of the last read.
private Integer	readcache The last result used for caching.
private Integer	writecache The last result used for caching.

Fields inherited from class stella.mxio.GenericMoxa

INVALID, KEY_MOXAIP, KEY_MOXAPASSWORD, KEY_MOXAPORT, KEY_MOXATIMEOUT, LIBSYS

Fields inherited from class io.AbstractSimulatingDriver

KEY_KEEPCOMMANDTIMES

Fields inherited from class io.AbstractDriver

KEY_DRIVERNAME

Fields inherited from class util.PropertyContainer

KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface stella.mxio.EthReading

CHANNEL_OUT_OF_RANGE, COIL_TYPE_ERROR, CREATE_MUTEX_FAIL, EIO_CREATING_SOCKET_ERROR, EIO_INIT_SOCKETS_FAIL, EIO_PASSWORD_INCORRECT, EIO_RESPONSE_BAD, EIO_SOCKET_DISCONNECT, EIO_TIME_OUT, FIRMWARE_NOT_SUPPORT, FUNCTION_NOT_SUPPORT, HANDLE_ERROR, ILLEGAL_DATA_ADDRESS, ILLEGAL_DATA_VALUE, ILLEGAL_FUNCTION, INPUT_VALUE_OUT_OF_RANGE, MXIO_OK, OUTPUT_VALUE_OUT_OF_RANGE, PRODUCT_NOT_SUPPORT, PROTOCOL_TYPE_ERROR, REGISTER_TYPE_ERROR, SIO_BAUDRATE_NOT_SUPPORT, SIO_CLEAR_COMM_FAIL, SIO_CLOSE_FAIL, SIO_FLUSH_FILE_BUFFERS_FAIL, SIO_GET_COMM_STATE_FAIL, SIO_OPEN_FAIL, SIO_PURGE_COMM_FAIL, SIO_RESPONSE_BAD, SIO_SET_COMM_STATE_FAIL, SIO_SET_COMM_TIME_OUT_FAIL, SIO_SETUP_COMM_FAIL, SIO_TIME_OUT, SIO_TRANSMISSION_MODE_ERROR, SLAVE_DEVICE_BUSY, SLAVE_DEVICE_FAILURE, SLOT_NOT_EXIST, SLOT_OUT_OF_RANGE

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Constructor Summary

Constructors

Constructor and Description
MoxaDigitalReadWrite(Map<String,String> prop) Defaults the number of channels.

Method Summary

Modifier and Type	Method and Description
protected Number	extractFromCache(Integer cache, int nr) This method expects the cache to be an Integer.
long	getLastWrite()
void	init() If no explicit name is set, we use the IP-address as a driver name.
Number	readChannel(int nr) This method reads a channel number and returns the result as a double or an Integer.
protected Integer	readMoxa() This method reads a DWORD as an int and stores the 16 bits as a single number.
Number	writeChannel(int nr, boolean on) Sets the channel number to neither on (true) or off.

Methods inherited from class stella.mxio.GenericMoxa

close, getError, getHandle, isOpen, open, readAnalogIn, readDigitalIn, readDigitalOut, readTemps, writeDigitalOut

Methods inherited from class io.AbstractSimulatingDriver

accelerate, addCommandTime, exit, getAcceleration, getCommandTimeAverage, getCommandTimeRandomSample, getCommandTimeSigma, getSimulationStart, isSimulate, preserve, restore, simulateSince, startSimulate, stopSimulate

Methods inherited from class io.AbstractDriver

createDriver, equals, getDriverName, hashCode

Methods inherited from class util.PropertyContainer

augment, augment, augment, augment, augment, clone, defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsEnums, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, initProperties, isNew, parseObject, parseObject, reload, reload, removeProperty, requires, rescanned, setObject, setProperties, setProperty, stringProperties, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.Driver

close, getDriverName, isOpen, open

Field Detail

KEY_READCHANNELS

public static final String KEY_READCHANNELS

The number of digital ports to read simultaneously.

See Also:

Constant Field Values

KEY_WRITECHANNELS

public static final String KEY_WRITECHANNELS

The number of digital port to write simultaneously.

See Also:

Constant Field Values

KEY_INITWRITE

public static final String KEY_INITWRITE

If set, we write this integer at startup.

See Also:

Constant Field Values

KEY_CACHETIME

public static final String KEY_CACHETIME

The life-time of the read cache.

See Also:

Constant Field Values

KEY_PERSISTENT

public static final String KEY_PERSISTENT

If true, connection is held open after first open.

See Also:

Constant Field Values

DEFCACHETIME

private static final long DEFCACHETIME

Default cache time of five seconds. Should be longer than timeout

See Also:

Constant Field Values

DEFPERSISTENT

private static final boolean DEFPERSISTENT

Default not persistent.

See Also:

Constant Field Values

DEFREADCHANNELS

private static final int DEFREADCHANNELS

Default 8 channels to read.

See Also:

Constant Field Values

DEFWRITECHANNELS

private static final int DEFWRITECHANNELS

Default 8 channels to write.

See Also:

Constant Field Values

lastread

private long lastread

The time of the last read.

readcache

private Integer readcache

The last result used for caching.

lastwrite

private long lastwrite

The time of the last read.

writecache

private Integer writecache

The last result used for caching.

Constructor Detail

MoxaDigitalReadWrite

public MoxaDigitalReadWrite(Map<String,String> prop)

Defaults the number of channels.

Method Detail

init

public void init()
          throws InitException

Description copied from class: GenericMoxa

If no explicit name is set, we use the IP-address as a driver name.

Specified by:

init in interface Initializable

Overrides:

init in class GenericMoxa

Throws:

InitException

getLastWrite

public long getLastWrite()

readMoxa

protected Integer readMoxa()
                    throws IOException

This method reads a DWORD as an int and stores the 16 bits as a single number.

Throws:

IOException

extractFromCache

protected Number extractFromCache(Integer cache,
                                  int nr)

This method expects the cache to be an Integer. We raise 0x01 to the power of the number and return the AND value of this mask with the cahce.

writeChannel

public Number writeChannel(int nr,
                           boolean on)
                    throws IOException

Description copied from interface: EthWriting

Sets the channel number to neither on (true) or off.

Specified by:

writeChannel in interface EthWriting

Parameters:

nr - The bit to set

on - If true, we switch on, else off.

Returns:

The combined channels

Throws:

IOException

readChannel

public Number readChannel(int nr)
                   throws IOException

Description copied from interface: EthReading

This method reads a channel number and returns the result as a double or an Integer.

Specified by:

readChannel in interface EthReading

Throws:

IOException