Version vom 5. Februar 2018, 11:58 Uhr

Die zu FHEM verfügbare Dokumentation ist auf verschiedene Quellen aufgeteilt.

Nachfolgend ein kurzer Überblick über diese verschiedenen Quellen:

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.

FHEMWiki

Die gerade berachtete Seite steht im FHEMWiki. Mit dem Link links oben gelangen Sie 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. 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, sollte der 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. Bevor man Fragen zu derartigen Informationsquellen im Forum stellt, sollte man diese gegen die innerhalb der oben aufgeführten Quellen gegengeprüft haben.

@@ Zeile 1: / Zeile 1: @@
-Die zu FHEM verfügbare Dokumentation ist auf verschiedene Quellen aufgeteilt, deren Herkunft und Bedeutung gerade am Anfang nicht jedem bekannt ist.
+Die zu FHEM verfügbare Dokumentation ist auf verschiedene Quellen aufgeteilt.
-Hier soll ein kuzer Überblick über die verschiedenen Quellen gegeben werden:
+Nachfolgend ein kurzer Überblick über diese verschiedenen Quellen:
+=[http://www.fhem.de FHEM]=
+Hier gibt es Allgemeines zu FHEM, sowie Installationsanleitungen.
+={{Link2CmdRef}}=
+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.
+=FHEMWiki=
+Die gerade berachtete Seite steht im FHEMWiki. Mit dem Link links oben gelangen Sie 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. Für Verbesserungsvorschläge zum FHEMWiki besteht ein eigener [https://forum.fhem.de/index.php/board,80.0.html Bereich im Forum].
-'''1. [http://www.fhem.de FHEM]'''
+=[http://forum.fhem.de/ 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 [https://forum.fhem.de/index.php/board,18.0.html 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.
-Allgemeines zum FHEM sowie Installationsanleitungen.
+=Internet, Blogs usw.=
+Bei Informationen, die aus anderen Quellen stammt, sollte der 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. Bevor man Fragen zu derartigen Informationsquellen im Forum stellt, sollte man diese gegen die innerhalb der oben aufgeführten Quellen gegengeprüft haben.
-'''2. {{Link2CmdRef}}'''
-Für die an der Entwicklung von FHEM beteiligten Softwareentwickler (Modulautoren) gibt es eine einzige verpflichtende Vorgabe: Offizielle Module müssen über eine englische CommandRef verfügen. Dies ist daher DIE wichtigste Quelle für Informationen rund um ein Modul. In der Regel ist diese sollte so gestaltet, dass mit dieser das betreffende Modul eingerichtet werden kann.
-Alle FHEM-Anwender sollten daher zunächst in der commandref nachsehen, wie Module oder FHEM-Befehle einzusetzen sind bzw. nach Lösungsansätzen für ihre Fragestellungen suchen. Auch neue Funktionen usw. werden hier in der Regel von den Modulautoren tagesaktuell dokumentiert.
-'''3. a. Wiki'''
-Die Artikel im Wiki stammen teilweise von den Modulautoren selbst, in der Regel werden diese jedoch von Anwendern für andere Anwender erstellt. Dementsprechend ist die Aktualität und Qualität der Artikel unterschiedlich. Für Verbesserungsvorschläge zum Wiki besteht ein eigener [https://forum.fhem.de/index.php/board,80.0.html Bereich im Forum].
-'''3. b. [http://forum.fhem.de/ 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 [https://forum.fhem.de/index.php/board,18.0.html angepinnten Beiträgen im Anfängerbereich] zu finden, dort finden sich auch Hinweise zum Umgang mit der forumsinternen Suchfunktion.
-'''4. Internet, Blogs usw.'''
-Bei Informationen, die aus anderen Quellen stammt, sollte der 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. Bevor man Fragen zu derartigen Informationsquellen im Forum stellt, sollte man diese gegen die innerhalb der unter 1-3 aufgeführten Quellen gegengeprüft haben.
 [[Kategorie:Dokumentation]]