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

Class DeviceDescriptionXmlRpc

java.lang.Object

org.ogema.drivers.homematic.xmlrpc.ll.xmlrpc.MapXmlRpcStruct

org.ogema.drivers.homematic.xmlrpc.ll.xmlrpc.DeviceDescriptionXmlRpc

All Implemented Interfaces:

DeviceDescription, XmlRpcStruct

public class DeviceDescriptionXmlRpc
extends MapXmlRpcStruct
implements DeviceDescription

Author:

jlapp

Nested Class Summary

Nested classes/interfaces inherited from interface org.ogema.drivers.homematic.xmlrpc.ll.api.DeviceDescription

DeviceDescription.KEYS, DeviceDescription.RX_FLAGS

Field Summary

Fields inherited from class org.ogema.drivers.homematic.xmlrpc.ll.xmlrpc.MapXmlRpcStruct

struct

Constructor Summary

Constructors

Constructor and Description
DeviceDescriptionXmlRpc(DeviceDescription desc)
DeviceDescriptionXmlRpc(Map<String,Object> struct)
DeviceDescriptionXmlRpc(String address, int version) Creates a DeviceDescription with the minimum information required for use in the HomeMatic listDevices() function.

Method Summary

Modifier and Type	Method and Description
static String[]	asStringArray(Object[] a)
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 class org.ogema.drivers.homematic.xmlrpc.ll.xmlrpc.MapXmlRpcStruct

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

Methods inherited from class java.lang.Object

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

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

Constructor Detail

DeviceDescriptionXmlRpc

public DeviceDescriptionXmlRpc(Map<String,Object> struct)

DeviceDescriptionXmlRpc

public DeviceDescriptionXmlRpc(DeviceDescription desc)

DeviceDescriptionXmlRpc

public DeviceDescriptionXmlRpc(String address,
                               int version)

Creates a DeviceDescription with the minimum information required for use in the HomeMatic listDevices() function.

Parameters:

address - Homematic address string

version - Homematic version

Method Detail

asStringArray

public static String[] asStringArray(Object[] a)

getAddress

public String getAddress()

Specified by:

getAddress in interface DeviceDescription

Returns:

logical device address.

getParamsets

public String[] getParamsets()

Description copied from interface: DeviceDescription

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.

Specified by:

getParamsets in interface DeviceDescription

Returns:

available Paramsets

getParent

public String getParent()

Description copied from interface: DeviceDescription

Address of the parent logical device.

Specified by:

getParent in interface DeviceDescription

Returns:

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

getParentType

public String getParentType()

Description copied from interface: DeviceDescription

Parent type, if parent is available.

Specified by:

getParentType in interface DeviceDescription

Returns:

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

getType

public String getType()

Specified by:

getType in interface DeviceDescription

Returns:

device type

isDevice

public boolean isDevice()

Specified by:

isDevice in interface DeviceDescription

Returns:

true iff this is not a channel.

getVersion

public int getVersion()

Specified by:

getVersion in interface DeviceDescription

getChildren

public String[] getChildren()

Specified by:

getChildren in interface DeviceDescription

Returns:

addresses of sub devices.