Quick-Start

Installation

Zunächst installieren Sie FHEM auf der von Ihnen bevorzugten Serverhardware. Sollten Sie noch unschlüssig sein, welche Serverhardware und welches Betriebssystem die beste Wahl für Sie ist: Viele User verwenden einen Raspberry Pi, als Betriebssystem ist darauf Raspbian in der lite-Version (ohne GUI) zu empfehlen. Die hierfür erforderlichen Ausgaben halten sich in Grenzen und eine vorhandene Installation auf einen anderen Server umzuziehen, ist in der Regel mit wenig Aufwand ohne weiteres möglich.

Bei Installation über ein Debian-Paket erfolgt der Start von FHEM automatisch mit jedem Start des Betriebssystems.

Für die Installation selbst befolgen Sie die unter https://fhem.de/#Installation für das jeweilige Betriebssystem angegebenen Schritte und starten FHEM.

Danach sollten die Einträge im FHEM-Logfile des Log-Verzeichnisses wie folgend aussehen:

   2012.10.27 17:14:28 1: Including fhem.cfg
   2012.10.27 17:14:28 3: WEB: port 8083 opened
   2012.10.27 17:14:28 3: WEBphone: port 8084 opened
   2012.10.27 17:14:28 3: WEBtablet: port 8085 opened
   2012.10.27 17:14:28 1: Including /tmp/fhem.save
   2012.10.27 17:14:28 3: telnetPort: port 7072 opened
   2012.10.27 17:14:28 1: usb create starting
   2012.10.27 17:14:28 1: usb create end
   2012.10.27 17:14:28 2: SecurityCheck:  ...
   2012.10.27 17:14:28 0: Server started (version Fhem 5.8 ...

Die Sicherheits-Warnung sagt Ihnen, dass einige der FHEM-Webseiten ohne die Eingabe eines Passwortes geöffnet worden sind. Sie sollten entweder mindestens ein allowed-Device definieren, wie weiter unten angegeben, oder das globale Attribut setzen um diese Meldung zu unterdrücken wenn Sie ganz sicher sind, dass keine Sicherheitsmaßnahmen zur Absicherung Ihrer Installation erforderlich sind.

Kontakt zu FHEM aufnehmen

Für die weitere Konfiguration von FHEM können Sie entweder die telnet-Schnittstelle nutzen, oder Sie verbinden Sie sich mit FHEM, indem Sie im Internet-Browser bei Verwendung eines normalen Desktop-Rechners http://fhem-host:8083/fhem eingeben. Für Geräte mit kleineren Bildschirmen wie Smartphones können Sie eine http://fhem-host:8084/fhem eingeben, bzw. http://fhem-host:8085/fhem bei Verwendung eines Tablets oder iPads.

Sicherheit

allowed und SSL

Beide Standard TCP/IP Weboberflächen in FHEM (telnet und FHEMWEB) können mit einem Passwort und zusätzlich mit Verschlüsselung (HTTPS/SSL) gesichert werden. Definieren Sie dazu zunächst ein oder mehrere allowed-Geräte. Die Anleitung dazu finden Sie in der commandref (https://fhem.de/commandref_DE.html#allowed), oder indem Sie in der Kommandozeile der Web-Schnittstelle "help allowed" eingeben. Zusätzlich können Sie für FHEMWEB HTTPS Attribute festlegen, für telnet (welches mehr oder weniger ein TCP/IP Port ist) benutzen Sie das SSL Attribut. Anleitungen hierzu sind ebenfalls in der commandref zu finden.

Das ist jedoch nicht der Standard für die meisten Konfigurationen und es ist der Grund weshalb Sie eine Sicherheitswarnung nach der Installation erhalten. Ist keine allowed-Instanz definiert, sind Zugriffe auf FHEM nur innerhalb desselben Netzwerks möglich.

VPN

Ein anderer Weg, einen sicheren Zugriff von Aussen auf FHEM zu erhalten, ist es eine VPN-Verbindung zu verwenden. Die Verbindung z.B. zu einer FRITZ!Box mittels VPN funktioniert sowohl für Geräte mit iOS als auch mit Android Betriebssystemen, obwohl letzteres im Setup komplizierter ist.

ReverseProxy

Sie können FHEM auch durch Nutzung eines ReverseProxy-Servers wie z.B. eines Apache-Servers absichern.

USB Geräte

Wenn Sie dieses Modul benötigen, können Sie es mit dem Kommando sudo cpan Device::SerialPort nachträglich installieren. Es gibt aber auch schon bereits vorkompilierte Debian-Pakete (libdevice-serialport-perl) und im OSX 10.5 ist das Paket auch bereits enthalten. Wenn Sie das Paket nicht installieren können, dann schauen Sie sich die @directio-Option auf der commandref.html-Seite als mögliche Informationsquelle an.

Viele FHEM-Installationen verbinden die Außenwelt über ein USB-Gerät welches mit dem FHEM-Rechner verbunden ist (diese Geräte sind z.B. CUL, FHZ1x00, TUL, EUL etc). Diese Installationen benötigen die Perl serial-Module. In dem commandref-Abschnitt des jeweiligen USB-Gerätes sehen Sie, ob das entsprechende Modul benötigt wird. Das gilt ensprechend, wenn Sie Geräte über die serielle Schnittstelle einbinden möchten, die an den GPIO-Schnittstellen eines Raspberry Pi verfügbar sind. Sie benötigen dieses Modul nicht, wenn das Gerät über Ethernet angeschlossen wird (z.B. HM-LAN oder CUNO).

Schließen Sie dann eventuell vorhandene USB-Geräte an den PC an (CUL/FHZ1x00PC etc.).

Automatische Konfiguration

In der Standard-Konfiguration sucht FHEM beim Start nach über USB verbundenen Geräten wie FHZ, CUL, COC, ZWave oder TCM und erstellt automatisch die entsprechenden Einträge in der fhem.cfg. Schließen Sie also diese Geräte vor dem Start von FHEM an bzw. starten FHEM mit "shutdown restart" in der Kommandozeile, nachdem Sie die Geräte angeschlossen haben.

Unter einem Linux-Betriebssystem wird FHEM gegebenenfalls versuchen, einen bereits angesteckten aber noch unprogrammierten CUL zu programmieren. Details dazu entnehmen Sie bitte den Beschreibungen der Befehle usb und CUL flash in der commandref. Die neu angelegten Geräte werden im Raum/Menüpunkt "Unsorted" angezeigt. Für die so eingebundenen Geräte müssen dann in der Regel noch weitere Einstellungen vorgenommen werden. Dies erfolgt durch das Setzen entsprechender Attribute. Die verfügbaren Attribute sowie teilweise auch konkret einstellbare Werte für die Attribute können Sie aufrufen, wenn Sie auf das entsprechende Gerät klicken.

Sofern Sie die automatische Konfiguration Ihrer USB-Geräte abgeschlossen haben, sollten Sie die automatische Erkennung deaktivieren, da diese in bestimmten Konstellationen auch verhindert, dass FHEM ordnungegemäß startet: attr initialUsbCheck disable 1

===Manuelle Konfiguration Um Geräte mit USB-Anschluss manuell zu definieren (oder falls FHEM diese nicht automatisch erkennt), schließen Sie das USB-Gerät (CUL, FHZ1000PC/FHZ1300, TUL, EUL, etc) zuerst an Ihren Computer an. Dann sehen Sie im Verzeichnis /dev nach der dort entsprechend eingetragenen Gerätebezeichnung. Für einen CUL wird eine Datei mit der Bezeichnung /dev/ttyACM* unter einem Linux-Betriebssystem und /dev/cu.usbmodem* unter dem Betriebssystem OS x angelegt. Beachten Sie die exakte Bezeichnung des Gerätes. Definieren Sie es in FHEM, indem Sie folgenden Eintrag in die FHEM Kommandozeile der Webseite eingeben:

   define CUL1 CUL /dev/ttyACM0@9600 1234

In der Commandref finden Sie in der Regel eine Darstellung in der folgenden Form: define <name> CUL <device> <FHTID>. Dabei sind alle Angaben mit Klammern dazu gedacht, dass Sie diese mit eigenen Werten (ohne Klammern) ersetzen.

Anmerkung: die Angabe "1234" oben ist beispielhaft und für Ihre Installation durch einen geeigneten eigenen Wert zu ersetzen. Details über die Parameter zur Definition eines CUL finden Sie im Abschnitt CUL der Commandref.

/*Anmerkung: Wäre hier nicht besser ein moderneres Gerät dargestellt? ZWDONGLE?*/

Ein FHZ-Gerät wird ebenso, aber mit anderen Parametern, angelegt

   define FHZ1 FHZ /dev/ttyUSB0

Achtung/Bemerkungen

- Vergessen Sie nicht, den save-Button (neben der FHEM-Befehlseingabezeile) zu drücken, wenn Sie die Eingabe einer Gerätedefinition oder die Änderung der Geräteattribute fertiggestellt haben. Andernfalls werden die erfolgten Eingaben nicht in der Konfigurationsdatei gespeichert und bei einem Neustart von FHEM nicht mehr berücksichtigt.

- Zur Ausführung von in der FHEM Befehlszeile eingegebenen Anweisungen drücken Sie Enter auf der Tastatur. Betätigen des save-Buttons führt diese eingegebenen Anweisungen nicht aus.

- Sie erhalten den CUL vom Hersteller ohne Firmware. Sie können ihn mittels des CULflash Kommandos programmieren, wenn das Programm dfu-programmer im Verzeichnis fhem vorhanden ist.

Einbinden und Konfiguration von Sensoren und Aktoren

autocreate

Viele funkgesteuerte Geräte werden in der default-Konfiguration wegen der voreingestellten autocreate-Funktion automatisch erstellt, sobald diese Werte senden.

Diese Funktion erstellt automatisch diese Geräteeintragungen bei Empfang einer Nachricht von diesen Geräten (z.B. eines Sensors wie dem S300 oder FHT). Bitte warten Sie eine gewisse Zeit, beobachten Sie die Logeinträge und aktualisieren Sie Ihren Browser um neu erreichte Geräte angezeigt zu bekommen. Die automatisch vergebenen Namen orientieren sich dabei an technischen Parametern.

Umbenennen

Wenn Sie das Gerät selbst umbenennen, werden auch die zugehörigen Logfiles und Weblinks automatisch mit umbenannt. Wenn Sie dagegen die Weblinks oder Logfiles umbenennen, werden die zugehörigen Geräte nicht mit umbenannt.

Sie können den Befehl rename benutzen, um automatisch erstellte Geräteeinträge umzubenennen. Geben Sie den Befehl mit den entsprechenden Parametern in der Befehlszeile der Webseite ein. Z.B.:

   rename FHT_1234 fht.kitchen 

Manuelles Anlegen

Wenn Sie das Gerät manuell anlegen wollen oder müssen, weil autocreate diese nicht anlegen kann, dann gehen Sie folgendermaßen vor:

Warten Sie eine Weile bis Daten übertragen werden. Im Logfile (zu erreichen unter Webseite Menüpunkt Unsorted-> FileLog -> Logfile -> text) erscheint z.B. folgende Textzeile:

   FS20 Unknown device <HOUSECODE>, Button <BTN> Code <CDE>, please define it  

Definieren Sie dieses neue Gerät mittels folgendem Eintrag:

   define piri1 FS20 <HOUSECODE> <BTN>  

Setzen sie das model-Attribut des Gerätes:

   attr piri1 model fs20piri  

Anschließend erhalten Sie nur noch die für dieses Gerät verfügbaren Attribute angezeigt. Hier sehen Sie eine komplette Liste der FS20 Modelle. Bei einem anderen neuen Geräten sollte eine ähnliche Nachricht im Logfile erscheinen.

HomeMatic Geräte müssen nicht mit FHEM gepairt werden, andererseits wird FHM solche Geräte nur automatisch eintragen wenn es eine pairing-Anfrage erhält. Dazu müssen Sie FHEM mit dem Befehl set CUL hmPairForSec 600 in Empfangsbereitschaft versetzen. Gleiches Vorgehen gilt für das pairing von ZWave-Geräten

Einbinden von Geräten, die Anlernbefehle benötigen

Manche Geräte benötigen Anlernsignale, um eine Koppelung mit anderen Geräten bzw. einer Zentrale wie FHEM herzustellen. Für solche Geräte muß zunächst manuell eine Konfiguration in FHEM vorgenommen werden, um solche Anlernsignale generieren zu können.

Definieren Sie z.B. ein FS20 Gerät mit z.B folgendem Eintrag in die fhem.cfg:

   define lamp1 FS20 1234 56

Dann drücken Sie den Anmeldeknopf an dem Gerät solange, bis die LED blinkt. Anschließend klicken sie auf den on Link auf der FHEM Webseite um das Kommando zu senden. Die LED sollte aufhören zu blinken. Das Gerät ist nun auf den Hauscode 1234 Gerätecode 56 programmiert. Sie können alternativ die 4-base ELV-Notation benutzen. Anschließend können Sie wieder modellspezifische Attribute ür das Gerät setzen. Z.B.:

   attr lamp1 model fs20st

Mit diesem Eintrag bekommen Sie nunmehr wieder nur die für dieses Gerät relevanten Kommandos angezeigt.

Das automatische oder manuelle Eintragen von FHT/HomeMatic/EnOcean-Geräten in FHEM bedeutet nicht automatisch, dass das betreffende Gerät mit FHEM gepairt ist bzw. das pairing erfolgreich abgeschlossen wurde!

Andere Systeme (EnOcean/HomeMatic/ZWave) brauchen eine umfangreichere Prozedur und das entsprechende Gerät muss zuerst in den pairing mode versetzt werden. Bitte sehen Sie sich den entsprechenden Eintrag auf der commandref.html-Seite für Ihr Gerät zur Information an.

Grundlegendes zum Steuern Ihrer Geräte

Sobald Ihre Sensoren und Aktoren in FHEM eingebunden sind, können Sie die Aktoren über telnet oder die WEB-Schnittstelle bereits steuern.

Für Einsteiger empfiehlt sich die Lektüre der [Einführung in die Automatisierung mit FHEM]. Diese ist in den wesentlichen Teilen weiterhin aktuell.

Für den Aufbau einer zeit- und ereignisorientierten Steuerung benötigen Sie jedoch weitere Steuerungselemente, die in FHEM "Module" genannt werden. Die in Ihrer FHEM-Installation bereits enthaltenen Module sind in der commandref dargestellt. Nachfolgend sollen kurz einige der wichtigsten Module vorgestellt werden:

Zeitabhängige Kommandos

Die einfachste Methode, zeitgesteuert Befehle ausführen zu lassen, ist ein "at". Entsprechende Beispiele und Definitionen finden Sie in der [commandref].

Reaktion auf Ereignisse

Um Kommandos ausführen zu lassen wenn ein Gerät eine Nachricht (ein "Event") aussendet, benötigen Sie einen sogenannten event-handler. Die einfachste Form eines solchen ist ein Gerät vom Typ notify.

Um die in FHEM auftretenden Ereignisse besser zu verstehen/erkennen sollten Sie ein weiteres Browser-Fenster mit dem "Event_Monitor" öffnen oder eine Telnet-Verbindung zu Ihrem FHEM aufbauen. Geben Sie z.B. in der Eingabeaufforderung folgendes ein:

   telnet <fhemhost> 7072

Nachdem die Verbindung aufgebaut wurde geben Sie ein:

   inform timer 

Nun sehen Sie in dieser telnet-Verbindung bzw. im Event-Monitor alle Ereignisse wie z.B.:

   2011-12-16 21:51:55 FS20 myPiri on-for-timer 120 

Gemäß diesem Eintrag können Sie eine Aktion wie folgt definieren:

   define lampNotify notify myPiri set myLamp on 

oder

   define lampNotify notify myPiri:on.* set myLamp on 

Um dieses notify zu testen können Sie die Ereignisse unter Verwendung des trigger-Kommandos simulieren. Z.B.:

   trigger myPiri on-for-timer 120 
    

at, notify und andere Eventhandler wie z.B. watchdog verwenden entweder vordefinierte FHEM-Kommandos, SHELL-Scripte oder Perl-oneliners als Argumente. Für Details und Tipps für perl onliners lesen Sie bitte die Perl-specials-Abschnitte in der commandref.html.

Daten aufzeichnen und darstellen

Loggen

Um Daten/Nachrichten/Ereignisse in einer Datei zu speichern müssen Sie ein Gerät vom Typ FileLog anlegen. Die Funktion autocreate erstellt für neu erkannte Geräte automatisch eine Logdatei. Sie können jedoch die Funktion createlog nutzen, um später eine weitere Logdatei hinzuzuügen.

Um Daten/Nachrichten/Ereignisse in einer Datenbank zu speichern informieren Sie sich im Verzeichnis contrib/dblog der FHEM Distribution.

FHEMWEB hat eine vordefinierte Funktionen Anzeige von Dateien des Typs FileLog. Weitere Informationen im folgenden Abschnitt plot.

Die Geräte einer jeden Logdatei (FileLog)wird durch die eingegebenen Logkriterien (z.B. Jahr/Monat/Woche/Tag) bestimmt. Sie k?nen das Archivieren mit den Attributen nrarchive oder archivecmd erlauben.

Inhalte von Logdateien plotten (zeichnen)

Die Funktion autocreate erstellt Weblinks (d.h. Plots) für neu erkannte Geräte. Der folgende Abschnitt beschreibt wie man z.B. Plots von unterschiedlichen Sensoren gemeinsam ausgibt.

Die Daten für einen Plot stammen jeweils aus seiner FileLog-Datei. ändern Sie ggf. die Filterkriterien (regexp) wenn noch andere Daten geplottet werden sollen. Als nächsten Schritt setzen Sie das logtype Attribut des FileLog. Damit bestimmen Sie, welche Plotvorlagedatei (.gplot) benutzt werden soll. Die übersicht über die vorhandenen gnuplot-Dateien finden Sie unter dem Menüunkt Edit files. Die gnuplot-Dateien enthalten die zugehörigen FileLog Beispiele.

Beachten Sie bitte, dass die .gnuplot-Dateien ebenfalls bei der Darstellung von SVG anstelle des Gnuplot Backends benutzt werden.

Die gnuplot-Dateien müssen #Filelog-Einträge haben, damit sie mit gnuplot scroll oder SVG benutzt werden können (Diese Zeilen werden von gnuplot, aber nichrt von FHEM, als Kommentare behandelt). Wenn die Auswahl mittels der FileLog get-Funktion erfolgen soll, dann lesen Sie sich für die Syntax die mitgelieferten gnuplot-Dateien oder den column_spec Abschnitt hier durch.

Beispiele:

   attr em1000log logtype power8:Power,text
   attr fs20_log logtype fs20:Plot,text
   attr hms100th_log logtype temp4hum6:Plot,text

Lassen Sie sich das Diagramm (/denPlot) anzeigen, indem Sie darauf klicken und erstellen Sie einen Weblink der seine eigenen Attribute hat. Wenn der Weblink zur aktuellen Logdatei gehört, dann wird er als aktueller Weblink gespeichert und angezeigt (Sie müssen ihn nicht erneut definieren, wenn sich in seinem Dateinamen die Bezeichnungen für Jahr/Monat/Datum ändern).

Die Logs können entweder mit gnuplot (welches im aktuellen Pfad installiert sein muss), oder mittels des im Programm enthaltenen SVG-Moduls erstellt werden. In diesem Fall muss Ihr Browser SVG unterstützen. Alle Browser unterstützen SVG, ausser dem Internet Explorer vor der Version 9 und Android vor der Version 3.0. Wenn Sie ein Gerät mit diesen Android-Versionen benutzen, dann versuchen Sie bitte als Browser Opera oder Firefox.

Der voreingestellte Modus ist SVG. Um das zu ändern, setzen Sie die plotmode Attribute auf gnuplot oder gnuplot scroll.

Um ältere Daten anzeigen zu lassen, erstellen Sie bitte einen anderen Weblink und setzen das fixedrange-Attribut auf z.B.:

   attr weblink_1 fixedrange 2006-01-01 2007-01-01 

Um fremde (nicht unter FHEM erfasste) Daten als Plot oder als normalen Text anzuzeigen, erstellen Sie bitte ein fake-Logfile mit dem korrekten Dateinamen und einer unbenutzten regexp, z.B.:

   define messages FileLog /var/log/messages fakelog

FHEMWEB (pgm2) anpassen

Räume und Gruppen

Es ist in der Regel zu empfehlen, alle Geräte in Räumen zu gruppieren und auch innerhalb der Räume sinnvoll anzuordnen, indem Sie das group-Attribut setzen. FHEMWEB zeigt Geräte ohne Raum-Attribut im Raum (Menüpunkt) Unsorted. Fügen Sie Geräten das hidden Raumattribut hinzu, so werden diese Geräte nicht auf der Webseite angezeigt.

Sie können ein kürzeres Menü auf der Webseite erzeugen, indem Sie Menüpunkte die nicht angezeigt werden sollen mit dem Attribut hiddenroom versehen.

Farben und Schriften können Sie durch Anpassung der Datei style.css ändern (Edit files -> style.css) oder Sie erstellen Ihren eigenen Stil (siehe auch stylesheetPrefix) dann wird Ihr neuer Stil auch nicht beim nächsten Ausführen des update-Kommandos überschrieben.

Andere Frontends

FHEMWEB kann mit dem neuen Style "f18" auch auf eine dynamischere Darstellung für verschiedene Bildschirmgeräte und -größen eingestellt werden. Darüber hinaus besteht die Möglichkeit, andere Frontends an FHEM anzubinden und darüber Ihre Geräte zu steuern und darzustellen. Entsprechende Hinweise finden Sie hier im Wiki und in dem Forumsbereich dazu.

Komplexe Strukturen

Um gleichzeitig verschiedene Geräte auf einmal anzusprechen, kann mit Filtern und Abfragen gearbeitet werden. Details entnehmen sie bitten dem devspec Abschnitt der commandref. Z.B. können Sie die room=<roomname> Spezifikation verwenden, um gleichzeitig alle diesem Raum zugeordneten Geräte auf einmal anzusprechen.

Für noch komplexere Szenarien informieren sie sich bitte über das structure-Modul. Sie können verschiedene Ebenen wie Flure, Gebäude usw. definieren und alle Geräte einer definierten Struktur auf einmal ansprechen.