org.ogema.drivers.homematic.xmlrpc.hl.types

Interface HmLogicInterface

All Superinterfaces:

org.ogema.core.model.Resource

public interface HmLogicInterface
extends org.ogema.core.model.Resource

Author:

jlapp

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALIAS

Method Summary

Modifier and Type	Method and Description
org.ogema.core.model.simple.StringResource	alias()
org.ogema.core.model.simple.StringResource	baseUrl() The base URL of the HomeMatic XML-RPC servlet.
org.ogema.core.model.simple.StringResource	ccuPw()
org.ogema.core.model.simple.StringResource	ccuUser()
org.ogema.core.model.simple.IntegerResource	clientPort() Port number of the XML-RPC service interface.
org.ogema.core.model.simple.StringResource	clientUrl() URL of the XML-RPC service.
org.ogema.core.model.ResourceList<HmDevice>	devices() Created by driver.
org.ogema.model.actors.OnOffSwitch	installationMode() Determine whether installation mode is active (subresource OnOffSwitch.stateFeedback()) and activate installation mode (subresource OnOffSwitch.stateControl()).
org.ogema.core.model.simple.StringResource	networkInterface() The network interface on which the driver servlet can be reached by the HomeMatic gateway.
org.ogema.core.model.simple.IntegerResource	port() The port on which the driver servlet can be reached.
org.ogema.core.model.simple.StringResource	serialNumber() Serial number of the CCU (real or emulated).

Methods inherited from interface org.ogema.core.model.Resource

activate, addAccessModeListener, addDecorator, addDecorator, addOptionalElement, addResourceListener, addStructureListener, addValueListener, addValueListener, create, deactivate, delete, deleteElement, equalsLocation, equalsPath, exists, getAccessMode, getAccessPriority, getDirectSubResources, getLocation, getLocation, getLocationResource, getName, getParent, getPath, getPath, getReferencingNodes, getReferencingResources, getResourceType, getSubResource, getSubResource, getSubResources, getSubResources, isActive, isDecorator, isReference, isTopLevel, isWriteable, removeAccessModeListener, removeResourceListener, removeStructureListener, removeValueListener, requestAccessMode, setAsReference, setOptionalElement

Field Detail

ALIAS

static final String ALIAS

See Also:

Constant Field Values

Method Detail

alias

org.ogema.core.model.simple.StringResource alias()

Returns:

Alias of the XML-RPC servlet on the local machine, defaults to "/homematic"

baseUrl

org.ogema.core.model.simple.StringResource baseUrl()

The base URL of the HomeMatic XML-RPC servlet. Use either this value or networkInterface() and port(), which will also work in case local IP address changes.

Returns:

Base URL of the XML-RPC servlet (e.g. http://192.168.0.10:8080)

networkInterface

org.ogema.core.model.simple.StringResource networkInterface()

The network interface on which the driver servlet can be reached by the HomeMatic gateway. Use together with port(), alternatively to baseUrl().

Returns:

Network interface of the XML-RPC servlet (e.g. wlan0)

port

org.ogema.core.model.simple.IntegerResource port()

The port on which the driver servlet can be reached. Use together with networkInterface(), alternatively to baseUrl().

Returns:

clientUrl

org.ogema.core.model.simple.StringResource clientUrl()

URL of the XML-RPC service. Use alternatively to serialNumber() and clientPort() if gateway discovery is not available. With recent CCU software the preferred alternative is the use of serialNumber().

Returns:

serialNumber

org.ogema.core.model.simple.StringResource serialNumber()

Serial number of the CCU (real or emulated). Requires the CCU to support UDP discovery. Use together with clientPort(), alternatively to clientUrl().

Returns:

clientPort

org.ogema.core.model.simple.IntegerResource clientPort()

Port number of the XML-RPC service interface. Typical values are 2001 for BidCos RF, 2010 for Homematic IP, 2000 for BidCos wired. Use together with serialNumber(), alternatively to clientUrl().

Returns:

devices

org.ogema.core.model.ResourceList<HmDevice> devices()

Created by driver.

Returns:

installationMode

org.ogema.model.actors.OnOffSwitch installationMode()

Determine whether installation mode is active (subresource OnOffSwitch.stateFeedback()) and activate installation mode (subresource OnOffSwitch.stateControl()).

Returns:

ccuUser

org.ogema.core.model.simple.StringResource ccuUser()

ccuPw

org.ogema.core.model.simple.StringResource ccuPw()