Include

Allgemeines

Der Befehl include gehört zu den FHEM-eigenen Befehlen. Mit ihm kann eine andere Datei eingelesen und ausgeführt werden. Ein typischer Anwendungsfall ist Verteilung bzw. Auslagerung von FHEM-Konfigurationen auf mehrere Dateien.

Hinweis: Die Verwendung des Befehls include gehört zum "Expertenmodus". Sie sollte nur bei detaillierter Kenntnis der Auswirkungen gewählt werden.

Wenn die Konfiguration des FHEM mit der Zeit wächst, wird sie schnell unübersichtlich. Dann kann es sich anbieten nicht mehr alle Konfigurationen in der einen fhem.cfg zu machen, sondern sie in verschiedene eigene Konfigurations-Dateien auszulagern. Diese werden dann in der "Haupt-Konfiguration" fhem.cfg mithilfe von include eingebunden.

Bei der Aufteilung der Konfiguration sind ein paar Punkte zu beachten:

Sämtliche attr global Definitionen müssen in der fhem.cfg bleiben.
Nur Konfigurationsdateien, die im Verzeichnis <installationsverzeichnis>/FHEM/ liegen, werden unter "Edit files" zur Bearbeitung mit dem integrierten Editor aufgeführt.
Um Änderungen in den "Teil-Konfigurationen" muss die "Haupt-Konfiguration" fhem.cfg neu eingelesen oder der fhem neu gestartet werden.

Beispiel einer verteilten Konfiguration

Die folgende verteilte Konfiguration ist sicher schon etwas exzessiv, gibt aber einen guten Überblick über die Möglichkeiten:

fhem.cfg (Haupt-Konfiguration):

attr global userattr DbLogExclude devStateIcon devStateStyle fp_DG fp_OG fp_EG fp_Keller icon sortby webCmd widgetOverride
attr global autoload_undefined_devices 1
attr global modpath .
attr global motd Error messages while initializing
attr global sendStatistics manually
attr global statefile ./log/fhem.save
attr global updateInBackground 1
attr global verbose 3

# Geo-Koordinaten
attr global latitude 52.518611
attr global longitude 13.376111

# Zentrales Logging pro Kalenderwoche
attr global logfile ./log/fhem-%Y-w%W.log

######################################################
###  fhem System configs
######################################################

include ./FHEM/fhem_1_interfaces.cfg
include ./FHEM/fhem_2_dashboard.cfg
include ./FHEM/fhem_3_logging.cfg
include ./FHEM/fhem_4_devices.cfg
include ./FHEM/fhem_5_floorplans.cfg

######################################################
###  Haus
######################################################

include ./FHEM/fhem_raeume.cfg
include ./FHEM/fhem_remoteserver_balkon.cfg

######################################################
###  Sonstiges
######################################################

include ./FHEM/fhem_systemstate.cfg
include ./FHEM/fhem_battery.cfg
include ./FHEM/fhem_wetter_dwd.cfg
include ./FHEM/fhem_wetter_yr.cfg
include ./FHEM/fhem_muell.cfg
include ./FHEM/fhem_internet.cfg

Für jede dieser includes gibt es dann eine eigene Konfigurationsdatei nach dem üblichen Schema.

Debugging einer verteilten Konfiguration

Eine einfache Methode zum Debuggen der Konfiguration geht wie folgt:

Teil-Konfigurationen im internen oder externen Editor bearbeiten und abspeichern.
Haupt-Konfiguration fhem.cfg im Online-Editor öffnen und wieder abspeichern. Etwaige Fehl-Konfigurationen werden direkt angezeigt.

Links

FHEM Command Beispiele#include