jhomenet.hw.driver
Interface HardwareDriver

All Known Subinterfaces:

OneWireDriverInterface, X10DriverInterface

All Known Implementing Classes:

NetworkDriver, OneWireDriver, TestDriver, X10Driver

public interface HardwareDriver

ID: $Id: HardwareDriver.java,v 1.4 2005/09/06 00:02:09 dhirwinjr Exp $ Description:

Method Summary

double	getCount(java.lang.String hardwareID) Get the count.
java.lang.String	getDriverHardwareDescription(java.lang.String hardwareID) Get a description of the hardware driver.
java.lang.String	getDriverName() Get the driver name.
java.util.ArrayList<java.lang.String>	getHardwareIDs() Get a list of the hardware IDs.
double	getTemp(java.lang.String hardwareID) Get the temperature.
double	getVoltage(java.lang.String hardwareID) Get the voltage value.
double	getWindDirection(java.lang.String hardwareID) Get the wind direction.
double	getWindSpeed(java.lang.String hardwareID) Get the wind speed.
void	switchDeviceOff(java.lang.String hardwareID) Switch the desired device off.
void	switchDeviceOn(java.lang.String hardwareID) Switch the desired device on.

Method Detail

getDriverName

java.lang.String getDriverName()

Get the driver name.

Returns:

Driver name

getDriverHardwareDescription

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

Get a description of the hardware driver.

Parameters:

hardwareID -

Returns:

A description of the driver hardware

getHardwareIDs

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

Get a list of the hardware IDs.

Returns:

List of known hardware

switchDeviceOn

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

Switch the desired device on.

Parameters:

hardwareID -

Throws:

HardwareDriverException

switchDeviceOff

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

Switch the desired device off.

Parameters:

hardwareID -

Throws:

HardwareDriverException

getTemp

double getTemp(java.lang.String hardwareID)
               throws HardwareDriverException

Get the temperature.

Parameters:

hardwareID -

Returns:

The temperature value

Throws:

HardwareDriverException

getVoltage

double getVoltage(java.lang.String hardwareID)
                  throws HardwareDriverException

Get the voltage value.

Parameters:

hardwareID -

Returns:

The voltage value

Throws:

HardwareDriverException

getCount

double getCount(java.lang.String hardwareID)
                throws HardwareDriverException

Get the count.

Parameters:

hardwareID -

Returns:

The count value

Throws:

HardwareDriverException

getWindSpeed

double getWindSpeed(java.lang.String hardwareID)
                    throws HardwareDriverException

Get the wind speed.

Parameters:

hardwareID -

Returns:

The wind speed value

Throws:

HardwareDriverException

getWindDirection

double getWindDirection(java.lang.String hardwareID)
                        throws HardwareDriverException

Get the wind direction.

Parameters:

hardwareID -

Returns:

The wind direction value

Throws:

HardwareDriverException