org.ogema.drivers.homematic.xmlrpc.hl.channels

Class KeyChannel

java.lang.Object

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

org.ogema.drivers.homematic.xmlrpc.hl.channels.KeyChannel

All Implemented Interfaces:

DeviceHandler

public class KeyChannel
extends AbstractDeviceHandler

Author:

jlapp

Field Summary

Fields inherited from class org.ogema.drivers.homematic.xmlrpc.hl.api.AbstractDeviceHandler

conn

Constructor Summary

Constructors

Constructor and Description
KeyChannel(HomeMaticConnection conn)

Method Summary

Modifier and Type	Method and Description
boolean	accept(org.ogema.drivers.homematic.xmlrpc.ll.api.DeviceDescription desc) Called by the HomeMatic driver to determine whether this DeviceHandler wants to control the device from the DeviceDescription.
protected String	getEventResourceName(HmDevice device, org.ogema.drivers.homematic.xmlrpc.ll.api.DeviceDescription keyChannel)
void	setup(HmDevice parent, org.ogema.drivers.homematic.xmlrpc.ll.api.DeviceDescription desc, Map<String,Map<String,org.ogema.drivers.homematic.xmlrpc.ll.api.ParameterDescription<?>>> paramSets) Called by the HomeMatic driver after the DeviceHandler returned true from an DeviceHandler.accept(org.ogema.drivers.homematic.xmlrpc.ll.api.DeviceDescription) call.

Methods inherited from class org.ogema.drivers.homematic.xmlrpc.hl.api.AbstractDeviceHandler

getConnection

Methods inherited from class java.lang.Object

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

Constructor Detail

KeyChannel

public KeyChannel(HomeMaticConnection conn)

Method Detail

accept

public boolean accept(org.ogema.drivers.homematic.xmlrpc.ll.api.DeviceDescription desc)

Description copied from interface: DeviceHandler

Called by the HomeMatic driver to determine whether this DeviceHandler wants to control the device from the DeviceDescription.

Parameters:

desc - HomeMatic device (or channel) description.

Returns:

true if this DeviceHandler wants to control the given device.

setup

public void setup(HmDevice parent,
                  org.ogema.drivers.homematic.xmlrpc.ll.api.DeviceDescription desc,
                  Map<String,Map<String,org.ogema.drivers.homematic.xmlrpc.ll.api.ParameterDescription<?>>> paramSets)

Description copied from interface: DeviceHandler

Called by the HomeMatic driver after the DeviceHandler returned true from an DeviceHandler.accept(org.ogema.drivers.homematic.xmlrpc.ll.api.DeviceDescription) call. The DeviceDescription will be the same as the one used in the accept call. The device parameter will always be the OGEMA resource associated with the main HomeMatic device, even if setup is called for a channel, since additional OGEMA resources should be created on this resource.
The paramSets parameter contains all available Paramsets as named by the device description (DeviceDescription.getParamsets()). Each paramSet map contains the available parameter names as keys along with their ParameterDescription.

Parameters:

parent - OGEMA resource representing the main HomeMatic device.

desc - Description for the HomeMatic device or channel.

paramSets - Parameter sets available for this logical device.

getEventResourceName

protected String getEventResourceName(HmDevice device,
                                      org.ogema.drivers.homematic.xmlrpc.ll.api.DeviceDescription keyChannel)