BeckhoffRainSensor

java.lang.Object
- util.PropertyContainer
- - util.PropertyResources
  - - util.rmi.RmiPropertyContainer
    - - util.rmi.AbstractRmiCaster
      - stella.sensor.AbstractSensor
        
        stella.sensor.BeckhoffRainSensor

All Implemented Interfaces:

DriverDepending, Cloneable, Remote, EventListener, Caster, DataCaster, CacheChangedListener, RmiDataCaster, RmiErrorCaster, Telemetering, WeatherJudging, WeatherCaster, ExitCleaning, Initializable, PropertySupplying, ResourceSupplying, RmiCaster, RmiPropertyBearing
```
public class BeckhoffRainSensor
extends AbstractSensor
implements DataCaster, RmiDataCaster, WeatherCaster, WeatherJudging, CacheChangedListener, DriverDepending
```
This sensor has no retardation in case of bad weather. A representation of a digital rain sensor. This sensor does not deliver a value like 'number of raindrops' but provides a simple yes/no decision.
This class does not extend the WeatherSensor class but is a thread-less sensor. It acts as a cache listener and is therefore more immediate in its response. Additionally, as immediate response is always intended, no retardation time in case of bad-weather events (i.e. rain) is implemented.
This sensor is based on a Beckhoff PLC module.
On 2014, 21th Oct, 13:10 UTC, the digital measurements had been replaced by analog ones, 0.0175 corresponding roughly to digital 1.
This class was introduced in 2017 and works with the Adolf Thiess rain guard sensors.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`BeckhoffRainSensor.DigitalRainConversion`
`private class`	`BeckhoffRainSensor.RainTimerTask` The timer task used for notification of good weather.

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 Timer`	`data` The timer bound to data-event generating and weather reports.
`private List<DataListener>`	`datalist` The registered data-listeners.
`private static long`	`DEFDATARATE` The default read channel.
`private static DecimalFormat`	`DEFFORMAT` The format string for value and raw reading.
`private static boolean`	`DEFINVERSE` The default inverse property.
`private static long`	`DEFRETARD` The default retard time for changes to good weather.
`private static String`	`DEFUNIT` The unit string of the rain sensor.
`private NumberFormat`	`format` The raw and value formatter.
`private Triggering`	`goodweather` The weather toggle.
`static String`	`KEY_ADSDRIVER` The name of the server to use.
`static String`	`KEY_DATARATE` The key linked to the data-event generating rate.
`static String`	`KEY_FORMAT` The key to the value formatter.
`static String`	`KEY_INVERSE` The key defining if good weather inverses the toggle value.
`static String`	`KEY_PLCREAD` The key linked to the channel-read command of the Nudam module.
`static String`	`KEY_RETARD` The key pointing to a retard time for weather changes bad->good.
`static String`	`KEY_UNIT` The key to the 'unit' of the digital reain sensor.
`private Date`	`lastchange` The last cache-changed event received date.
`private Boolean`	`lastread` The last cache-changed event, value key.
`private List<RmiDataListener>`	`rdatalist` The registered data-listeners.
`private BeckhoffRainSensor.RainTimerTask`	`retard` The timer task for good-weather retards.
`private List<WeatherListener>`	`weatherlist` The registered weather-listeners.

Fields inherited from class stella.sensor.AbstractSensor
KEY_BIND, KEY_BINDNAME, KEY_CONVERT, KEY_DESCRIPTION, KEY_SENSORNAME

Fields inherited from class util.rmi.AbstractRmiCaster
ALTERNATEHOST, ALTERNATEPORT, KEY_EXPORTPORT, KEY_REGISTRYHOST, KEY_REGISTRYPORT

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.RmiDataCaster
NAMING_EXTENSION

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

BeckhoffRainSensor(Map<String,String> prop)
Constructs a new RS485 sensor.

Constructors
Constructor and Description
`BeckhoffRainSensor(Map<String,String> prop)` Constructs a new RS485 sensor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDataListener(DataListener ear)` Adds a `DataListener` to the registered listeners.
`void`	`addRmiDataListener(RmiDataListener ear)` Adds a `DataListener` to the registered listeners.
`void`	`addWeatherListener(WeatherListener ear)` Adds a `WeatherListener` to the registered listeners.
`void`	`cancel()` Cancels the rain sensor.
`boolean`	`currentlyClear()` The main functionality of the rain sensor is to act as a weather sensor.
`boolean`	`currentlyRetarding()` Returns true, if we were bad and still recovering.
`void`	`exit()` Exists the rain sensor.
`long`	`getMinClearUpTime()` Estimates bad time.
`double`	`getReading()` Reads the sensor value.
`String`	`getSensorInitInfo()` Returns a string description of the sensor.
`Date`	`getTimeOfRead()` Returns the date of the last received cache-changed event.
`void`	`init()` Initializes the sensor.
`void`	`newValue(CacheChangedEvent cce)` Indicates a new cache-reading on the rain sensor.
`protected void`	`notifyDataListener(DataEvent de)` Parses through the list of registered weather listeners and passes the argumental weather event to all of them.
`protected void`	`notifyWeatherListener(WeatherEvent we)` Parses through the list of registered weather listeners and passes the argumental weather event to all of them.
`boolean`	`registerDriver(Driver poller)` Registers the serial server to this sensor.
`void`	`removeDataListener(DataListener ear)` Removes a `DataListener` from the registered listeners.
`void`	`removeRmiDataListener(RmiDataListener ear)` Removes a `DataListener` from the registered listeners.
`void`	`removeWeatherListener(WeatherListener ear)` Removes a `WeatherListener` from the registered listeners.
`private double`	`retrieveValue(Boolean read)` Converts the input string into a sensor value.
`String`	`status()` The current status of the rain sensor.
`boolean`	`validReading()` The rain sensor is valid if the polling server was able to read the last rain-sensor switch.

