Overview (Calimero-core Library 2.2.1 API)

Packages
Package	Description
tuwien.auto.calimero	Base package of the Calimero library.
tuwien.auto.calimero.buffer	Support for temporary storage of KNX network messages. This is done by using a network buffer with one or more configurations added to it.
tuwien.auto.calimero.buffer.cache	Cache interface for different caching policies. The main use in Calimero is to cache state and event information of KNX group objects.
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.
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.internal	Contains common functions and helper classes for internal use by the Calimero 2 library.
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.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-Core 2.2.1.

Calimero 2 was developed at the Vienna University of Technology, Automation Systems Group.
Development and documentation of the Calimero project is hosted on GitHub.
More information about other projects for KNX can be found here.

Licence

Calimero is Open Source. The software in this package is distributed under the GNU General Public License (GPL), version 2, with the Classpath Exception. Pay attention to the copyright declarations and license agreements. See the LICENSE.txt 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.