org.ogema.drivers.homematic.xmlrpc.ll

Class HomeMaticClient

java.lang.Object

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

All Implemented Interfaces:

HomeMatic

public class HomeMaticClient
extends Object
implements HomeMatic

Author:

jlapp

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HomeMaticClient.DefaultServiceMessage

Constructor Summary

Constructors

Constructor and Description
HomeMaticClient(String urlString)

Method Summary

Modifier and Type	Method and Description
void	abortDeleteDevice(String address)
void	addLink(String sender, String receiver, String name, String description)
void	deleteDevice(String address, int flags) Flags: 0x01 DELETE_FLAG_RESET - reset device before delete 0x02 DELETE_FLAG_FORCE - delete even if device is not reachable 0x04 DELETE_FLAG_DEFER - delete as soon as device is reachable
DeviceDescription	getDeviceDescription(String address)
int	getInstallMode()
Map<String,Object>	getLinkInfo(String sender, String receiver)
List<String>	getLinkPeers(String address)
List<Map<String,Object>>	getLinks(String address, int flags)
XmlRpcStruct	getParamset(String address, String paramset_key)
Map<String,ParameterDescription<?>>	getParamsetDescription(String address, String type)
String	getParamsetId(String address, String type)
List<ServiceMessage>	getServiceMessages()
<T> T	getValue(String address, String value_key)
void	init(String url, String interfaceId)
List<DeviceDescription>	listDevices()
void	ping(String callerId)
void	putParamset(String address, String paramset_key, XmlRpcStruct set)
void	removeLink(String sender, String receiver)
boolean	reportValueUsage(String address, String valueId, int refCounter)
XmlRpcStruct	rssiInfo()
void	setInstallMode(boolean on, int time, int mode)
void	setValue(String address, String value_key, Object value)

Methods inherited from class java.lang.Object

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

Constructor Detail

HomeMaticClient

public HomeMaticClient(String urlString)
                throws IOException

Throws:

IOException

Method Detail

init

public void init(String url,
                 String interfaceId)
          throws org.apache.xmlrpc.XmlRpcException

Specified by:

init in interface HomeMatic

Throws:

org.apache.xmlrpc.XmlRpcException

ping

public void ping(String callerId)
          throws org.apache.xmlrpc.XmlRpcException

Specified by:

ping in interface HomeMatic

Throws:

org.apache.xmlrpc.XmlRpcException

getDeviceDescription

public DeviceDescription getDeviceDescription(String address)
                                       throws org.apache.xmlrpc.XmlRpcException

Specified by:

getDeviceDescription in interface HomeMatic

Throws:

org.apache.xmlrpc.XmlRpcException

listDevices

public List<DeviceDescription> listDevices()
                                    throws org.apache.xmlrpc.XmlRpcException

Specified by:

listDevices in interface HomeMatic

Throws:

org.apache.xmlrpc.XmlRpcException

getParamsetDescription

public Map<String,ParameterDescription<?>> getParamsetDescription(String address,
                                                                  String type)
                                                           throws org.apache.xmlrpc.XmlRpcException

Specified by:

getParamsetDescription in interface HomeMatic

Throws:

org.apache.xmlrpc.XmlRpcException

getParamset

public XmlRpcStruct getParamset(String address,
                                String paramset_key)
                         throws org.apache.xmlrpc.XmlRpcException

Specified by:

getParamset in interface HomeMatic

Throws:

org.apache.xmlrpc.XmlRpcException

getParamsetId

public String getParamsetId(String address,
                            String type)
                     throws org.apache.xmlrpc.XmlRpcException

Specified by:

getParamsetId in interface HomeMatic

Throws:

org.apache.xmlrpc.XmlRpcException

putParamset

public void putParamset(String address,
                        String paramset_key,
                        XmlRpcStruct set)
                 throws org.apache.xmlrpc.XmlRpcException

Specified by:

putParamset in interface HomeMatic

Throws:

org.apache.xmlrpc.XmlRpcException

getInstallMode