Methods inherited from class stella.sensor.AbstractSensor
addRmiErrorListener, createSensor, getBindName, getConvert, getRespawn, getSensorDescription, getSensorName, initSensorTimerTask, notifyErrorListener, removeRmiErrorListener, setConvert, toString

Methods inherited from class util.rmi.AbstractRmiCaster
bindToRegistry, bindToRegistry, bindToRegistry, bindToRegistry, bindToRegistry, bindToRegistry, casterExit, casterExit, getBindName, isValid, unbindFromRegistry, unbindFromRegistry

Methods inherited from class util.rmi.RmiPropertyContainer
containsRemoteProperty, getRemoteProperties, getRemoteProperty, setRemoteProperty

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, rescanned, 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.rmi.RmiCaster
bindToRegistry, isValid, unbindFromRegistry

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_INVERSE
```
public static final String KEY_INVERSE
```
    The key defining if good weather inverses the toggle value.
    
    See Also:
    
    Constant Field Values
  - KEY_DATARATE
```
public static final String KEY_DATARATE
```
    The key linked to the data-event generating rate.
    
    See Also:
    
    Constant Field Values
  - KEY_ADSDRIVER
```
public static final String KEY_ADSDRIVER
```
    The name of the server to use.
    
    See Also:
    
    Constant Field Values
  - KEY_PLCREAD
```
public static final String KEY_PLCREAD
```
    The key linked to the channel-read command of the Nudam module.
    
    See Also:
    
    Constant Field Values
  - KEY_RETARD
```
public static final String KEY_RETARD
```
    The key pointing to a retard time for weather changes bad->good.
    
    See Also:
    
    Constant Field Values
  - KEY_UNIT
```
public static final String KEY_UNIT
```
    The key to the 'unit' of the digital reain sensor.
    
    See Also:
    
    Constant Field Values
  - KEY_FORMAT
```
public static final String KEY_FORMAT
```
    The key to the value formatter.
    
    See Also:
    
    Constant Field Values
  - DEFINVERSE
```
private static final boolean DEFINVERSE
```
    The default inverse property.
    
    See Also:
    
    Constant Field Values
  - DEFDATARATE
```
private static final long DEFDATARATE
```
    The default read channel.
    
    See Also:
    
    Constant Field Values
  - DEFRETARD
```
private static final long DEFRETARD
```
    The default retard time for changes to good weather.
    
    See Also:
    
    Constant Field Values
  - DEFUNIT
```
private static final String DEFUNIT
```
    The unit string of the rain sensor.
    
    See Also:
    
    Constant Field Values
  - DEFFORMAT
```
private static final DecimalFormat DEFFORMAT
```
    The format string for value and raw reading.
  - lastread
```
private Boolean lastread
```
    The last cache-changed event, value key.
  - lastchange
```
private Date lastchange
```
    The last cache-changed event received date.
  - goodweather
```
private Triggering goodweather
```
    The weather toggle.
  - data
```
private final Timer data
```
    The timer bound to data-event generating and weather reports.
  - retard
```
private BeckhoffRainSensor.RainTimerTask retard
```
    The timer task for good-weather retards.
  - format
