org.ogema.drivers.homematic.xmlrpc.hl.api

Interface HomeMaticConnection

All Known Implementing Classes:

HmConnection

public interface HomeMaticConnection

Used by DeviceHandler implementations to communicate with its HomeMatic logic interface and to setup OGEMA specific device/resource relations.

Author:

jlapp

Method Summary

Modifier and Type	Method and Description
void	addEventListener(org.ogema.drivers.homematic.xmlrpc.ll.api.HmEventListener l) Register an event listener with this connection.
HmDevice	findControllingDevice(org.ogema.core.model.Resource ogemaDevice) Returns the HmDevice element controlling the given OGEMA resource, as configured with registerControlledResource(org.ogema.drivers.homematic.xmlrpc.hl.types.HmDevice, org.ogema.core.model.Resource)
HmDevice	getChannel(HmDevice device, String channelAddress) Finds a channel resource for a given device.
HmDevice	getToplevelDevice(HmDevice channel) Returns the resource representing the HomeMatic device the channel belongs to.
<T> T	getValue(String address, String value_key)
void	performAddLink(String sender, String receiver, String name, String description) Calls the addLink method of the HomeMatic logic interface.
List<Map<String,Object>>	performGetLinks(String address, int flags)
void	performPutParamset(String address, String set, Map<String,Object> values)
void	performRemoveLink(String sender, String receiver) Calls the removeLink method of the HomeMatic logic interface.
void	performSetValue(String address, String valueKey, Object value)
void	registerControlledResource(HmDevice channel, org.ogema.core.model.Resource ogemaDevice) Configure a control relationship between the homematic device and a resource that can be retrieved by using findControllingDevice(org.ogema.core.model.Resource).
void	removeEventListener(org.ogema.drivers.homematic.xmlrpc.ll.api.HmEventListener l)

Method Detail

addEventListener

void addEventListener(org.ogema.drivers.homematic.xmlrpc.ll.api.HmEventListener l)

Register an event listener with this connection.

Parameters:

l - event listener

findControllingDevice

HmDevice findControllingDevice(org.ogema.core.model.Resource ogemaDevice)

Returns the HmDevice element controlling the given OGEMA resource, as configured with registerControlledResource(org.ogema.drivers.homematic.xmlrpc.hl.types.HmDevice, org.ogema.core.model.Resource)

Parameters:

ogemaDevice -

Returns:

HomeMatic device resource controlling the given resource or null.

See Also:

registerControlledResource(org.ogema.drivers.homematic.xmlrpc.hl.types.HmDevice, org.ogema.core.model.Resource)

getChannel

HmDevice getChannel(HmDevice device,
                    String channelAddress)

Finds a channel resource for a given device.

Parameters:

device - top level device

channelAddress -

Returns:

device channel with given address or null.

getToplevelDevice

HmDevice getToplevelDevice(HmDevice channel)

Returns the resource representing the HomeMatic device the channel belongs to. If called with a top level device resource, return the argument.

Parameters:

channel -

Returns:

top level device resource.

performAddLink

void performAddLink(String sender,
                    String receiver,
                    String name,
                    String description)

Calls the addLink method of the HomeMatic logic interface.

Parameters:

sender - homematic address of the sending device.

receiver - homematic address of the receiving device.

name - user defined name for the link.

description - link description.

performRemoveLink

void performRemoveLink(String sender,
                       String receiver)

Calls the removeLink method of the HomeMatic logic interface.

Parameters:

sender - homematic address of the sending device.

receiver - homematic address of the receiving device.

performGetLinks

List<Map<String,Object>> performGetLinks(String address,
                                         int flags)

performPutParamset

void performPutParamset(String address,
                        String set,
                        Map<String,Object> values)

performSetValue

void performSetValue(String address,
                     String valueKey,
                     Object value)

registerControlledResource

void registerControlledResource(HmDevice channel,
                                org.ogema.core.model.Resource ogemaDevice)

Configure a control relationship between the homematic device and a resource that can be retrieved by using findControllingDevice(org.ogema.core.model.Resource). A device handler should call this method for every device resource that it creates, so that the control relationship can be retrieved by other device handlers.

Parameters:

channel - resource of a homematic device channel.

ogemaDevice - resource controlled by the homematic device.

removeEventListener

void removeEventListener(org.ogema.drivers.homematic.xmlrpc.ll.api.HmEventListener l)

getValue

<T> T getValue(String address,
               String value_key)
        throws IOException

Throws:

IOException