Calimero 2.0 API documentation

This document is the API specification for Calimero 2.0.

See:
Description

Packages

tuwien.auto.calimero	Base package of the Calimero library.
tuwien.auto.calimero.buffer	Support for temporary storage of KNX network messages.
tuwien.auto.calimero.buffer.cache	Cache interface for different caching policies.
tuwien.auto.calimero.cemi	Offers an interface to the common External Message Interface, cEMI for short.
tuwien.auto.calimero.datapoint	Contains a representation for KNX datapoints, for state based datapoints as well as for command based datapoints.
tuwien.auto.calimero.dptxlator	Contains translators for translating between KNX datapoint types (DPT), java types and values carrying more specific type semantics (e.g. engineering unit).
tuwien.auto.calimero.exception	Exception hierarchy containing common types of (checked) exceptions thrown throughout the library by public or protected visible methods.
tuwien.auto.calimero.knxnetip	KNXnet/IP protocols for tunneling, device management and routing.
tuwien.auto.calimero.knxnetip.servicetype	Contains service types used by KNXnet/IP protocols.
tuwien.auto.calimero.knxnetip.util	Structures used in KNXnet/IP service types.
tuwien.auto.calimero.link	Link interface to access a KNX network.
tuwien.auto.calimero.link.event	Listeners and events used together with network links.
tuwien.auto.calimero.link.medium	Contains setting types storing necessary KNX device and medium information, and KNX message frame types for different KNX communication media.
tuwien.auto.calimero.log	Provides a small logging framework used by Calimero for offering information to users of the library.
tuwien.auto.calimero.mgmt	Contains KNX property and management services.
tuwien.auto.calimero.process	Provides high level process communication.
tuwien.auto.calimero.serial	Connection support for communication over a serial port, using the FT 1.2 protocol.
tuwien.auto.calimero.xml	Provides a simple interface for reading and writing XML documents.
tuwien.auto.calimero.xml.def	A default implementation of the XML interfaces.

This document is the API specification for Calimero 2.0.

Calimero was developed at the A-Lab, Automation Systems Group, Vienna University of Technology.
The source and documentation is hosted on SourceForge.

Licence

Calimero is Open Source.
Pay attention to the copyright declarations and license agreements. See the license text file that ships with every Calimero distribution for more details.

General rules of usage for this API

No null arguments are allowed, if not explicitly stated otherwise in the documentation of the interface or method declaration. This means, applying a method -- which expects arguments of reference type -- to a null argument will lead to undefined behavior.
In the absence of other explicit specification in type API comments, instances of types are thread-safe, that is, concurrent access is allowed.

A user application can obtain general information like the current library version, available bundles and similar by using tuwien.auto.calimero.Settings.