GenericDevice (iCasa :: Platform and Simulator 1.2.7-SNAPSHOT API)

All Known Subinterfaces:

AudioSource, BathroomScale, BinaryLight, Box, CarbonDioxydeSensor, CarbonMonoxydeSensor, ColorLight, Cooler, DimmerLight, Heater, MotionSensor, Photometer, PowerDevice, Powermeter, PowerSwitch, PowerSwitchmeter, PresenceSensor, PushButton, SetTopBox, SimulatedDevice, SimulatedPushButton, Speaker, Sprinkler, Thermometer

All Known Implementing Classes:

AbstractDevice, PhilipsHueLight, ZigbeeBinaryLight, ZigbeeMotionSensor, ZigbeePhotometer, ZigbeePowerSwitch, ZigbeePresenceSensor, ZigbeePushButton, ZigbeeThermometer
```
public interface GenericDevice
```
Generic interface that is intended to be used as a skeleton for device service interface definitions.

See Also:
AbstractDevice

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_HEIGHT` Default icon height, in px.
`static int`	`DEFAULT_WIDTH` Default icon width, in px.
`static String`	`DEVICE_SERIAL_NUMBER` Service property indicating the hardware serial number of the device.
`static String`	`FAULT_NO`
`static String`	`FAULT_PROPERTY_NAME`
`static String`	`FAULT_UNKNOWN`
`static String`	`FAULT_YES`
`static String`	`LOCATION_PROPERTY_NAME`
`static String`	`LOCATION_UNKNOWN`
`static String`	`STATE_ACTIVATED`
`static String`	`STATE_DEACTIVATED`
`static String`	`STATE_PROPERTY_NAME`
`static String`	`STATE_UNKNOWN`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addListener(DeviceListener<?> listener)` Add the specified listener to the list of this device's listeners.
`boolean`	`constainsProperty(String propertyName)` Determines if the device contains a property definition with this name
`void`	`enterInZones(List<Zone> zones)` Callback notifying this device enters in one or more zones
`String`	`getFault()` Returns fault state of this device.
`Set<String>`	`getProperties()` Returns names of all properties which define the device state.
`Object`	`getPropertyValue(String propertyName)` Returns the specified property value.
`String`	`getSerialNumber()` Return the serial number of the device.
`String`	`getState()` Returns activation state of this device.
`boolean`	`hasPropertyValue(String propertyName)` Determines if a property has been set.
`void`	`leavingZones(List<Zone> zones)` Callback notifying this device leaves one or more zones
`void`	`removeListener(DeviceListener<?> listener)` Remove the specified listener from the list of this device's listeners.
`boolean`	`removeProperty(String propertyName)` Removes a property on this device.
`void`	`setFault(String fault)` Sets fault state of this device.
`void`	`setPropertyValue(String propertyName, Object value)` Sets specified property value.
`void`	`setState(String state)` Sets activation state of this device.

- Field Detail
  - DEVICE_SERIAL_NUMBER
```
static final String DEVICE_SERIAL_NUMBER
```
    Service property indicating the hardware serial number of the device.
    - This property is mandatory
    - Type of values : java.lang.String
    - Description : the hardware serial number of the device. Must be unique and immutable.
    See Also:
    getSerialNumber(), Constant Field Values
  - STATE_PROPERTY_NAME
```
static final String STATE_PROPERTY_NAME
```
    See Also:
    Constant Field Values
  - STATE_ACTIVATED
```
static final String STATE_ACTIVATED
```
    See Also:
    Constant Field Values
  - STATE_DEACTIVATED
```
static final String STATE_DEACTIVATED
```
    See Also:
    Constant Field Values
  - STATE_UNKNOWN
```
static final String STATE_UNKNOWN
```
    See Also:
    Constant Field Values
  - FAULT_PROPERTY_NAME
```
static final String FAULT_PROPERTY_NAME
```
    See Also:
    Constant Field Values
  - FAULT_YES
```
static final String FAULT_YES
```
    See Also:
    Constant Field Values
  - FAULT_NO
```
static final String FAULT_NO
```
    See Also:
    Constant Field Values
  - FAULT_UNKNOWN
