stella.io

Class BeckhoffSwitch

java.lang.Object

util.PropertyContainer

util.PropertyResources

globals.parameter.AbstractParameter

globals.trigger.AbstractTrigger

globals.trigger.SimpleTrigger

io.AbstractSwitch

stella.io.BeckhoffSwitch

All Implemented Interfaces:

Parameter, Trigger, DriverDepending, Switch, Cloneable, ExitCleaning, Initializable, PropertySupplying, Reloadable, ResourceSupplying, Triggering

Direct Known Subclasses:

BeckhoffLight

public class BeckhoffSwitch
extends AbstractSwitch
implements DriverDepending, Reloadable

A class providing access to a ADS-enabled switch. This means the following:

• On construct, the name of the switch, the name of the ADS driver and the name of the variable for turning the switch are specified.
• In the properties of the underlying PollingBeckhoffServer, the PLC variable for this sensor must be included
• Setting the switch is done by passing a 1 byte to the variable name, turning off is obtained with writing 0.
• The parameter cluster must take care of registering the ADS-driver. For that, the switch implements the DriverDepending interface.
• Before registering of the driver, the switch is brought to a defined state given with the KEY_INITOFF key.
• Invoking the #turnOnTimeout method switches on, but switches off again after the stated period.

Note that this class should never be used directly.

Nested Class Summary

Nested classes/interfaces inherited from class util.PropertyResources

PropertyResources.Load, PropertyResources.URLResource

Field Summary

Fields

Modifier and Type	Field and Description
private PollingBeckhoffServer	ads The ADS server to send variable read/writes to.
private static boolean	DEFINITOFF The initial state of the switch.
static String	KEY_ADSDRIVER The name of the server to use.
static String	KEY_INITOFF The key defining initial off.
static String	KEY_PLCSWITCH The name of the PLC variable that allows switching.

Fields inherited from class globals.trigger.SimpleTrigger

KEY_INITBOOLEAN

Fields inherited from class globals.parameter.AbstractParameter

KEY_FORMAT, KEY_NAME, KEY_PRESERVE, UNKNOWN

Fields inherited from class util.PropertyResources

KEY_NOINITONCREATE, POSTFIX_ALPHABET, POSTFIX_BYTES, POSTFIX_DIR, POSTFIX_EXT, POSTFIX_FILE, POSTFIX_LIST, POSTFIX_MODTIME, POSTFIX_URL

Fields inherited from class util.PropertyContainer

KEY_LISTSEPARATOR, KEY_MAPKEYVALUECHAR, KEY_MAPSEPARATOR

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Fields inherited from interface util.ResourceSupplying

KEY_URLRESOURCES, KEY_URLUSECONFIG, KEY_URLUSECURRENT, KEY_URLUSEHOME

Constructor Summary

Constructors

Constructor and Description
BeckhoffSwitch(Map<String,String> prop) Constructs a new light switch trigger.

Method Summary

Modifier and Type	Method and Description
protected boolean	off() Turn the light off.
protected boolean	on() Turns the switch on.
boolean	registerDriver(Driver rs485) Registers the driver.
double	rescanned(String key, String old, String newval) As any parameter depending instance we fail if the parameter we depend on is now a different one.

Methods inherited from class io.AbstractSwitch

turnOff, turnOn

Methods inherited from class globals.trigger.SimpleTrigger

getLastToggleTime, getTrigger, init, setTrigger

Methods inherited from class globals.trigger.AbstractTrigger

get, getElapsedToggleTime, isTrue, set, toggleTrigger

Methods inherited from class globals.parameter.AbstractParameter

createParameter, delivers, exit, getFormatted, getFormatted, getName, getPreserveFile, getString, getString, overrideDefaultName, register, setName, toString

Methods inherited from class util.PropertyResources

clone, createFrom, createFrom, createFrom, createInstance, getApplet, getAsResources, getLocate, getPropertiesToKey, getPropertiesToKey, getResource, getResourceAsStream, getResourceFromKey, getResources, hasLocalURLs, initProperties, keyCreate, keyCreate, reload, setApplet

Methods inherited from class util.PropertyContainer

augment, augment, augment, augment, augment, 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, isNew, parseObject, parseObject, reload, removeProperty, requires, setObject, setProperties, setProperty, stringProperties

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface util.Reloadable

reload

Methods inherited from interface globals.Parameter

get, getFormatted, getName, getString, set

Methods inherited from interface util.PropertySupplying

defaultBoolean, defaultChar, defaultDouble, defaultFloat, defaultInt, defaultLong, defaultObject, defaultObject, defaultProperties, defaultProperty, getAsBoolean, getAsChar, getAsDouble, getAsFloat, getAsInt, getAsList, getAsLong, getAsMap, getAsObject, getAsObject, getProperties, getProperty, has, parseObject, removeProperty, setObject, setProperty, stringProperties

Methods inherited from interface util.Initializable

init

Methods inherited from interface util.Triggering

getElapsedToggleTime, getLastToggleTime, getTrigger, isTrue, setTrigger, toggleTrigger

Field Detail

KEY_ADSDRIVER

public static final String KEY_ADSDRIVER

The name of the server to use.

See Also:

Constant Field Values

KEY_PLCSWITCH

public static final String KEY_PLCSWITCH

The name of the PLC variable that allows switching.

See Also:

Constant Field Values

KEY_INITOFF

public static final String KEY_INITOFF

The key defining initial off.

See Also:

Constant Field Values

DEFINITOFF

private static final boolean DEFINITOFF

The initial state of the switch.

See Also:

Constant Field Values

ads

private transient PollingBeckhoffServer ads

The ADS server to send variable read/writes to.

Constructor Detail

BeckhoffSwitch

public BeckhoffSwitch(Map<String,String> prop)

Constructs a new light switch trigger. As a monitor for notification of cache-cahnged events, this trigger registers itself in the init section.
All additional properties have default values.

Method Detail

rescanned

public double rescanned(String key,
                        String old,
                        String newval)

As any parameter depending instance we fail if the parameter we depend on is now a different one.

Specified by:

rescanned in interface Reloadable

Overrides:

rescanned in class SimpleTrigger

registerDriver

public boolean registerDriver(Driver rs485)

Registers the driver. First, it is checked for instancy of PollingRS485Server. If so, it's name is check to match the #KEY_SERIAL name. If this, too, is fulfilled, the server is passed to the super-method, which does the necessary cache change registration. Additionally an instance of this server is stored locally to allow sending of commands to the serial server.

Specified by:

registerDriver in interface DriverDepending

Returns:

True if registering at the driver was successful.

on

protected boolean on()

Turns the switch on. Send the light-on command to the serial.

Specified by:

on in class AbstractSwitch

Returns:

True if successful.

off

protected boolean off()

Turn the light off. Sends the light-off command to the serial port.

Specified by:

off in class AbstractSwitch

Returns:

True if successful.