jhomenet.hw.sensor
Class LightningSensor

java.lang.Object
  Model
      jhomenet.hw.HomenetHardware
          jhomenet.hw.sensor.Sensor
              jhomenet.hw.sensor.ValueSensor
                  jhomenet.hw.sensor.LightningSensor

All Implemented Interfaces:

java.io.Serializable, Hardware

public class LightningSensor
extends ValueSensor
implements java.io.Serializable

Field Summary

Fields inherited from class jhomenet.hw.sensor.Sensor

currentData, INVALID_DATA, maxData, minData, pollingType, PROPERTYNAME_CURRENTDATA, PROPERTYNAME_MAXDATA, PROPERTYNAME_MINDATA, PROPERTYNAME_POLLINGTYPE, readFailed

Fields inherited from class jhomenet.hw.HomenetHardware

configuration, driver, errorTracker, hardwareDescription, hardwareId, PROPERTYNAME_CONFIGURATION, PROPERTYNAME_SETUPDESC, setupDescription

Constructor Summary

LightningSensor()
Constructor.

LightningSensor(java.lang.String hardwareID, java.lang.String description)
Default constructor.

Method Summary

protected void	initializeHardware() Initialize the lightning sensor.
protected void	initializeHardwareDescription() Set the hardware description.
double	readFromDriver() Read the current value from the sensor.
HardwareData	readSensor() Read from the sensor.

Methods inherited from class jhomenet.hw.sensor.Sensor

capture, getCurrentAsString, getCurrentData, getMaxData, getMinData, getPollingType, getPollingTypeListModel, isFirstPoll, resetData, setCurrentData, setMaxData, setMinData, setPollingType, toString

Methods inherited from class jhomenet.hw.HomenetHardware

equals, getConfiguration, getConfiguration, getDriverHardwareDescription, getDriverName, getErrorCount, getHardwareClassname, getHardwareDescription, getHardwareId, getSetupDescription, isRegistered, setConfiguration, setConfiguration, setDriver, setHardwareId, setSetupDescription

Methods inherited from class java.lang.Object

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

Constructor Detail

LightningSensor

public LightningSensor(java.lang.String hardwareID,
                       java.lang.String description)

Default constructor.

Parameters:

hardwareID -

description -

LightningSensor

public LightningSensor()

Constructor.

Method Detail

initializeHardwareDescription

protected void initializeHardwareDescription()

Description copied from class: HomenetHardware

Set the hardware description.

Specified by:

initializeHardwareDescription in class HomenetHardware

See Also:

HomenetHardware.initializeHardwareDescription()

initializeHardware

protected void initializeHardware()

Initialize the lightning sensor.

Overrides:

initializeHardware in class HomenetHardware

See Also:

HomenetHardware.initializeHardware()

readSensor

public HardwareData readSensor()
                        throws SensorException

Read from the sensor.

Specified by:

readSensor in class Sensor

Returns:

The sensor's data in the sensor's default data unit.

Throws:

SensorException

See Also:

Sensor.readSensor()

readFromDriver

public double readFromDriver()
                      throws SensorException

Read the current value from the sensor. By default, the function returns the number of strikes per millisecond.

Specified by:

readFromDriver in class Sensor

Returns:

The raw value read from the driver.

Throws:

SensorException

See Also:

Sensor.readSensor()