stella.environment

Class EnvironmentMaster

java.lang.Object

util.PropertyContainer

util.PropertyResources

util.rmi.RmiPropertyContainer

util.rmi.AbstractRmiListener

stella.rmi.AbstractRmiCasterAndListener

stella.rmi.ReceiverTorso

stella.rmi.GenericMaster

stella.environment.ShelterMaster

stella.environment.EnvironmentMaster

All Implemented Interfaces:

Cloneable, Remote, EventListener, Caster, ErrorSending, ErrorCaster, CacheChangedListener, Alive, BuildingControlling, ListenerControlling, RmiAcknowledgeCaster, RmiCommandListener, RmiDoneCaster, RmiErrorCaster, RmiParameterClustering, ShelterControlling, AlarmHandler, WeatherListener, ExitCleaning, PropertySupplying, Reloadable, ResourceSupplying, RmiCaster, RmiEventListener, RmiListener, RmiPropertyBearing, TriggerableReload, StepInitializable

public final class EnvironmentMaster
extends ShelterMaster
implements BuildingControlling, CacheChangedListener, Reloadable

The master program running at the environment control. It comprises roof control and a weather station. The environment master is not directly controling the weather station or the roof but merely acts as a high-level control device and speaks to the waether station via the WeatherSurveying interface and to the roof via the RoofOperating interface. Since version 1.1 also the command handling abilities (RmiCommandListener, RmiAcknowledgeCaster and RmiDoneCaster) are embedded within the environment master rather than within the roof receiver. To allow remote control of the environment this class supports building control via the BuildingControlling interface. This interface allows the remote registering and deregistering of command casters and can thus be used to change the roof mode between automatic, when the command caster is the SCS, and manual, when the registered command caster is a launch box.

The principal idea is that the roof may only have a single driver object registered to itself, while the weather station can get an entire list of driveres, all registered sequentially by calls to the weather station's WeatherSurveying.registerSensorDriver(io.Driver) method. For implementations where the weather station and the roof control uses the same hardware for reading sensors and operating relays, a common driver can be used if the #KEY_COMMONDRIVER is present. In this case, this single driver is constructed and initialized once and then registered at both, the roof operator and the weather surveyer. If this key is not set, the ShelterMaster.KEY_WEATHERDRIVER and the #KEY_ROOFDRIVER are used to specify two different drivers for the roof operator (single driver only) and the weather surveyer (can be a list of drivers), respectively.
If the host is booted and the environment master is started for the first time, the GenericMaster.KEY_AUTOMATIC key determines whether automatic roof control is immediately enabled: If this property is true the environment master tries to register at the #KEY_ENVIRONMENTCASTER as a command listener immediately after startup, otherwise no command caster is registered at. If the environment master starts up in manual mode the #KEY_STARTUPROOF is read and the actual position of the roof is compared to the desired position. Possible values of #KEY_STARTUPROOF are: close to close the roof if found open at boot, open to open the roof if found close, indifferent if the roof should be left in whatever state encountered. See also #ROOF_OPEN, #ROOF_CLOSE, and #ROOF_INDIFFERENT.
If the weather station is hosted on the same machine as the roof control it may be advisable to directly link bad-weather events to a close-roof command, in case of lost connection to the SCS. If this behaviour is desired, the ShelterMaster.KEY_DIRECTCLOSE key should point to true. For direct opening, the ShelterMaster.KEY_DIRECTOPEN may be used. Note that direct linking is only enabled in automatic mode.
Note that the ReceiverTorso.KEY_BIND-key only determines if the environment master should nail its building control ability to the rmi-registry. The binding of the weather station and of the roof receiver is determined within their own property files.

Nested Class Summary

Nested classes/interfaces inherited from class stella.rmi.GenericMaster

GenericMaster.Standalone

Nested classes/interfaces inherited from class stella.rmi.ReceiverTorso

ReceiverTorso.CommandHandler

Nested classes/interfaces inherited from class util.PropertyResources

PropertyResources.Load, PropertyResources.URLResource

Field Summary