public int getInstallMode()
                   throws org.apache.xmlrpc.XmlRpcException

Specified by:

getInstallMode in interface HomeMatic

Returns:

time in seconds that installation mode will remain active, 0 if inactive.

Throws:

org.apache.xmlrpc.XmlRpcException

setInstallMode

public void setInstallMode(boolean on,
                           int time,
                           int mode)
                    throws org.apache.xmlrpc.XmlRpcException

Specified by:

setInstallMode in interface HomeMatic

Parameters:

on - install mode active state.

time - time to remain active.

mode - 1: normal mode, 2: set all MASTER parameters to their default value and delete all links.

Throws:

org.apache.xmlrpc.XmlRpcException

getValue

public <T> T getValue(String address,
                      String value_key)
               throws org.apache.xmlrpc.XmlRpcException

Specified by:

getValue in interface HomeMatic

Throws:

org.apache.xmlrpc.XmlRpcException

setValue

public void setValue(String address,
                     String value_key,
                     Object value)
              throws org.apache.xmlrpc.XmlRpcException

Specified by:

setValue in interface HomeMatic

Throws:

org.apache.xmlrpc.XmlRpcException

reportValueUsage

public boolean reportValueUsage(String address,
                                String valueId,
                                int refCounter)
                         throws org.apache.xmlrpc.XmlRpcException

Specified by:

reportValueUsage in interface HomeMatic

Throws:

org.apache.xmlrpc.XmlRpcException

addLink

public void addLink(String sender,
                    String receiver,
                    String name,
                    String description)
             throws org.apache.xmlrpc.XmlRpcException

Specified by:

addLink in interface HomeMatic

Throws:

org.apache.xmlrpc.XmlRpcException

removeLink

public void removeLink(String sender,
                       String receiver)
                throws org.apache.xmlrpc.XmlRpcException

Specified by:

removeLink in interface HomeMatic

Throws:

org.apache.xmlrpc.XmlRpcException

getLinkPeers

public List<String> getLinkPeers(String address)
                          throws org.apache.xmlrpc.XmlRpcException

Specified by:

getLinkPeers in interface HomeMatic

Throws:

org.apache.xmlrpc.XmlRpcException

getLinkInfo

public Map<String,Object> getLinkInfo(String sender,
                                      String receiver)
                               throws org.apache.xmlrpc.XmlRpcException

Specified by:

getLinkInfo in interface HomeMatic

Throws:

org.apache.xmlrpc.XmlRpcException

getLinks

public List<Map<String,Object>> getLinks(String address,
                                         int flags)
                                  throws org.apache.xmlrpc.XmlRpcException

Specified by:

getLinks in interface HomeMatic

Throws:

org.apache.xmlrpc.XmlRpcException

getServiceMessages

public List<ServiceMessage> getServiceMessages()
                                        throws org.apache.xmlrpc.XmlRpcException

Specified by:

getServiceMessages in interface HomeMatic

Throws:

org.apache.xmlrpc.XmlRpcException

deleteDevice

public void deleteDevice(String address,
                         int flags)
                  throws org.apache.xmlrpc.XmlRpcException

Description copied from interface: HomeMatic

Flags:

0x01

DELETE_FLAG_RESET - reset device before delete

0x02

DELETE_FLAG_FORCE - delete even if device is not reachable

0x04

DELETE_FLAG_DEFER - delete as soon as device is reachable

Specified by:

deleteDevice in interface HomeMatic

Parameters:

address - device address

flags - see javadoc

Throws:

org.apache.xmlrpc.XmlRpcException

abortDeleteDevice

public void abortDeleteDevice(String address)
                       throws org.apache.xmlrpc.XmlRpcException

Specified by:

abortDeleteDevice in interface HomeMatic

Throws:

org.apache.xmlrpc.XmlRpcException

rssiInfo

public XmlRpcStruct rssiInfo()
                      throws org.apache.xmlrpc.XmlRpcException

Specified by:

rssiInfo in interface HomeMatic

Throws:

org.apache.xmlrpc.XmlRpcException