Module Description (Deprecated)

The Automation ESH Module implements the Rule Engine which provides means for automatic execution of predefined actions.

Network technologies cut across many areas of modern day living. IoT use cases range from intelligent infrastructure and smart cities to health care and shopping assistants. More and more devices have been presented in a complicated and various environment. From the client's perspective a problem comes out - how to manage and control these increasing various devices efficiently and conveniently so as to achieve more comfortable, secure and healthy space for living.

The main purpose of the Automation Eclipse SmartHome (ESH) Module is to provide a solution for the above problem - a smart control system based on the technologies of Internet of Things. It should embrace the functions of monitor, control and management, security, energy statistics and analysis. Of course the Automation ESH module will not provide alone this functionality. Agility and extendability are required, so new requirements can be met and new abilities provided. It is designed to collaborate with other modules that are part of the solution.

The Home Automation Manager API and Eclipse SmartHome API are deprecated and incompatible with the new Automation API. For details on mapping, replacements and recommendations refer to Migrating from Automation ESH API.

Feature Set

The module provides the following features and functionalities:

Rules and Rule Engine
Modules and Module Handlers
Rule Templates
Providers
REST API
Admin API
Web Console Plugin

More information on every component can be found in the System Architecture page.

Known Issues and Limitations

The API of this module is based on Eclipse SmartHome 0.8.0 which is not final and is subject to changes or separation in future releases that might be incompatible.

Module Dependencies

The Automation ESH module works in the OSGi environment and has dependencies on the following:

Framework: The OSGi Runtime is required for the module to operate.
Functional Item Management (FIM) Module is required for the Automation ESH Rule, Module Type and Template Admins which are implemented as Functional Items. They are used to manage the Automation ESH objects. Additionally, the FIM Module is required for handling an Automation ESH modules that are part of the Automation ESH rules and use Functional Items to implement their logic.
Scripting module is required for handling an Automation ESH modules that are part of the Automation ESH rules and use scripting languages to implement their logic.
REST module simplifies the communication between Automation ESH module and other systems or cloud services.
GSON is responsible for parsing the Automation ESH JSON resources providing Rules, Module Types or Templates.
Working with Web Console is required for the Automation ESH Web Console Plugin functioning.

Licensing Information

Check Third-Party Licenses.