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

Interface HomeMatic

All Known Implementing Classes:

HomeMaticClient

public interface HomeMatic

Sends commands to a HomeMatic logic interface via XML-RPC, see the HomeMatic XML-RPC specification, available from eQ-3 for details.

Author:

jlapp

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)
URL	getServerUrl()
List<ServiceMessage>	getServiceMessages()
<T> T	getValue(String address, String value_key)
void	init(String url, String interface_id)
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)

Method Detail

ping

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

Throws:

org.apache.xmlrpc.XmlRpcException

init

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

Throws:

org.apache.xmlrpc.XmlRpcException

getServerUrl

URL getServerUrl()

listDevices

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

Throws:

org.apache.xmlrpc.XmlRpcException

getDeviceDescription

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

Throws:

org.apache.xmlrpc.XmlRpcException

getParamsetDescription

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

Throws:

org.apache.xmlrpc.XmlRpcException

getParamset

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

Throws:

org.apache.xmlrpc.XmlRpcException

putParamset

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

Throws:

org.apache.xmlrpc.XmlRpcException

getParamsetId

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

Throws:

org.apache.xmlrpc.XmlRpcException

getInstallMode

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

Returns:

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

Throws:

org.apache.xmlrpc.XmlRpcException

setInstallMode

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

Parameters:

on - install mode active state.

time - time to remain active in seconds

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

Throws:

org.apache.xmlrpc.XmlRpcException

setValue

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

Throws:

org.apache.xmlrpc.XmlRpcException

getValue

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

Throws:

org.apache.xmlrpc.XmlRpcException

reportValueUsage

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

Throws:

org.apache.xmlrpc.XmlRpcException

addLink

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

Throws:

org.apache.xmlrpc.XmlRpcException

removeLink

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

Throws:

org.apache.xmlrpc.XmlRpcException

getLinkPeers

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

Throws:

org.apache.xmlrpc.XmlRpcException

getLinkInfo

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

Throws:

org.apache.xmlrpc.XmlRpcException

getLinks

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

Throws:

org.apache.xmlrpc.XmlRpcException

getServiceMessages

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

Throws:

org.apache.xmlrpc.XmlRpcException

deleteDevice

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

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

Parameters:

address - device address

flags - see javadoc

Throws:

org.apache.xmlrpc.XmlRpcException

abortDeleteDevice

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

Throws:

org.apache.xmlrpc.XmlRpcException

rssiInfo

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

Throws:

org.apache.xmlrpc.XmlRpcException