Repository files navigation

TheHome2L[houmtu:l] suite is a collection of tools and libraries for automation in private homes. Its main features are:

• Home2L Resources: Novel concept to integrate and manage sensors, actors or services of any kindefficiently and precisely.

• Automation rules written in Python - but not limited to that.

• Easy integration of services and new devices - via MQTT, in C/C++, Python or by a shell script.

• Home2L Brownies: Simple and efficientautomation bus to interconnect cheap 8-bit microcontrollersfor do-it-yourself sensor or actor hardware.

• Home2L WallClock:Lightweight, concise, and responsive information display,suitable to be installed on cheap tablets or minicomputers and mounted in all rooms - just like a wall clock.

• Interactive floor plan for all kinds of gadgets (windows, shades, lights, phones, computers, services, ...).

• Video door phone andinter-room communication (SIP-based).

• Playing music anywhere at home (MPD-based).

• Family calendar (inWallClock).

• Docker image and improved tutorial for getting started quickly.

• WallClock: Power meter for votovoltaic systems

• WallClock: User-configurable floorplan icons

• WallClock: Improved and more self-contained Android app

• MQTT bridge: Support for JSON payloads

• New drivers: Fingerprint, Fronius

• Many small improvements and some bug fixes

The main place of documentation is theHome2L Book.The APIs for developing rules and drivers or to extend theHome2Ls are documented with Doxygen:C/C++ API,Python API.

The suite comes with aDocker Demo Image allowing to test the suite easily.TheHome2L Book contains aa step-by-step tutorial demonstrating the key features of theHome2L suite.

For the brave and the impatient:

$ xhost +local:  # allow X11 applications to open windows$ docker run -ti --rm \  --name home2l-showcase --hostname home2l-showcase \  -e DISPLAY=$DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix \  --ipc=host --device /dev/snd \  gkiefer/home2l

The central component of theHome2L suite is theResources library. It connects physical sensors and actors, software services, computers and more. Everything that can act or sense in the widest sense, can be modelled as aresource in theHome2L suite.

Allresources are arranged in a common namespace, but driven and accessed in a completely distribited way from any computer. They can be manipulated or read out using the library, which provides full network transparency and supports arbitrary concurrent accesses from any process on any machine anytime.

Resources are manipulated by means of independentrequests with individual attributes like priorities and time intervals. The user pushes a button to open the window blinds. One second later, a timer-triggered automatic rule tells the blinds to close. What should happen now? Therequest model allows to clearly specify priorities (e.g. user interaction in favor of automation rules) and to handle concurrency properly.

TheHome2L Shell is a powerful administration tool and allows to access resources and submit requests on the command line or by shell scripts.

Both automation rules and resource drivers can also be part of a larger program. Any software linking against theResources library can access resources or publish own run-time information as resources.

All core components are written in C/C++, with a very minimum set of external dependencies beyondlibc - ideally suited for small embedded devices and microcontrollers. There is no need for a Java runtime environment or a heavy web framework. Starting up a server and a command shell and shutting both down again takes less than a second altogether - on an ARM-based minicomputer running at 144 MHz!

TheHome2L WallClock is written in native code (C++) and only usesSDL2 for its UI toolkit. This makes it very portable and lightweight. Low-cost, low-performance minicomputers or Android tablets can be used as end-user devices, there is no need to install and regularly update a full-featured web browser on them.

Central servers are single points of failure.Home2L follows a completely distributed concept. Any (mini-)computer can act as part of the network. If resources, such as sensors or actors, are connected to them, they can be exported to any other host in theHome2L network. A failure of a host only causes its own resources to be unavailable - everything else keeps on working.

There is no new language or tool to learn to formulate automation rules.Home2L rules written in Python profit from the simplicity and power of the Python language. There can be multiple rules scripts, they can run on any machine, and they may be combined with other software routines or be part of larger applications.

Other ways to interact withHome2L resources is via the C/C++ API from any application or by shell scripts using theHome2L Shell.

MQTT-enabled devices can be imported directly using the MQTT gateway driver.

An API forresource drivers allows to easily add support for new hardware or services. A driver can be implemented

• in native C/C++ code,
• as a shell script,
• in Python.

For all three cases, documented examples are available in the source tree.

Home2L Brownies are programmed low-cost microcontrollers (AVR ATtiny 84/85/861) connected to a Linux host over 4-wire cables (e.g. KNX/EIB cables). The bus protocol is based oni2c, robust and allows to build very simple, self-made hardware nodes. Just anATtiny device and two resistors are enough to build a sensor node! Additional circuitry such as crystal clock generators, transceivers or voltage regulators are not necessary.

Home2L Brownies can drive, for example, window/door/light sensors (GPIOs), temperature sensors, or window shades/actuators.

TheHome2L suite includes a software stack for the Linux (host) and for the microcontroller (device) side. The protocol includes various mechanisms for error correction/avoidance, host notification, as well as a variety of maintenance tools for remote configuration, diagnosis, collection of statistics, remote software updates, and device resurrection for the case that a software update failed and the device is difficult to reach physically.

TheHome2Ls do not need an Internet connection and do not try to communicate with hosts other than they are configured to. By design, theHome2Ls communicate with each other over a (trusted) LAN, which can easily be set up and secured using standard Linux/UNIX techniques. The open source licensing ensures transparency for what the software does inside the user's private home.

The core part, theResources library, is kept small and portable with APIs for application programsand drivers in C/C++ and Python. All other components are optional and can be used or replaced by alternatives as desired by the user.

The code has been published with the hope that is useful to the community. To let the project grow further and make available to a broader audience,volunteers and partners are welcome.

Great contributions are:

• Report and help fixing bugs.

• Makesample installations, document them and share your experiences.

• Packaging: Create packages for major Linux distributions.

• Documentation: Write good documentation, particularly for end users.

For any questions on how to participate, do not hesitate to contact us directly.

Feel free to contact: Gundolf Kiefer<gundolf.kiefer@web.de>