Fields

Modifier and Type	Field and Description
private List<String>	cachelist A list of all cache values we should register to.
private static boolean	DEFBIND The default binding behavior of the building control.
private static String	DEFBINDNAME The default binding name of the environment master.
private static long	DEFCLOSETIME The default timeout on total close, 5min.
private static String	DEFLIGHTSWITCH The default name of the light switch.
private static long	DEFNIGHTTIME The default minimum remaining night time.
private static long	DEFOPENTIME The default timeout on total open, 5min.
private static long	DEFPOWERTIME The default power switching time, 5 sec.
private static long	DEFRESETTIME The default limit switch reset time, 5 sec.
private static String	DEFROOFINFO The default pollerkeys to listen to for roof info.
static String	KEY_POWERTIME The key for the time required for power chances.
static String	KEY_RESETTIME The key for the time required for limit switch resets.
static String	KEY_ROOFINFO The poller-cache keys to the roof info.
private PollingRS485Server	roofrs485 The RS485-server delivering cache-changed events.

Fields inherited from class stella.environment.ShelterMaster

KEY_CHECK, KEY_CHECKINTERVALL, KEY_CLOSESHELTER, KEY_CLOSETIME, KEY_DIRECTCLOSE, KEY_DIRECTOPEN, KEY_LIGHTSWITCH, KEY_NIGHTREMAIN, KEY_NIGHTTIME, KEY_OPENSHELTER, KEY_OPENTIME, KEY_SHELTER, KEY_SHELTERDRIVER, KEY_STARTUPSHELTER, KEY_WEATHER, KEY_WEATHERDRIVER, shelter, SHELTER_CLOSE, SHELTER_INDIFFERENT, SHELTER_OPEN

Fields inherited from class stella.rmi.GenericMaster

DEFUNIQUE, KEY_ABORTTIME, KEY_AUTOMATIC, KEY_COMMTIME, KEY_COMMUNICATOR, KEY_DRIVERS, KEY_HISTORYDB, KEY_INITTIME, KEY_NODB, KEY_OBSERVEDB, KEY_OVERRULEAUTO, KEY_PARKTIME, KEY_PERMISSIONDB, KEY_PROPOSALDB, KEY_QUITTIME, KEY_REAUTO, KEY_SET, KEY_SHUTDOWNDELAY, KEY_STATUSTIME, KEY_TARGETDB, KEY_TASKDB, KEY_UNIQUE, KEY_USERDB, lastabort, lastinit, lastpark, lastreset, telescope

Fields inherited from class stella.rmi.ReceiverTorso

KEY_BIND, KEY_BINDNAME, KEY_COMMANDCASTER, KEY_ERRORCOOL

Fields inherited from class util.rmi.AbstractRmiListener

KEY_ALIVE, KEY_EXPORTPORT, KEY_INIT, KEY_LISTENERNAME, KEY_RETRY, KEY_RETRYSLEEP

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 stella.rmi.RmiAcknowledgeCaster

NAMING_EXTENSION

Fields inherited from interface stella.rmi.RmiDoneCaster

NAMING_EXTENSION

Fields inherited from interface util.StepInitializable

KEY_INITDEPTH

Fields inherited from interface util.ResourceSupplying

KEY_URLRESOURCES, KEY_URLUSECONFIG, KEY_URLUSECURRENT, KEY_URLUSEHOME

Fields inherited from interface util.PropertySupplying

CONFIG, KEY_CLASS

Constructor Summary

Constructors

Constructor and Description
EnvironmentMaster(Map<String,String> prop) Constructs a new environment master.

Method Summary

