org.ogema.drivers.homematic.xmlrpc.hl

Class HomeMaticDriver.HmConnection

java.lang.Object

org.ogema.drivers.homematic.xmlrpc.hl.HomeMaticDriver.HmConnection

All Implemented Interfaces:

HomeMaticConnection

Enclosing class:

HomeMaticDriver

public class HomeMaticDriver.HmConnection
extends Object
implements HomeMaticConnection

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, or null if the resource is not controlled by the HomeMatic driver.
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.
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 HomeMaticConnection.findControllingDevice(org.ogema.core.model.Resource).
void	removeEventListener(org.ogema.drivers.homematic.xmlrpc.ll.api.HmEventListener l)

Methods inherited from class java.lang.Object

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

Method Detail

addEventListener

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

Description copied from interface: HomeMaticConnection

Register an event listener with this connection.

Specified by:

addEventListener in interface HomeMaticConnection

Parameters:

l - event listener

removeEventListener

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

Specified by:

removeEventListener in interface HomeMaticConnection

performSetValue

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

Specified by:

performSetValue in interface HomeMaticConnection

performPutParamset

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

Specified by:

performPutParamset in interface HomeMaticConnection

performAddLink

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

Description copied from interface: HomeMaticConnection

Calls the addLink method of the HomeMatic logic interface.

Specified by:

performAddLink in interface HomeMaticConnection

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

public void performRemoveLink(String sender,
                              String receiver)

Description copied from interface: HomeMaticConnection

Calls the removeLink method of the HomeMatic logic interface.

Specified by:

performRemoveLink in interface HomeMaticConnection

Parameters:

sender - homematic address of the sending device.

receiver - homematic address of the receiving device.

performGetLinks

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

Specified by:

performGetLinks in interface HomeMaticConnection

findControllingDevice

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

Returns the HmDevice element controlling the given OGEMA resource, or null if the resource is not controlled by the HomeMatic driver.

Specified by:

findControllingDevice in interface HomeMaticConnection

Parameters:

ogemaDevice -

Returns:

HomeMatic device resource controlling the given resource or null.

See Also:

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

getToplevelDevice

public HmDevice getToplevelDevice(HmDevice channel)

Description copied from interface: HomeMaticConnection

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

Specified by:

getToplevelDevice in interface HomeMaticConnection

Returns:

top level device resource.

getChannel

public HmDevice getChannel(HmDevice device,
                           String channelAddress)

Description copied from interface: HomeMaticConnection

Finds a channel resource for a given device.

Specified by:

getChannel in interface HomeMaticConnection

Parameters:

device - top level device

Returns:

device channel with given address or null.

registerControlledResource

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

Description copied from interface: HomeMaticConnection

Configure a control relationship between the homematic device and a resource that can be retrieved by using HomeMaticConnection.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.

Specified by:

registerControlledResource in interface HomeMaticConnection

Parameters:

channel - resource of a homematic device channel.

ogemaDevice - resource controlled by the homematic device.