org.ogema.drivers.homematic.xmlrpc.ll.api

Interface DeviceDescription

All Superinterfaces:

XmlRpcStruct

All Known Implementing Classes:

DeviceDescriptionXmlRpc

public interface DeviceDescription
extends XmlRpcStruct

Represents a DeviceDescription as defined in the HomeMatic XML-RPC specification.

Author:

jlapp

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DeviceDescription.KEYS Keys used by the DeviceDescription XML-RPC struct.
static class	DeviceDescription.RX_FLAGS Bit flags used in the DeviceDescription.KEYS.RX_MODE member.

Method Summary

Modifier and Type	Method and Description
String	getAddress()
String[]	getChildren()
String[]	getParamsets() List of available Paramsets.
String	getParent() Address of the parent logical device.
String	getParentType() Parent type, if parent is available.
String	getType()
int	getVersion()
boolean	isDevice()

Methods inherited from interface org.ogema.drivers.homematic.xmlrpc.ll.api.XmlRpcStruct

containsKey, getBoolean, getInt, getString, getStringArray, getValue, keySet, setBoolean, setInt, setString, setStringArray, setValue, toMap

Method Detail

getAddress

String getAddress()

Returns:

logical device address.

getParamsets

String[] getParamsets()

List of available Paramsets. Usually 'MASTER', 'VALUES' plus the names of LINK sets, which are logical device address strings. Use HomeMatic.getParamsetDescription(java.lang.String, java.lang.String) and HomeMatic.getParamset(java.lang.String, java.lang.String) to retrieve description and actual values.

Returns:

available Paramsets

getParent

String getParent()

Address of the parent logical device.

Returns:

parent address, or null if this describes a top level device.

getParentType

String getParentType()

Parent type, if parent is available.

Returns:

parent type, or null if this describes a top level device.

getType

String getType()

Returns:

device type

isDevice

boolean isDevice()

Returns:

true iff this is not a channel.

getVersion

int getVersion()

getChildren

String[] getChildren()

Returns:

addresses of sub devices.