Es gibt zurzeit drei verschiedene Datenbank Plugins:

• database
• sqlite
• sqlite_visu2_8

Wenn Du neu mit SmartHomeNG beginnst, solltest Du das Plugin database verwenden. Das database Plugin unterstützt sowohl MySQL Datenbanken, als auch SQLite Datenbanken. Welcher Datenbank-Typ verwendet wird, wird in ../etc/plugin.yaml konfiguriert.

sqlite und sqlite_visu2_8

Die beiden SQLite Plugins dienen nur der Rückwärts-Kompatibilität für bestehende SmartHomeNG bzw. smarthome.py Umgebungen und werden nicht mehr weiterentwickelt.

Das Plugin sqlite unterstützt smartVISU bis zur Version v2.7.

Zur Unterstützung von smartVISU v2.8 und v2.9 muss das Plugin sqlite_visu2_8 verwendet werden. Das Plugin führt beim ersten Start eine Konvertierung der Datenbank von sqlite auf das sqlite_visu2_8 Format durch. Einen Weg zurück gibt es dann nicht. Es sollte also vorher eine Sicherung der Datenbank Datei ../var/db/smarthome.db durchgeführt werden.

Wichtig: Vor Beginn der Sicherung SmartHomeNG beenden.

Eine Routine zur Konvertierung der Datenbanken der sqlite Plugins zu einer Datenbank für das database Plugin gibt es (noch) nicht.

Es existiert ein neues InfluxDB Plugin für SmartHomeNG, das es ermöglicht Meßwerte in eine Influx Datenbank zu schreiben. Die Influx Datenbank wurde entwickelt als quasi eine SQL-ähnliche Datenbank für zeitabhängige Meßreihen. Viele Nutzer des Smarthome.py bemängelten, das eine RRD Datenbank einfach Werte ausdünnt im Laufe der Zeit und andererseits der Ansatz mit der SQLite nicht genau genug ist.

Achtung: Debian Jessie (8.x) Die neueren Linux Versionen setzen zunehmend auf systemd. Start/Stop Skripte werden nicht mehr gebraucht. Diese Anleitung berücksichtigt den systemd derzeit nicht.

Vorbedingung

Die folgende Anleitung geht davon aus, das ein stabiles System vorliegt mit Ubuntu 14.04.3 oder Debian als 64-bit Variante. Ihr könnt testen, welches System bei Euch installiert ist mit:

uname -i

Das ergibt für ein 64 Bit System x86_64. Alternativ geht auch

getconf -a | grep LONG_BIT