Modifier and Type	Method and Description
boolean	automatic() Enables automatic roof operation.
boolean	closeLeft() Closes the left roof if in manual mode.
boolean	closeRight() Closes the right roof if in manual mode.
protected int	getAcknowledgeNumber(CommandEvent cmd) Returns the number of acknowledge events produced for each command.
protected long	getCompletionTime(CommandEvent cmd, int acknr) Returns the individual completion times.
protected ErrorEvent	getLastError(CommandEvent cmd) Returns the last error event generated during a command subroutine.
private void	init2a() Third init step.
protected boolean	initializeMaster(CommandEvent cmd) Initializes the environment.
void	initStep(int curstep) The initializing section.
static void	main(String[] arg) Starts the environment master with the given properties.
boolean	manual() Disables automatic roof operation.
void	newValue(CacheChangedEvent cce) Signals that the cache value linked to one of the roof info modules has changed its value.
boolean	openLeft() Opens the left roof if in manual mode.
boolean	openRight() Opens the left roof if in manual mode.
protected boolean	parkMaster(CommandEvent cmd) Parks the environment, first part.
boolean	powerOff() Powers down the roof if in manual mode.
boolean	powerOn() Powers up the roof if in manual mode.
protected boolean	processCommand(CommandEvent cmd, int acknr) Process the command.
double	rescanned(String key, String old, String newval) On reload, we throw an exception if the driver changed, but not if the configuration of the driver changed.
protected boolean	resetMaster(CommandEvent cmd) Resets the environment.
void	shutdownWatchdogs() Disables watchdogs in all drivers if they are subclasses of WatchdogRS485Server.

Methods inherited from class stella.environment.ShelterMaster

accepts, close, direct, exit, open, quit, reload, setDirectClose, setDirectOpen, statusMaster, weatherChanged

Methods inherited from class stella.rmi.GenericMaster

abortMaster, addErrorListener, addRmiErrorListener, createCommunicator, createCommunicator, external, formatWithGlobals, getAllDrivers, getDriver, getHistorySql, getObserveSql, getOffsetCaster, getParameterByKey, getParameterByName, getParameterCluster, getParameterValueByKey, getParameterValueByName, getPermissionSql, getProposalSql, getStatus, getTargetSql, getTaskSql, getUnique, getUniqueId, getUserSql, initialize, isAlive, isAuto, isManual, isPassive, park, quitMaster, reset, resetAlarm, resetAllDrivers, restartAllDrivers, revert, rmiAddParameter, rmiCommand, rmiGet, rmiGetAllParameterNames, rmiRemoveParameter, rmiSet, setLastError, setOff, setParameterValueByKey, setParameterValueByName, setPassive, shutdown, zeroAllOmc

Methods inherited from class stella.rmi.ReceiverTorso

addRmiAcknowledgeListener, addRmiDoneListener, bindDefault, containsRemoteProperty, deregisterAtCaster, equals, getRemoteProperties, getRemoteProperty, hashCode, notifyAcknowledgeListener, notifyDoneListener, registerAtCaster, removeRmiAcknowledgeListener, removeRmiDoneListener, sendAllPrematureDone, sendPrematureDone, setRemoteProperty, toString, unbindDefault

Methods inherited from class stella.rmi.AbstractRmiCasterAndListener

bindToRegistry, getBindName, isValid, notifyErrorListener, removeErrorListener, removeRmiErrorListener, sendError, sendError, sendError, sendStatus, sendStatus, sendStatus, unbindFromRegistry

Methods inherited from class util.rmi.AbstractRmiListener

allBound, blockBinding, blockBinding, disconnect, getIP, getListenerName, isConnected, listenerName, releaseBinding, releaseBinding, startBinding, startBinding

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, removeProperty, requires, setObject, setProperties, setProperty, stringProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface stella.rmi.ShelterControlling

close, open, quit, setDirectClose, setDirectOpen

Methods inherited from interface stella.rmi.ListenerControlling

external, getStatus, initialize, park, reset, setPassive

Methods inherited from interface util.Reloadable

reload

Methods inherited from interface util.rmi.RmiCaster

bindToRegistry, isValid, unbindFromRegistry

Methods inherited from interface stella.ErrorCaster

removeErrorListener

Methods inherited from interface util.rmi.RmiEventListener

getListenerName

Methods inherited from interface util.rmi.RmiListener

disconnect, isConnected

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

Field Detail

KEY_POWERTIME

public static final String KEY_POWERTIME

