stella.io

Class OneWireSwitch

java.lang.Object

util.PropertyContainer

util.PropertyResources

globals.parameter.AbstractParameter

globals.trigger.AbstractTrigger

globals.trigger.SimpleTrigger

io.AbstractSwitch

stella.io.OneWireSwitch

All Implemented Interfaces:

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

public class OneWireSwitch
extends AbstractSwitch
implements DriverDepending, Reloadable

A class providing access to a one-wire switch. This means the following:

• On construct, the name of the switch, the name of the one-wire server and the bit representing the switch are specified.
• On init, the switch binds to the registry, if #KEY_BIND is true.
• The parameter cluster must take care of registering the One-wire driver. For that, the switch implements the DriverDepending interface.
• During registering of the serial server, the switch is brought to a defined state given with the KEY_INITOFF key.

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 static boolean	DEFINITOFF The initial state of the switch.
private static String	DEFSWITCHOFF The default switch on command.
private static String	DEFSWITCHON The default switch on command.
static String	KEY_INITOFF The key defining initial off.
static String	KEY_ONEWIRE The name of the one-wire driver to use.
static String	KEY_PATH The path to the switch board plus channel, e.g '/12.(add)/PIO.A'.
static String	KEY_SWITCHOFF The string to switch the 1-wire chanel off.
static String	KEY_SWITCHON The string to switch the 1-wire chanel on.
private OneWireDriver	serial The serial server to send commands to.

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
OneWireSwitch(Map prop) Constructs a new light switch trigger.

Method Summary

Modifier and Type	Method and Description
void	init() Initializes the one wire switch switch.
protected boolean	off() Turn the light off.
protected boolean	on() Turns the switch on.
String	readSwitch() Reads the switch.
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, 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.Triggering

getElapsedToggleTime, getLastToggleTime, getTrigger, isTrue, setTrigger, toggleTrigger

Field Detail

KEY_ONEWIRE

public static final String KEY_ONEWIRE

The name of the one-wire driver to use.

See Also:

Constant Field Values

KEY_PATH

public static final String KEY_PATH

The path to the switch board plus channel, e.g '/12.(add)/PIO.A'.

See Also:

Constant Field Values

KEY_SWITCHON

public static final String KEY_SWITCHON

The string to switch the 1-wire chanel on. Noramlly '1'.

See Also:

Constant Field Values

KEY_SWITCHOFF

public static final String KEY_SWITCHOFF

The string to switch the 1-wire chanel off. Noramlly '0'.

See Also:

Constant Field Values

KEY_INITOFF

public static final String KEY_INITOFF

The key defining initial off.

See Also:

Constant Field Values

DEFSWITCHON

private static final String DEFSWITCHON

The default switch on command.

See Also:

Constant Field Values

DEFSWITCHOFF

private static final String DEFSWITCHOFF

The default switch on command.

See Also:

Constant Field Values

DEFINITOFF

private static final boolean DEFINITOFF

The initial state of the switch.

See Also:

Constant Field Values

serial

private OneWireDriver serial

The serial server to send commands to.

Constructor Detail

OneWireSwitch

public OneWireSwitch(Map 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

init

public void init()
          throws InitException

Initializes the one wire switch switch. If the timer class is null, it is defined here.

Specified by:

init in interface Initializable

Overrides:

init in class SimpleTrigger

Throws:

InitException

registerDriver

public boolean registerDriver(Driver rs485)

Registers the driver. First, it is checked for instancy of OneWireDriver. If so, it's name is check to match the KEY_ONEWIRE name. If this, too, is fulfilled, 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. First, we read the state of the switch. If it is not on, we switch it to on. Note that this always reads the true state of the switch and does not relie on the internal trigger state as other programs may have manipulated the switch.

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.

readSwitch

public String readSwitch()

Reads the switch.