(Alternativ kann man auch die Sourcen für InfluxDB holen und eine 32 Bit Version bauen. Allerdings sprengt das den Rahmen dieses How-to.

Für alle weiteren Installationsschritte nutzen wir eine Root Shell

sudo -i

Nun installieren die InfluxDB Datenbank mit

wget https://s3.amazonaws.com/influxdb/influxdb_0.9.4.1_amd64.deb
dpkg -i influxdb_0.9.4.1_amd64.deb

Jetzt muß Influx noch einmalig gestartet werden:

/etc/init.d/influxdb start

Damit das Plugin später auch Daten in eine Datenbank schreiben kann, legen wir eine Datenbank an. Dazu startet wir das influx command line interface:

/opt/influxdb/influx

Um die existierenden Datenbanken aufzulisten, geben wir das Kommando SHOW DATABASES ein. Da wir frisch installiert haben, sollten lediglich name und _internal gelistet werden. Nun erstellen wir eine neue Datenbank mit CREATE DATABASE smarthome

Installieren des InfluxDB Python Clients

pip install influxdb

Installieren des Plugins

Am einfachsten ladet ihr Euch das Plugin als ZIP runter und kopiert den Inhalt in ein neues Unterverzeichnis /smarthome.py/plugins/influx

Konfiguration des Plugins

plugin.conf

influxdb:
    class_name: InfluxDB
    class_path: plugins.influx
#   influx_host: localhost
#   influx_port: 8083
#   influx_user: root
#   influx_pass: root
#   influx_db: smarthome
    influx_keyword: influx

Der Eintrag influx_keyword legt fest, welche Daten in die Datenbank geschrieben werden. Ihr könnt entweder z.B. influx wählen und dann würde dieses item in die Datenbank geschrieben werden:

Vorlauftemperatur:
    name: Vorlaufemperatur
    type: num
    knx_dpt: 9
    influx: true
    visu_acl: rw
    knx_init: 8/1/1
    cache: on

Eine Superidee des Entwicklers ist es jedoch als influx_keyword nun sqlite auszuwählen, dann werden alle Daten die in die SQLite Datenbank geschrieben werden zugleich auch in die Influx Datenbank geschrieben.

Nun müßt ihr noch smarthome.py neu starten, damit das Plugin auch genutzt wird.

Installieren von Grafana

Damit die Daten nun auch hübsch präsentiert werden können, installieren wir uns noch ein grafisches Frontend Grafana.

Wir nutzen wieder unsere Root Shell und erweitern unsere Liste für Repositories:

sudo -i
nano /etc/apt/sources.list

Dorthin idealerweise ganz unten einfügen:

deb https://packagecloud.io/grafana/stable/debian/ wheezy main

Jetzt müssen wir noch den Schlüssel holen damit wir signierte Packages installieren können:

curl https://packagecloud.io/gpg.key | sudo apt-key add -

Nächste Schritte sind aktualisieren der APT Datenbank und installieren von grafana

apt-get update
apt-get install grafana

Details der Grafana Installation:

Programm zu finden in /usr/sbin/grafana-server Das Init.d Skript liegt unter /etc/init.d/grafana-server, eine defaults Datei mit Umgebungsvariablen findet sich in /etc/default/grafana-server und eine Konfigurationsdatei in /etc/grafana/grafana.ini. Weiter gibt es noch ein Logfile zu finden unter /var/log/grafana/grafana.log und eine SQLite3 Datenbank als Basis für Grafana wird installiert unter /var/lib/grafana/grafana.db. Falls systemd vorhanden wird noch ein service installiert mit Namen grafana-server.service

Jetzt gilt es den Grafana Server zu starten mit

service grafana-server start

Jetzt könnt ihr auf den Grafana Server zuzugreifen mit der IP-Adresse und Port 3000. Benutzer und Passwort sind admin.

Damit der Grafana Server bei jedem Systemstart mitstartet, müssen wir ihn noch eintragen:

update-rc.d grafana-server defaults 95 10

So, nun sollte das ganze funktionieren. Bevor ihr an das Frontend vom Grafana geht, solltet ihr erstmal ein wenig Daten sammeln.

Datenverbindung zur Influx Datenbank

Wie oben müßt ihr mit Eurem Browser nun auf Port 3000 auf den Grafana Server zugreifen. Dort könnt ihr Euch dann mit Benutzer admin und Passwort admin anmelden. Der nächste Schritt ist die Einrichtung der Datenverbindung. Dazu wählt ihr Data Sources aus und dann oben in der Leiste Add New. Danach gebt Ihr als Name influxdb ein und als Type influxDB 0.9.x; den Haken bei default setzt man zweckmäßigerweise auch. Bei den http-Settings gebt Ihr diehttp://<IP>:8086, Access auf direct. Bei den InfluxDB Details als Datenbank smarthomemit User = root und Passwort root. Jetzt sollte Test Connection erfolgreich sein. Mit Klick auf Save seid Ihr jetzt einsatzfähig.

Erstes Dashboard anlegen

Ihr klickt jetzt auf Dashboards und anschließend auf Home. Weiter unten könnt Ihr nun +Newauswählen um ein neues Dashboard zu erzeugen. Wenn das geschehen ist, gibt es ein kleines grünes Rechteck. Darauf klickt ihr und dann weiter auf Add Panel und im Submenü Graph. Jetzt erscheint ein leeres Feld mit einem roten Ausrufezeichen in der oberen linken Ecke und einer Überschrift no title (click here). Darauf klickt ihr nun und wählt aus dem Popup Dialog Edit aus.

Unter Metrics ist jetzt eine Abfrage. Dort könnt Ihr – wenn bis dato alles richtig verlaufen ist und schon Werte in der Influx Datenbank zu finden sind – unter FROM select measurement eure erste Datenreihe eintragen. Ein Klick ganz oben auf das Diskettensymbol speichert nun das dashboard. Der Rest geht am besten über ausprobieren. Ein Klick auf den Farbstrich der Datenreihenlegende erlaubt es zu wählen ob die linke oder rechte Achse zur Anzeige genommen und welche Farbe zur Anzeige verwendet wird.

Viel Spaß!

Leitfaden zur Umstellung auf das Database Plugin in Kombination mit MySQL/MariaDB

Motivation

Das Database Plugin setzt auf einer Neuimplementierung der Datenbankanbindung auf, bei der nicht wie beim bisherigen SQLite Plugin alte Daten „aufgeräumt“ werden, sondern jeder Datensatz behalten wird. Dies kann zu sehr großen Datenbeständen führen, für die eine „echte“ Datenbank wie MySQL oder MariaDB sinnvoller ist. Auch können diese Datenbanken mit PhpMyAdmin sehr leicht administriert / betrachtet werden.

Wichtig: Eine Nutzung mit SQLite ist auch weiterhin mit dem Database Plugin möglich, so dass ein Wechsel zu anderen Datenbanken nicht zwingend notwendig ist.

Dieser Leitfaden soll trotzdem dazu dienen, den Umstieg zu erleichtern und motivieren.

Installation von MariaDB

Eine sinnvolle Alternative zu SQLite ist Maria DB (ein Fork von MySQL). Mit dem Database Plugin sind jedoch auch andere Datenbanken mit Kompatibilität zur Python DB API 2 möglich. Auch das klassische MySQL kann verwendet werden.

sudo apt-get update
sudo apt-get install mariadb-server
# alternativ
# sudo apt-get install mysql-server

Die Installationsroutine fordert dabei zur Eingabe eines Passworts für den User „root“ auf. Hier ist darauf zu achten, ein möglichst sicheres Passwort zu wählen.

Einrichtung einer DB und eines DB Users für SmartHomeNG

Als nächstes sollte eine eigene MariaDB Datenbank mit eigenem User für SmartHomeNG erstellt werden, da die Verwendung des Root Users aus Sicherheitsgründen (globale root Rechte) nicht zu empfehlen ist.

Dazu sollte wie folgt vorgegangen werden:

Einloggen in MariaDB als root (befehl „mysql“) mit vergebenem Passwort

mysql -u root -p

Datenbank / User für SmartHomeNG erstellen

In der nun folgenden Shell – jede Zeile mit den jeweiligen Werten befüllen und mit ENTER bestätigen:

CREATE DATABASE smarthome_db;
CREATE USER 'smarthome'@'«ip of your SmartHomeNG server»' IDENTIFIED BY '«password»';
GRANT ALL PRIVILEGES ON smarthome_db.* TO 'smarthome'@'«ip of your SmartHomeNG server»';
FLUSH PRIVILEGES;

Wichtig: Falls die Datenbank auf dem gleichen Server wie SmartHomeNG betrieben wird, muss anstatt der IP die 127.0.0.1 und ggf. localhost via jeweiligen GRANT ALL ... Statements freigegeben werden.

(Optional) Prüfen der Einstellungen:

Auf die Datenbank lokal als root einloggen, mysql -u root -p. Mittels show databases; kann man nun prüfen, ob eine Datenbank namens smarthome_db erstellt wurde. Der neue User ist in der Datenbank mysql in der Tabelle users zu finden:

use mysql;
select Host, User from user;

Im Output sollte nun eine Zeile mit IP des SmartHomeNG Servers und dem User „smarthome“ sichtbar sein.

Die vergebenen PRIVILEGES auf die smarthome_db sind via

select Host, Db, USer from db; 

zu sehen. Auch hier sollten der Username, die IP und die Datenbank auftauchen.

Mit exit geht es zurück zur Shell.

SmartHomeNG und Datenbank auf getrennten Maschinen/IPs

Sind SmartHomeNG und Datenbank getrennt, muss zusätzlich der Eintrag bind-address in der /etc/mysql/my.cnf angepasst werden. Dieser kann entweder auskommentiert werden (jeder Rechner kann mit Angabe von User und Passwort auf die DB verbinden) oder explizit die IP des SmartHomeNG Servers gesetzt werden. Mehrere IPs sind nicht möglich. Soll daher auch vom Datenbank-Server zugegriffen werden (bspw. für ein dort installiertes PhpMyAdmin) hilft nur auskommentieren und das setzen entsprechender Firewall Regeln.

...
[mysqld]
...
# Instead of skip-networking the default is now to listen only on
# localhost which is more compatible and is not less secure.
#bind-address           = 127.0.0.1 (auskommentiert)
#oder alternativ
bind-address            = «IP des SmartHomeNG Servers»
...

Nach dem Speichern muss der Dienst mit sudo service mysql restart neu gestartet werden.

Vorbereitung des SmartHomeNG Servers für die Nutzung via Database Plugin:

Detaillierte Informationen siehe https://github.com/smarthomeNG/plugins/tree/master/database

Nach erfolgter Installation der Datenbank, muss auf dem SmartHomeNG Server das entsprechende Paket für Python3 installiert werden:

sudo pip3 install --upgrade pymysql

Achtung: Das sehr ähnlich klingende pymsql3 sollte nicht mehr verwendet werden (würde theoretisch mit dem Plugin aber auch funktionieren).

Das Database Plugin wird nun wie folgt in der plugin.yaml eingerichtet:

database:
    plugin_name: database
    driver: pymysql
    connect:
      - 'host:«ip des mariadb/mysql servers»'
      - 'user:smarthome'
      - 'passwd:«passwort des users smarthome»'
      - 'db:smarthome_db'

In den jeweiligen Items muss dann ein database@mysqldb: init erfolgen (oder das alte sqlite: init ersetzen).

Datenkonvertierung von SQLite

Das Datenbank Plugin nutzt intern ein anderes Format als die alte smarthome.db Datenbank. Wenn die Daten weiterhin genutzt werden sollen (historische Daten), dann müssen sie konvertiert werden ins neue Format.

Dazu muß auf der Shell ins SmartHomeNG Basisverzeichnis gewechselt und dann ein Konvertierungsscript aufgerufen werden:

cd /usr/local/smarthome
python3 plugins/database/>convert ./var/db/smarthome.db ... . # gibt es leider noch nicht ;)

todo: Skript schreiben für die Migration

Abschluß

Nachdem die Änderungen an den Items durchgeführt sind und die Konvertierung erfolgt ist, muß SmartHomeNG neu gestartet werden.

Installation der InfluxDB Datenbank

Damit SmarthomeNG Meßwerte loggen kann existiert eine Schnittstelle zur SQLite Datenbank. Als Alternative für umfangreichere Auswertungen und mehr Performance gibt es ein neues Plugin um Meßdaten in eine Influx Datenbank zu schreiben. Die Influx Datenbank wurde speziell entwickelt für Meßwerte mit Zeitstempeln. Sie verfügt über Schnittstellen zu gängigen Programmiersprachen und es gibt eine interaktives Command Line Interface.

Vorbedingung

Die folgende Anleitung geht davon aus, das ein Debian Jessie System als 64-bit Variante vorliegt und damit der systemd benutzt wird um Dienste zu starten und zu beenden. Ihr könnt testen, welches System bei Euch installiert ist mit:

getconf -a | grep LONG_BIT

Das ergibt für ein 64 Bit System LONG_BIT 64.

(Alternativ kann man auch die Sourcen für InfluxDB holen und eine 32 Bit Version bauen. Allerdings sprengt das den Rahmen dieses How-to.

Zunächst der Download der InfluxDB Datenbank mit

wget https://dl.influxdata.com/influxdb/releases/influxdb_0.12.2-1_amd64.deb
sudo dpkg -i influxdb_0.12.2-1_amd64.deb 

Jetzt muß Influx noch einmalig gestartet werden:

sudo systemctl start influxdb.service

Ob die Datenbank nun im Hintergrund läuft, läßt sich prüfen mit

sudo systemctl status influxdb.service

Damit das Plugin später auch Daten in eine Datenbank schreiben kann, legen wir eine Datenbank an. Dazu starten wir das influx command line interface:

influx

Um die existierenden Datenbanken aufzulisten, geben wir das Kommando SHOW DATABASES ein. Da wir frisch installiert haben, sollten lediglich name und _internal gelistet werden. Nun erstellen wir eine neue Datenbank mit

CREATE DATABASE smarthome

Zur Prüfung geben wir erneut das Kommando SHOW DATABASES ein. Das Ergebnis sollte nun sein:

name: databases
---------------
name
_internal
smarthome

>

Mit quit kann das Command Line Interface wieder verlassen werden.

Installieren des InfluxDB Python Clients

Um die InfluxDB mit Python und damit mit SmarthomeNG nutzen zu können, bmuß noch ein passendes Zugriffsmodul installiert werden:

sudo pip3 install influxdb

Installieren des Plugins

In den nächsten Versionen von SmarthomeNG (> V1.1) wird das Plugin sicher Bestandteil des Masters werden. Bis es soweit ist, muss es nachinstalliert werden:

cd /usr/local/smarthome/plugins
mkdir influx
cd influx
wget https://github.com/SgtSeppel/smarthome-influxdb/archive/master.zip
unzip -j master.zip
rm master.zip

Konfiguration des Plugins

plugin.yaml

influxdb:
    class_name: InfluxDB
    class_path: plugins.influx
#   influx_host: localhost
#   influx_port: 8083
#   influx_user: root
#   influx_pass: root
#   influx_db: smarthome
    influx_keyword: influx

Der Eintrag influx_keyword legt fest, welche Daten in die Datenbank geschrieben werden. Ihr könnt entweder z.B. influx wählen und dann würde dieses item in die Datenbank geschrieben werden:

Vorlauftemperatur:
    name: Vorlaufemperatur
    type: num
    knx_dpt: 9
    influx: true
    visu_acl: rw
    knx_init: 8/1/1
    cache: on

Eine Superidee des Entwicklers ist es jedoch als influx_keyword nun sqlite auszuwählen, dann werden alle Daten die in die SQLite Datenbank geschrieben werden zugleich auch in die Influx Datenbank geschrieben.

Nun müßt ihr noch smarthome.py neu starten, damit das Plugin auch genutzt wird.

Wenn nun das Frontend Grafana genutzt werden soll um unabhängig von einer Visu auf dir nun frisch geloggten Daten zuzugreifen, dann bitte bei der Anleitung für Grafana fortfahren.

sql:
    plugin_name: database

Anschliessend wird im Item die Aufzeichnung aktiviert mit ‚database: yes‘ bzw. ‚database: init‘. Nun können weitere Items angelegt werden, die mit Hilfe einer Funktion, die das database-Plugin bereitstellt, die benötigten Werte erhalten.

Das ganze sieht dann in etwa wie folgt aus:

sensor:
    carport:
        temp:
            type: num   
            knx_dpt: 9  
            knx_send: 3/4/11  
            knx_reply: 3/4/11
            ow_addr: '28.52F1AA030000'
            ow_sensor: T 
            database: init  # Aufzeichnung der Daten aktivieren
            min:
                type: num
                knx_dpt: 9
                knx_send: 3/4/14
                knx_reply: 3/4/14
                eval: "sh.sensor.carport.temp.db('min', '28h')"  # Mimium über die letzten 28h berechnen
                eval_trigger: sensor.carport.temp  # Änderungen der Temperatur triggern die Neuberechnung
            max:
                type: num
                knx_dpt: 9
                knx_send: 3/4/15
                knx_reply: 3/4/15
                eval: "sh.sensor.carport.temp.db('max', '28h')"  # Maximum über die letzten 28h berechnen
                eval_trigger: sensor.carport.temp   # Änderungen der Temperatur triggern die Neuberechnung