Vorlage:Infobox Hardware: Unterschied zwischen den Versionen

Aus FHEMWiki
K (Vorlagendokumentation hier integriert; Kategorie eingefügt.)
K (Kleinere Korrekturen und Formatierungsänderungen; (Beispiel-)Kopiervorlage für Homematic Devices eingefügt)
Zeile 50: Zeile 50:


=== Kopiervorlage(n) ===
=== Kopiervorlage(n) ===
<pre>{{Infobox Hardware
<pre style="width:400px;">
{{Infobox Hardware
|Bild=
|Bild=
|Bildbeschreibung=
|Bildbeschreibung=
Zeile 83: Zeile 84:
|HWDeviceFHEM=see commandref, Devices
|HWDeviceFHEM=see commandref, Devices
|ModOwner=Modulersteller
|ModOwner=Modulersteller
|HWManufacturer=ELV / eq3 / EnOcean  
|HWManufacturer=ELV / eQ-3 / EnOcean ...
}}
}}
Das nebenstehende Beispiel zeigt eine Auswahl der für die einzelnen Zeilen vorgesehenen Werte.
Das nebenstehende Beispiel zeigt eine Auswahl der für die einzelnen Zeilen vorgesehenen Werte.
Zeile 117: Zeile 118:


=== Beispiele ===
=== Beispiele ===
Kopiervorlagen für diverse Anwendungssituationen:
==== HomeMatic ====
Beispielvorlage für batteriebetriebenes HomeMatic Gerät:
<pre style="width:400px;">
{{Infobox Hardware
|Bild=HM-PB-6-WM55_front.jpg
|Bildbeschreibung=Vorderseite mit Beschriftungen
|HWProtocol=HomeMatic
|HWType=Sender
|HWCategory=HomeMatic
|HWComm=868MHz
|HWChannels=6
|HWVoltage=3V
|HWPowerConsumption=ca. 5 Jahre
|HWPoweredBy=2x1,5V LR03/Micro AAA
|HWSize=55x55x20mm
|HWDeviceFHEM=[[CUL_HM]]
|HWManufacturer=ELV / eQ-3
}}
</pre>


