jhomenet.hw.driver.X10
Class X10Driver

java.lang.Object
  jhomenet.hw.driver.X10.X10Driver

All Implemented Interfaces:

HardwareDriver

public class X10Driver
extends java.lang.Object
implements HardwareDriver

Version:

$Revision: 1.7 $ Filename: $Source: /cvsroot/jhomenet/files/src/jhomenet/hw/driver/X10/X10Driver.java,v $ Description:

Author:

$Author: dhirwinjr $

Method Summary

void	finalize() Overrides the finalize method.
double	getCount(java.lang.String hardwareID) TODO: Implement if necessary.
java.lang.String	getDriverHardwareDescription(java.lang.String hardwareID) Get a description of the hardware driver.
static HardwareDriver	getDriverInstance() Get a reference to the hardware driver.
java.lang.String	getDriverName() Get the hardware driver name.
java.util.ArrayList<java.lang.String>	getHardwareIDs() Get an array of the available hardware IDs.
double	getTemp(java.lang.String hardwareID) TODO: Implement if necessary.
double	getVoltage(java.lang.String hardwareID) TODO: Implement if necessary.
double	getWindDirection(java.lang.String hardwareID) TODO: Implement if necessary.
double	getWindSpeed(java.lang.String hardwareID) TODO: Implement if necessary.
void	switchDeviceOff(java.lang.String hardwareID) Switch the device off.
void	switchDeviceOn(java.lang.String hardwareID) Switch the desired device on.

Methods inherited from class java.lang.Object

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

Method Detail

getDriverInstance

public static HardwareDriver getDriverInstance()

Get a reference to the hardware driver.

Returns:

An instance to this hardware driver.

finalize

public void finalize()
              throws java.lang.Throwable

Overrides the finalize method. Deallocate the serial connection to the X10 transmitter.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

See Also:

Object.finalize()

getDriverName

public java.lang.String getDriverName()

Get the hardware driver name.

Specified by:

getDriverName in interface HardwareDriver

Returns:

Driver name

See Also:

HardwareDriver.getDriverName()

getTemp

public double getTemp(java.lang.String hardwareID)

TODO: Implement if necessary.

Specified by:

getTemp in interface HardwareDriver

Returns:

The temperature value

See Also:

HardwareDriver.getTemp(java.lang.String)

getVoltage

public double getVoltage(java.lang.String hardwareID)

TODO: Implement if necessary.

Specified by:

getVoltage in interface HardwareDriver

Returns:

The voltage value

See Also:

HardwareDriver.getVoltage(java.lang.String)

getCount

public double getCount(java.lang.String hardwareID)

TODO: Implement if necessary.

Specified by:

getCount in interface HardwareDriver

Returns:

The count value

See Also:

HardwareDriver.getCount(java.lang.String)

getWindSpeed

public double getWindSpeed(java.lang.String hardwareID)

TODO: Implement if necessary.

Specified by:

getWindSpeed in interface HardwareDriver

Returns:

The wind speed value

See Also:

HardwareDriver.getWindSpeed(java.lang.String)

getWindDirection

public double getWindDirection(java.lang.String hardwareID)

TODO: Implement if necessary.

Specified by:

getWindDirection in interface HardwareDriver

Returns:

The wind direction value

See Also:

HardwareDriver.getWindDirection(java.lang.String)

getHardwareIDs

public java.util.ArrayList<java.lang.String> getHardwareIDs()

Get an array of the available hardware IDs.

Specified by:

getHardwareIDs in interface HardwareDriver

Returns:

List of known hardware

See Also:

HardwareDriver.getHardwareIDs()

getDriverHardwareDescription

public java.lang.String getDriverHardwareDescription(java.lang.String hardwareID)

Get a description of the hardware driver.

Specified by:

getDriverHardwareDescription in interface HardwareDriver

Returns:

A description of the driver hardware

See Also:

HardwareDriver.getDriverHardwareDescription(java.lang.String)

switchDeviceOn

public void switchDeviceOn(java.lang.String hardwareID)
                    throws HardwareDriverException

Description copied from interface: HardwareDriver

Switch the desired device on.

Specified by:

switchDeviceOn in interface HardwareDriver

Throws:

HardwareDriverException

switchDeviceOff

public void switchDeviceOff(java.lang.String hardwareID)
                     throws HardwareDriverException

Switch the device off.

Specified by:

switchDeviceOff in interface HardwareDriver

Throws:

HardwareDriverException

See Also:

HardwareDriver.switchDeviceOff(java.lang.String)