The key for the time required for power chances.

See Also:

Constant Field Values

KEY_RESETTIME

public static final String KEY_RESETTIME

The key for the time required for limit switch resets.

See Also:

Constant Field Values

KEY_ROOFINFO

public static final String KEY_ROOFINFO

The poller-cache keys to the roof info. Register as listener.

See Also:

Constant Field Values

DEFBIND

private static final boolean DEFBIND

The default binding behavior of the building control.

See Also:

Constant Field Values

DEFBINDNAME

private static final String DEFBINDNAME

The default binding name of the environment master.

See Also:

Constant Field Values

DEFROOFINFO

private static final String DEFROOFINFO

The default pollerkeys to listen to for roof info. Order is important.

See Also:

Constant Field Values

DEFNIGHTTIME

private static final long DEFNIGHTTIME

The default minimum remaining night time.

See Also:

Constant Field Values

DEFOPENTIME

private static final long DEFOPENTIME

The default timeout on total open, 5min.

See Also:

Constant Field Values

DEFCLOSETIME

private static final long DEFCLOSETIME

The default timeout on total close, 5min.

See Also:

Constant Field Values

DEFPOWERTIME

private static final long DEFPOWERTIME

The default power switching time, 5 sec.

See Also:

Constant Field Values

DEFRESETTIME

private static final long DEFRESETTIME

The default limit switch reset time, 5 sec.

See Also:

Constant Field Values

DEFLIGHTSWITCH

private static final String DEFLIGHTSWITCH

The default name of the light switch.

See Also:

Constant Field Values

roofrs485

private PollingRS485Server roofrs485

The RS485-server delivering cache-changed events.

cachelist

private List<String> cachelist

A list of all cache values we should register to.

Constructor Detail

EnvironmentMaster

public EnvironmentMaster(Map<String,String> prop)
                  throws RemoteException

Constructs a new environment master. Sets default values for the properties if not given. Initializing of the helper classes is done in the #init method. As common in final, rmi-enabled classes, the environment master calls exportObject on the UnicastRemoteObject server class.

Throws:

RemoteException

Method Detail

initStep

public void initStep(int curstep)
              throws InitException

The initializing section. Only called after construction. In this method, the weather surveyer and the roof operator along with their drivers are initialized. The environment master binding to the registry and the determination of the roof control mode and the initial roof status is also done here.

Specified by:

initStep in interface StepInitializable

Overrides:

initStep in class ShelterMaster

Throws:

InitException

init2a

private void init2a()

Third init step.

rescanned

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

On reload, we throw an exception if the driver changed, but not if the configuration of the driver changed.

Specified by:

rescanned in interface Reloadable

Overrides:

rescanned in class GenericMaster

newValue

public void newValue(CacheChangedEvent cce)

Signals that the cache value linked to one of the roof info modules has changed its value. The environment master wrappes the value into a status event, indicating the roof number (derived from the index of the cache key in the cachelist) and the new value of the cache. Receivers can catch these status events and use them to e.g. update an stella.jview.JRoofView display.

Specified by:

newValue in interface CacheChangedListener

openLeft

public boolean openLeft()
                 throws RemoteException

Opens the left roof if in manual mode. Directly invokes the RoofOperating.openLeft() method.

Specified by:

openLeft in interface BuildingControlling

Returns:

True if opening was successful.

Throws:

RemoteException

openRight

public boolean openRight()
                  throws RemoteException

Opens the left roof if in manual mode. Directly invokes the RoofOperating.openRight() method.

Specified by:

openRight in interface BuildingControlling

Returns:

True if opening was successful.

Throws:

RemoteException

closeRight

public boolean closeRight()
                   throws RemoteException

Closes the right roof if in manual mode. Directly invokes the RoofOperating.closeRight() method.

Specified by:

closeRight in interface BuildingControlling

Returns:

True if closing was successful.

Throws:

RemoteException

closeLeft

public boolean closeLeft()
                  throws RemoteException

Closes the left roof if in manual mode. Directly invokes the RoofOperating.closeLeft() method.