```
private final NumberFormat format
```
    The raw and value formatter.
  - ads
```
private transient PollingBeckhoffServer ads
```
    The ADS server to send variable read/writes to.
  - datalist
```
private final List<DataListener> datalist
```
    The registered data-listeners.
  - rdatalist
```
private final List<RmiDataListener> rdatalist
```
    The registered data-listeners.
  - weatherlist
```
private final List<WeatherListener> weatherlist
```
    The registered weather-listeners.
- Constructor Detail
  - BeckhoffRainSensor
```
public BeckhoffRainSensor(Map<String,String> prop)
                   throws RemoteException
```
    Constructs a new RS485 sensor. The properties are checked for the presence of the #KEY_READ and the #KEY_CHANNEL keys. Construction fails if these keys are not present.
    
    Throws:
    
    IllegalArgumentException - If the necessary properties are not set.
    
    NumberFormatException - If the channel number is not an int.
    
    RemoteException
- Method Detail
  - init
```
public void init()
          throws InitException
```
    Initializes the sensor. The data-generator timer is initialized and a data-event generating timer-task is assigned to it.
    
    Specified by:
    
    init in interface Initializable
    
    Overrides:
    
    init in class AbstractSensor
    
    Throws:
    
    InitException
  - registerDriver
```
public boolean registerDriver(Driver poller)
```
    Registers the serial server to this sensor. This method adds this rain sensor as a CacheChangedListener to the driver, if the driver is a PollingRS485Server and has the correct name. Note that this method returns false only if the driver handed over is not of the appropriate type, i.e. a PollingRS485Server.
    
    Specified by:
    
    registerDriver in interface DriverDepending
    
    Returns:
    
    True if registering at the driver was successful.
  - cancel
```
public void cancel()
```
    Cancels the rain sensor. This includes deregistering from the cache caster and canceling of the timer used for scheduling data events.
    
    Specified by:
    
    cancel in interface Telemetering
  - exit
```
public void exit()
```
    Exists the rain sensor. Cancels it and does a caster exit on registered listeners before calling the super method.
    
    Specified by:
    
    exit in interface ExitCleaning
    
    Overrides:
    
    exit in class AbstractSensor
  - getReading
```
public double getReading()
```
    Reads the sensor value. If no serial server was registered to this sensor or the server is not reading the sensor's input, NaN is returned. Otherwise the serial server is queried for the value of its channel, PollingRS485Server.readChannel(java.lang.String), whose return value is then fed, along with the channel number, to the retrieveValue(java.lang.Boolean) method of the sensor. If no cache-event has been received, 1 for bad weather is returned.
    
    Specified by:
    
    getReading in interface Telemetering
    
    Returns:
    
    0/1 for no rain/rain.
  - validReading
```
public boolean validReading()
```
    The rain sensor is valid if the polling server was able to read the last rain-sensor switch.
    
    Specified by:
    
    validReading in interface Telemetering
  - getTimeOfRead
```
public Date getTimeOfRead()
```
    Returns the date of the last received cache-changed event.
    
    Specified by:
    
    getTimeOfRead in interface Telemetering
  - currentlyClear
```
public boolean currentlyClear()
```
    The main functionality of the rain sensor is to act as a weather sensor. This method returns true if the argument value is below 0.5.
    
    Specified by:
    
    currentlyClear in interface WeatherJudging
  - newValue
```
public void newValue(CacheChangedEvent cce)
```
    Indicates a new cache-reading on the rain sensor.
    
    Specified by:
    
    newValue in interface CacheChangedListener
  - currentlyRetarding
```
public boolean currentlyRetarding()
```
    Returns true, if we were bad and still recovering. No retard if we get bad.
    
    Specified by:
    
    currentlyRetarding in interface WeatherJudging
  - getMinClearUpTime
```
public long getMinClearUpTime()
```
    Estimates bad time.
    
    Specified by:
    
    getMinClearUpTime in interface WeatherJudging
  - getSensorInitInfo
```
public String getSensorInitInfo()
```
    Returns a string description of the sensor. The name is returned plus the serial server it listens to. The key properties of the switching behaviour, i.e. the toggling instance is reported, too.
    
    Specified by:
    
    getSensorInitInfo in interface Telemetering
    
    Overrides:
    
    getSensorInitInfo in class AbstractSensor
  - status
```
public String status()
```
    The current status of the rain sensor.
    
    Specified by:
    
    status in interface Telemetering
    
    Overrides:
    
    status in class AbstractSensor
  - addWeatherListener