```
static final String FAULT_UNKNOWN
```
    See Also:
    Constant Field Values
  - LOCATION_PROPERTY_NAME
```
static final String LOCATION_PROPERTY_NAME
```
    See Also:
    Constant Field Values
  - LOCATION_UNKNOWN
```
static final String LOCATION_UNKNOWN
```
    See Also:
    Constant Field Values
  - DEFAULT_WIDTH
```
static final int DEFAULT_WIDTH
```
    Default icon width, in px.
    
    See Also:
    Constant Field Values
  - DEFAULT_HEIGHT
```
static final int DEFAULT_HEIGHT
```
    Default icon height, in px.
    
    See Also:
    Constant Field Values
- Method Detail
  - getSerialNumber
```
String getSerialNumber()
```
    Return the serial number of the device.
    
    Returns:
    the serial number of the device.
    See Also:
    DEVICE_SERIAL_NUMBER
  - addListener
```
void addListener(DeviceListener<?> listener)
```
    Add the specified listener to the list of this device's listeners. If the listener is already is the list, this method does nothing.
    
    Parameters:
    listener - the listener to add
  - removeListener
```
void removeListener(DeviceListener<?> listener)
```
    Remove the specified listener from the list of this device's listeners. If the listener wasn't in the list, this method does nothing.
    
    Parameters:
    listener - the listener to remove
  - getState
```
String getState()
```
    Returns activation state of this device.
    
    Returns:
    activation state of this device.
  - setState
```
void setState(String state)
```
    Sets activation state of this device.
    
    Parameters:
    state - activation state to set
  - getFault
```
String getFault()
```
    Returns fault state of this device.
    
    Returns:
    fault state of this device.
  - setFault
```
void setFault(String fault)
```
    Sets fault state of this device.
    
    Parameters:
    fault -
  - getProperties
```
Set<String> getProperties()
```
    Returns names of all properties which define the device state.
    
    Returns:
    names of all properties which define the device state.
  - getPropertyValue
```
Object getPropertyValue(String propertyName)
```
    Returns the specified property value. Returns null if there is no value or the property does not exist.
    
    Parameters:
    propertyName -
    
    Returns:
    the specified property value.
  - setPropertyValue
```
void setPropertyValue(String propertyName,
                    Object value)
```
    Sets specified property value.
    
    Parameters:
    propertyName -
    value -
  - constainsProperty
```
boolean constainsProperty(String propertyName)
```
    Determines if the device contains a property definition with this name
    
    Parameters:
    propertyName - the property name
    
    Returns:
    true if contains the property, false otherwise.
  - hasPropertyValue
```
boolean hasPropertyValue(String propertyName)
```
    Determines if a property has been set.
    
    Parameters:
    propertyName - the property name
    
    Returns:
    true if property has a value. false if property has not been set (value null) or if property does not exist.
  - removeProperty
```
boolean removeProperty(String propertyName)
```
    Removes a property on this device.
    
    Parameters:
    propertyName - the property name
    
    Returns:
    true if property was removed. false if property does not exist.
  - enterInZones
```
void enterInZones(List<Zone> zones)
```
    Callback notifying this device enters in one or more zones
    
    Parameters:
    zones - The list of zones where the device has entered
  - leavingZones
```
void leavingZones(List<Zone> zones)
```
    Callback notifying this device leaves one or more zones
    
    Parameters:
    zones - The list of zones where that device has leaved

Interface GenericDevice

Field Summary

Method Summary

Field Detail

DEVICE_SERIAL_NUMBER

STATE_PROPERTY_NAME

STATE_ACTIVATED

STATE_DEACTIVATED

STATE_UNKNOWN

FAULT_PROPERTY_NAME

FAULT_YES

FAULT_NO

FAULT_UNKNOWN

LOCATION_PROPERTY_NAME

LOCATION_UNKNOWN

DEFAULT_WIDTH

DEFAULT_HEIGHT

Method Detail

getSerialNumber

addListener

removeListener

getState

setState

getFault

setFault

getProperties

getPropertyValue

setPropertyValue

constainsProperty

hasPropertyValue

removeProperty

enterInZones

leavingZones