Dokumentationsstruktur

Aus FHEMWiki
Wechseln zu: Navigation, Suche

Die zu FHEM verfügbare Dokumentation ist auf verschiedene Quellen aufgeteilt. Nachfolgend ein kurzer Überblick über diese verschiedenen Quellen - aber vorher:

Don't Panic

FHEM ist ein komplexes Softwaresystem, das von etwa einhundert Aktivisten in ihrer Freizeit und unentgeltlich weiter entwickelt wird. Wie komplex, ersieht man am Besten aus der Seite Systemübersicht.

Dabei gibt es keine zentrale Steuerung (wie etwa in einem ähnlich großen Industrieprojekt), sondern nur ein paar Regeln, an die sich (mehr oder weniger) alle halten. Es bleibt deshalb nicht aus, dass die Dokumentation manchmal nicht ganz aktuell ist, manchmal in sich widersprüchlich oder anderen Quellen widersprechend, oder manchmal nicht in der Wunschsprache verfügbar ist.

Mit diesem (leichten) Chaos müssen wir leben, Beschwerden darüber werden in der Regel nicht gut aufgenommen. Wer mehr darüber erfahren möchte, wie das überhaupt funktionieren kann, soll sich bitte im Artikel Die Kathedrale und der Basar von Eric Raymond darüber informieren, wie man gute Open Source Software schreibt.

Deshalb bitten wir alle Hilfesuchenden, sich zunächst aus allen verfügbaren Quellen selbst zu informieren (die Seite Systemübersicht ist dafür ebenso ein Einstieg, wie die Hauptseite des Wiki). Erst wenn diese Quellen ausgeschöpft sind (inklusive einer Nutzung der jeweiligen Suchfunktion) sollte man sich mit möglichst konkreten Fragen entweder allgemein unter Anfängerfragen oder in einem spezialisierten Unterforum an die Entwickler wenden.

Vielfach reagieren Newcomer dann mit aber ihr könnt das doch in 30 Sekunden beantworten, wofür ich 3 Stunden brauche. Prima, kann sein. Aber erstens muss man sich mal vorstellen, was auf einen Modulautor zukommt, wenn er einhundert Mal pro Woche 30 Sekunden aufwenden soll. Und zweitens sind drei Stunden gar nichts im Vergleich zu dem Zeitaufwand, den Entwickler beim Zusammenbau eines neues Moduls erbringen.

Fazit: Keine Panik! Erst selbst recherchieren, dann fragen.

FHEM

Hier gibt es Allgemeines zu FHEM, sowie Installationsanleitungen.

commandref

Bei einem auftretenden Problem sollte immer zuerst in der CommandRef nachgesehen werden, wie Module oder FHEM-Befehle einzusetzen sind. Auch neue Funktionen usw. werden hier von den Modulautoren tagesaktuell dokumentiert. Diese Dokumentation ist in der Regel so gestaltet, dass danach

  • FHEM-Befehle (FHEM commands) verstanden und ausgeführt werden können;
  • Gerätemodule (Device Modules) verstanden werden, so dass mit ihnen ein FHEM-Device definiert, konfiguriert und bedient werden kann;
  • Helpermodule (Helper Modules) verstanden und konfiguriert werden können.

Für die an der Entwicklung von FHEM beteiligten Softwareentwickler (Modulautoren) gibt es eine einzige verpflichtende Vorgabe: Offizielle Module müssen über eine englischsprachige CommandRef verfügen. Dies ist daher die wichtigste Quelle für Informationen rund um ein Modul.

TIPP: Bitte keine Beschwerden über "fehlende deutschsprachige Dokumentation". Wer diese vermisst, sollte sie einfach durch Übersetzung der englischsprachigen Commandref erstellen und dem Modulautor zusenden - er freut sich in der Regel über die Zuarbeit. Wer der Modulautor ist, erfährt man ebenfalls aus der Dokumentation, dafür gibt es die Datei MAINTAINER.txt .

FHEMWiki

Die hier gerade betrachtete Seite steht im FHEMWiki. Mit dem Link links oben gelangt man auf die Hauptseite, die einen guten Einstieg darstellt. Die Artikel im FHEMWiki stammen teilweise von den Modulautoren selbst, viele werden aber von Anwendern für andere Anwender erstellt. Dementsprechend ist die Aktualität und Qualität der Artikel unterschiedlich.

TIPP: Für Verbesserungsvorschläge zum FHEMWiki besteht ein eigener Bereich im Forum.

Forum

Im Forum stellen manche Entwickler, insbesondere auch solche (noch) inoffizieller Module, weitere Informationen zur Verfügung. Nützliche Infos zum Forum selbst sind in den angepinnten Beiträgen im Anfängerbereich zu finden, dort finden sich auch Hinweise zum Umgang mit der forumsinternen Suchfunktion.

TIPP: Erst die Suchfunktion benutzen, dann eine eigene Frage stellen. Die meisten Probleme treten nicht zu ersten Mal auf, sondern sind - kein Wunder bei ca. 20.000 Teilnehmern - schon einmal behandelt worden.

Internet, Blogs usw.

Bei Informationen, die aus anderen Quellen stammt, sollten Hilfesuchende selbst prüfen, inwieweit diese aktuell und von guter Qualität sind. Dabei ist zu bedenken, dass die betreffenden Autoren eventuell auch Interessen verfolgen, die nicht deckungsgleich sein müssen mit denen der FHEM-Community.

TIPP: Bevor man Fragen zu derartigen Informationsquellen im Forum stellt, sollte man diese gegen die oben aufgeführten Quellen gegengeprüft haben.