```
public void addWeatherListener(WeatherListener ear)
```
    Adds a WeatherListener to the registered listeners. If the argument is null, nothing is changed.
    
    Specified by:
    
    addWeatherListener in interface WeatherCaster
    
    Parameters:
    
    ear - The listener to add.
  - removeWeatherListener
```
public void removeWeatherListener(WeatherListener ear)
```
    Removes a WeatherListener from the registered listeners. If the argument is null, nothing is changed.
    
    Specified by:
    
    removeWeatherListener in interface WeatherCaster
    
    Parameters:
    
    ear - The listener to remove.
  - addDataListener
```
public void addDataListener(DataListener ear)
```
    Adds a DataListener to the registered listeners. If the argument is null, nothing is changed.
    
    Specified by:
    
    addDataListener in interface DataCaster
    
    Parameters:
    
    ear - The listener to add.
  - removeDataListener
```
public void removeDataListener(DataListener ear)
```
    Removes a DataListener from the registered listeners. If the argument is null, nothing is changed.
    
    Specified by:
    
    removeDataListener in interface DataCaster
    
    Parameters:
    
    ear - The listener to remove.
  - addRmiDataListener
```
public void addRmiDataListener(RmiDataListener ear)
                        throws RemoteException
```
    Adds a DataListener to the registered listeners. If the argument is null, nothing is changed.
    
    Specified by:
    
    addRmiDataListener in interface RmiDataCaster
    
    Parameters:
    
    ear - The listener to add.
    
    Throws:
    
    RemoteException
  - removeRmiDataListener
```
public void removeRmiDataListener(RmiDataListener ear)
                           throws RemoteException
```
    Removes a DataListener from the registered listeners. If the argument is null, nothing is changed.
    
    Specified by:
    
    removeRmiDataListener in interface RmiDataCaster
    
    Parameters:
    
    ear - The listener to remove.
    
    Throws:
    
    RemoteException
  - notifyDataListener
```
protected void notifyDataListener(DataEvent de)
```
    Parses through the list of registered weather listeners and passes the argumental weather event to all of them. Synchronizes on the list of weather event listeners.
  - notifyWeatherListener
```
protected void notifyWeatherListener(WeatherEvent we)
```
    Parses through the list of registered weather listeners and passes the argumental weather event to all of them. Synchronizes on the list of weather event listeners.
  - retrieveValue
```
private double retrieveValue(Boolean read)
```
    Converts the input string into a sensor value. If the appropriate bit is set it is interpreted as rain. In the latter case the returned sensor value is one, zero otherwise.
    
    Parameters:
    
    read - The string read in from the serial line
    
    nr - The channel number (0-6) of the digital input.
    
    Returns:
    
    1 if raining, 0 for good weather. -1 if invalid.

Class BeckhoffRainSensor

Nested Class Summary

Nested classes/interfaces inherited from class util.PropertyResources

Field Summary

Fields inherited from class stella.sensor.AbstractSensor

Fields inherited from class util.rmi.AbstractRmiCaster

Fields inherited from class util.PropertyResources

Fields inherited from class util.PropertyContainer

Fields inherited from interface stella.rmi.RmiDataCaster

Fields inherited from interface util.PropertySupplying

Fields inherited from interface util.ResourceSupplying

Constructor Summary

Method Summary

Methods inherited from class stella.sensor.AbstractSensor

Methods inherited from class util.rmi.AbstractRmiCaster

Methods inherited from class util.rmi.RmiPropertyContainer

Methods inherited from class util.PropertyResources

Methods inherited from class util.PropertyContainer

Methods inherited from class java.lang.Object

Methods inherited from interface util.rmi.RmiCaster

Methods inherited from interface util.PropertySupplying

Field Detail

KEY_INVERSE

KEY_DATARATE

KEY_ADSDRIVER

KEY_PLCREAD

KEY_RETARD

KEY_UNIT

KEY_FORMAT

DEFINVERSE

DEFDATARATE

DEFRETARD

DEFUNIT

DEFFORMAT

lastread

lastchange

goodweather

data

retard

format

ads

datalist

rdatalist

weatherlist

Constructor Detail

BeckhoffRainSensor

Method Detail

init

registerDriver

cancel

exit

getReading

validReading

getTimeOfRead

currentlyClear

newValue

currentlyRetarding

getMinClearUpTime

getSensorInitInfo

status

addWeatherListener

removeWeatherListener

addDataListener

removeDataListener

addRmiDataListener

removeRmiDataListener

notifyDataListener

notifyWeatherListener

retrieveValue