stella.roof

Class BeckhoffLight

java.lang.Object

util.PropertyContainer

util.PropertyResources

globals.parameter.AbstractParameter

globals.trigger.AbstractTrigger

globals.trigger.SimpleTrigger

io.AbstractSwitch

stella.io.BeckhoffSwitch

stella.roof.BeckhoffLight

All Implemented Interfaces:

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

public class BeckhoffLight
extends BeckhoffSwitch
implements ParameterDepending, CacheChangedListener

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

• On the RS485 bus there is a switch that registers two states: on and off. This switch is polled in a PollingRS485Server instance which is registered to the light switch on startup using the registerDriver(io.Driver) method.
• On the RS485 bus there is a relay that allows to switch the light on and off.
• The current observing conditions are known to the light switch. Normally, switching on the light is not allowed in weather-clear phases, except when manually invoked.
• If the RS485 bus switch is toggled, then the current observing conditions and the status of the KEY_ALLOWONCLEAR flag are checked. If weather conditions are clear and the KEY_ALLOWONCLEAR flag is false, the light is not switched on. Otherwise, it is turned on using a time-out of KEY_TIMEOUT.
• Manual switching of the light with the remote-accessible #switchOn, #switchOff, and the #switchOnTimeout methods is always allowed.

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	DEFALLOWONCLEAR The default allowance to switch on light during night.
static String	DEFNAME The default parameter name.
private static String	DEFREADPLC The default read switch string.
private static long	DEFTIMEOUT The default time out after witch light is turned off again.
private Trigger	forced Monitors forced switches.
static String	KEY_ALLOWONCLEAR If true, light may also be switched on during roof open.
static String	KEY_READPLC The key linked to the string sent to the serial port before reading.
static String	KEY_TIMEOUT The default time out for light switch off.
private Trigger	open The roof-open trigger.

Fields inherited from class stella.io.BeckhoffSwitch

KEY_ADSDRIVER, KEY_INITOFF, KEY_PLCSWITCH

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

Method Summary

Modifier and Type	Method and Description
void	init() Initializes the light switch.
void	newValue(CacheChangedEvent cce) First, get the current state of the trigger.
boolean	registerDriver(Driver server) Additionally registers the light switch as a cache-changed listener to the polling server.
void	registerParameter(Parameter roof) Registers the weather station.

Methods inherited from class stella.io.BeckhoffSwitch

off, on, rescanned

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_ALLOWONCLEAR

public static final String KEY_ALLOWONCLEAR

If true, light may also be switched on during roof open.

See Also:

Constant Field Values

KEY_TIMEOUT

public static final String KEY_TIMEOUT

The default time out for light switch off.

See Also:

Constant Field Values

KEY_READPLC

public static final String KEY_READPLC

The key linked to the string sent to the serial port before reading.

See Also:

Constant Field Values

DEFNAME

public static final String DEFNAME

The default parameter name.

See Also:

Constant Field Values

DEFREADPLC

private static final String DEFREADPLC

The default read switch string.

See Also:

Constant Field Values

DEFALLOWONCLEAR

private static final boolean DEFALLOWONCLEAR

The default allowance to switch on light during night.

See Also:

Constant Field Values

DEFTIMEOUT

private static final long DEFTIMEOUT

The default time out after witch light is turned off again.

See Also:

Constant Field Values

open

private Trigger open

The roof-open trigger.

forced

private Trigger forced

Monitors forced switches.

Constructor Detail

BeckhoffLight

public BeckhoffLight(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

init

public void init()
          throws InitException

Initializes the light switch.

Specified by:

init in interface Initializable

Overrides:

init in class SimpleTrigger

Throws:

InitException

registerDriver

public boolean registerDriver(Driver server)

Additionally registers the light switch as a cache-changed listener to the polling server.

Specified by:

registerDriver in interface DriverDepending

Overrides:

registerDriver in class BeckhoffSwitch

Returns:

True if registering at the driver was successful.

registerParameter

public void registerParameter(Parameter roof)

Registers the weather station. The station is queried for the current weather if we have a switch-signal to turn the light on. Only if the current weather conditions are bad, the light is turned on. This restriction can be overruled by setting the KEY_ALLOWONCLEAR to true. Note that direct switches of the light via the remote methods are not affected by the current weather.

Specified by:

registerParameter in interface ParameterDepending

newValue

public void newValue(CacheChangedEvent cce)

First, get the current state of the trigger. If the trigger value has changed, then switch the light

Specified by:

newValue in interface CacheChangedListener