Specified by:

closeLeft in interface BuildingControlling

Returns:

True if closing was successful.

Throws:

RemoteException

powerOn

public boolean powerOn()
                throws RemoteException

Powers up the roof if in manual mode. Directly invokes the RoofOperating.powerOn() method.

Specified by:

powerOn in interface BuildingControlling

Returns:

True if power-up was successful.

Throws:

RemoteException

powerOff

public boolean powerOff()
                 throws RemoteException

Powers down the roof if in manual mode. Directly invokes the RoofOperating.powerOff() method.

Specified by:

powerOff in interface BuildingControlling

Returns:

True if power-down was successful.

Throws:

RemoteException

automatic

public boolean automatic()
                  throws RemoteException

Enables automatic roof operation. This method calls the #registerAt method with the default command caster as an argument. Additionally, an automatic flag is set, which is used if direct bad-weather reaction is intended. If the roof driver has watchdogs, they are enabled on automatic mode.

Specified by:

automatic in interface ListenerControlling

Overrides:

automatic in class ShelterMaster

Returns:

True if automatic mode was attained.

Throws:

RemoteException

manual

public boolean manual()
               throws RemoteException

Disables automatic roof operation. This method calls the #deregisterAt method with the default command caster as an argument. Additionally, the automatic flag is unset, which is used if direct bad-weather reaction is intended. If the roof driver has watchdogs, they are reset on manual mode.

Specified by:

manual in interface ListenerControlling

Overrides:

manual in class ShelterMaster

Returns:

True if manual mode was attained.

Throws:

RemoteException

shutdownWatchdogs

public void shutdownWatchdogs()
                       throws RemoteException

Disables watchdogs in all drivers if they are subclasses of WatchdogRS485Server. This happens automatically during ShelterMaster.quit() if the WatchdogRS485Server.KEY_RESETONCLOSE property points to true. Different to manual action, this method resets all watchdogs on any driver, not only the roof driver.

Specified by:

shutdownWatchdogs in interface BuildingControlling

Throws:

RemoteException

getAcknowledgeNumber

protected int getAcknowledgeNumber(CommandEvent cmd)

Returns the number of acknowledge events produced for each command. If the command is unknown an IllegalArgumentException is thrown.

Overrides:

getAcknowledgeNumber in class ShelterMaster

getCompletionTime

protected long getCompletionTime(CommandEvent cmd,
                                 int acknr)

Returns the individual completion times. If the command is unknown an IllegalArgumentException is thrown.

Overrides:

getCompletionTime in class ShelterMaster

Parameters:

cmd - The command to process.

acknr - The number of the acknowledge that will be sent back.

getLastError

protected ErrorEvent getLastError(CommandEvent cmd)

Returns the last error event generated during a command subroutine. Because all commands accepted (and that can produce errors) are piped to the roof operator, only this error message is fetched.

Overrides:

getLastError in class ReceiverTorso

processCommand

protected boolean processCommand(CommandEvent cmd,
                                 int acknr)

Process the command. Except the status command, only roof commands are treated by the environment, as of current writing. Therefore, all commands call the appropriate methods in the RoofOperating instance only.

Overrides:

processCommand in class ShelterMaster

resetMaster

protected boolean resetMaster(CommandEvent cmd)

Resets the environment.

Specified by:

resetMaster in class GenericMaster

Parameters:

cmd - Non-null in automatic mode.

parkMaster

protected boolean parkMaster(CommandEvent cmd)

Parks the environment, first part. Roofs are closed.

Specified by:

parkMaster in class GenericMaster

Parameters:

cmd - Non-null in automatic mode.

initializeMaster

protected boolean initializeMaster(CommandEvent cmd)

Initializes the environment.

Specified by:

initializeMaster in class GenericMaster

Parameters:

cmd - Non-null in automatic mode.

main

public static void main(String[] arg)
                 throws RemoteException

Starts the environment master with the given properties. Does not check for a running instance, thus starting the environment master multiple times may cause problems.

Throws:

RemoteException