House automation controller.

This repository has been archived because this source code has moved to its mother project

Used to control switches, dimmers, heaters and sensor.

This program is able to run standalone, but it's better worth using with Angharad system.

Benoic implements an interface to control multiple types of house automation devices. To add a new device type, you have to create a library with the proper functions, then place the library in the folder specified by modules_path in your configuration file, then restart the program.

Check Benoic devices modules How-To for more information on how to build a device module.

On Debian-based systems (Debian, Raspbian, Ubuntu), use the following comand to install dependencies:

sudo apt-get install libmicrohttpd-dev libjansson-dev libcurl4-gnutls-dev libmysqlclient-dev libsqlite3-dev libconfig-dev

git clone https://github.com/babelouest/orcania.git
cd orcania
make
sudo make install

git clone https://github.com/babelouest/yder.git
cd yder/src
make
sudo make install

git clone https://github.com/babelouest/ulfius.git
cd ulfius/src
make
sudo make install

git clone https://github.com/babelouest/hoel.git
cd hoel/src
make
sudo make install

You need gcc and Make to compile the program.

External libraries are mandatory to compile Benoic:

• libconfig, Configuration File Library
• jansson, json manipulation library
• libmicrohttpd, HTTP server library
• libcurl, HTTP client library
• MySQL client API, MySQL/MariaDB API
• SQLite3, SQLite API

Also, Benoic is based on Angharad libraries to work:

• Orcania, Potluck with different functions for different purposes that can be shared among angharad programs
• Yder, Logging library
• Ulfius, Web Framework for REST Applications
• Hoel, Database abstraction library

Benoic implements a ZWave module to control ZWave nodes. It's based on the OpenZwave library. You must download and install this library before installing benoic zwave device module, version 1.2 or above, preferably a stable version.

When all prerequisites are installed, clone benoic from github:

git clone https://github.com/babelouest/benoic.git
cd benoic
make release-standalone

Go to Benoic modules directory, then compile the modules you need. If you don't need/have a zwave dongle, you can skip this part.

cd device-modules
make libdevzwave.so

Go back to benoic source folder, then as root, run make install:

cd benoic
sudo make install

Depending on your needs, you can use a sqlite3 database (single file, fast and reliable) or a MySQL Database (fast and reliable as well but also more secure).

Run the SQL script benoic.mariadb.sql file under an already existing database.

mysql < benoic.mariadb.sql

Run the SQL script benoic.sqlite3.sql file in an existing or a new SQLite3 database file:

sqlite3 benoic.db < benoic.sqlite3.sql

The file benoic.conf.sample contains a sample file with all the configuration parameters needed, just fill the parameters with your own environment. Paths can be relatives or absolute.

Copy benoic.conf.sample into your configuration folder as benoic.conf

cp benoic.conf.sample /usr/local/etc/benoic.conf

To run benoic, simply execute the command:

/usr/local/bin/benoic --config-file=/usr/local/etc/benoic.conf

Check the log messages in the log file, syslog or the console, depending on your configuration, then the server will be up and running when you'll se the following log message:

yyyy-mm-dd hh:mm:ss - Benoic INFO: Start benoic on port 2642

The full API Documentation can be found in the file API.md:

• Benoic API