== Vorschlag für die Seitenstruktur ==
== Vorschlag für die Seitenstruktur ==
Eine Seite, die die Vorlage ''Infobox Hardware'' verwendet, sollte sich an der folgenden Gliederung orientieren. Je nach Ausführlichkeit und Bedarf können natürliche weitere Abschnitte hinzugefügt werden.
Eine Seite, die die Vorlage ''Infobox Hardware'' verwendet, sollte sich an der folgenden Gliederung orientieren. Je nach Ausführlichkeit und Bedarf können natürliche weitere Abschnitte hinzugefügt werden.
<pre><nowiki>
<pre style="width:650px;"><nowiki>
{{Infobox Hardware
{{Infobox Hardware
...
...

Version vom 26. August 2014, 12:32 Uhr

Infobox Hardware
[[Datei:{{{Bild}}}|200px|{{{Bildbeschreibung}}}]]
Allgemein
Protokoll {{{HWProtocol}}}
Typ {{{HWType}}}
Kategorie {{{HWCategory}}}
Technische Details
Kommunikation {{{HWComm}}}
Kanäle {{{HWChannels}}}
Betriebsspannung {{{HWVoltage}}}
Leistungsaufnahme {{{HWPowerConsumption}}}
Versorgung {{{HWPoweredBy}}}
Abmessungen {{{HWSize}}}
Sonstiges
Modulname {{{HWDeviceFHEM}}}
Hersteller {{{HWManufacturer}}}



Dokumentation

Diese Vorlage dient zur Zusammenfassung von Daten zu einer bestimmten, von FHEM unterstützten Hardwarekomponente.

Kopiervorlage(n)

{{Infobox Hardware
|Bild=
|Bildbeschreibung=
|HWProtocol= 
|HWType=
|HWCategory=
|HWComm=
|HWChannels=
|HWVoltage=
|HWPowerConsumption=
|HWPoweredBy=
|HWSize=
|HWDeviceFHEM=
<!-- |ModOwner=  -->
|HWManufacturer=
}}

Erläuterung der Parameter

Infobox Hardware
Beschreibung zum Bild
Allgemein
Protokoll FS20 / FHT / HMS / HomeMatic (BidCos) / EnOcean / 1-Wire
Typ Server / Sensor / Aktor / Sender / Empfänger / Gateway
Kategorie FS20 / Homematic / ...
Technische Details
Kommunikation 868 MHz / 1-Wire / LAN / RS485 / ...
Kanäle n/a / 1 / ... Anzahl unterstützter Kanäle
Betriebsspannung 3V / 230V / ...
Leistungsaufnahme 0,5W / 2 Jahre
Versorgung Batterie 2xLR6 / Netz / ...
Abmessungen Abmessungen LxBxH
Sonstiges
Modulname see commandref, Devices
Ersteller Modulersteller
Hersteller ELV / eQ-3 / EnOcean ...

Das nebenstehende Beispiel zeigt eine Auswahl der für die einzelnen Zeilen vorgesehenen Werte.

Bild
Dateiname der zugehörigen Bilddatei
Bildbeschreibung
Erläuterungstext zum Bild
HWProtocol
Geräteprotokoll (FS20, HomeMatic, etc.)
HWType
Gerätetyp (Sensor, Sender, ...)
HWCategory
Gerätekategorie (Max, FHT, HMS, HomeMatic, ...)
HWComm
Kommunikation (Funk 868MHz, 1-Wire, RS485, ...)
HWChannels
Anzahl unterstützter Kanäle
HWVoltage
Betriebsspannung
HWPowerConsumption
Leistungsaufnahme (Ruhe / Betrieb in W, Batterielebensdauer, ...)
HWPoweredBy
Versorgungsart (Batterie, Netz)
HWSize
Abmessungen
HWDeviceFHEM
Welches Fhem-Modul unterstützt das Gerät; gibt es eine eigene Modulseite, sollte hier [[ModulName]] (in der korrekten Schreibweise der Modulseite) angegeben werden.
ModOwner
(optional) Modulersteller / -betreuer
HWManufacturer
Hersteller des Geräts

Beispiele

Kopiervorlagen für diverse Anwendungssituationen:

HomeMatic

Beispielvorlage für batteriebetriebenes HomeMatic Gerät:

{{Infobox Hardware
|Bild=HM-PB-6-WM55_front.jpg
|Bildbeschreibung=Vorderseite mit Beschriftungen
|HWProtocol=HomeMatic
|HWType=Sender
|HWCategory=HomeMatic
|HWComm=868MHz
|HWChannels=6
|HWVoltage=3V
|HWPowerConsumption=ca. 5 Jahre
|HWPoweredBy=2x1,5V LR03/Micro AAA
|HWSize=55x55x20mm
|HWDeviceFHEM=[[CUL_HM]]
|HWManufacturer=ELV / eQ-3 
}}

Vorschlag für die Seitenstruktur

Eine Seite, die die Vorlage Infobox Hardware verwendet, sollte sich an der folgenden Gliederung orientieren. Je nach Ausführlichkeit und Bedarf können natürliche weitere Abschnitte hinzugefügt werden.

{{Infobox Hardware
...
}}
[[GerätebezeichnungXyz]] ist ... und macht ... (allgemeine Beschreibung, etwas mehr, 
als unter "BildBeschreibung" angegeben)

== Features ==
Gerät Xyz hat folgende Funktionen...
* Senden
* Empfangen ...

== Hinweise zum Betrieb mit FHEM ==

=== Definition ===

=== Logbeispiel ===

== Bekannte Probleme ==

== ... ==

== Links ==

[[Kategorie:xyz]] 
<!-- (Modulkategorie wird automatisch gesetzt) -->

Diese Vorlage wird derzeit verwendet auf: (Seitenliste).