Vorlage:Infobox Hardware: Unterschied zwischen den Versionen
Krikan (Diskussion | Beiträge) K (→Erläuterung der Parameter: ->FHEM(R)) |
K (cat correct) |
||
| (Eine dazwischenliegende Version von einem anderen Benutzer wird nicht angezeigt) | |||
| Zeile 116: | Zeile 116: | ||
; HWManufacturer | ; HWManufacturer | ||
: Hersteller des Geräts | : Hersteller des Geräts | ||
<templatedata> | |||
{ | |||
"params": { | |||
"Name": { | |||
"label": "Name", | |||
"description": "Sofern der Gerätename von dem Namen der Wiki-Seite abweicht kann hiermit ein alternativer Name in der Infobox gewählt werden", | |||
"type": "string" | |||
}, | |||
"Bild": { | |||
"label": "Bild", | |||
"description": "Die Bezeichnung des Bildes welches im Wiki dazu hochgeladen ist.", | |||
"type": "wiki-file-name", | |||
"required": true, | |||
"suggested": true | |||
}, | |||
"Bildbeschreibung": { | |||
"label": "Bildbeschreibung", | |||
"description": "Kurzer Erläuterungstext zum Bild. Erscheint direkt unter dem Bild.", | |||
"type": "string", | |||
"required": true | |||
}, | |||
"HWProtocol": { | |||
"label": "Protokoll", | |||
"description": "Name des Übertragunsprotokolls (z.B. FS20, HomeMatic, etc.)", | |||
"example": "HomeMatic", | |||
"type": "string", | |||
"required": true | |||
}, | |||
"HWType": { | |||
"label": "Typ", | |||
"description": "Gerätetyp (Sensor, Sender, ...); bei HomeMatic Geräten der HomeMatic Type ..., formatiert als [[HomeMatic Type xyz|xyz]]", | |||
"example": "Sensor", | |||
"type": "content", | |||
"required": true | |||
}, | |||
"HWCategory": { | |||
"label": "Gerätekategorie", | |||
"description": "Gerätekategorie (Max, FHT, HMS, HomeMatic, ...)", | |||
"example": "HomeMatic", | |||
"required": true | |||
}, | |||
"HWComm": { | |||
"label": "Kommunikationsart", | |||
"description": "Art der Kommunikation (z.B. Funk 868MHz, 1-Wire, RS485, ...)", | |||
"example": "Funk 868MHz", | |||
"required": true | |||
}, | |||
"HWChannels": { | |||
"label": "Unterstützte Kanäle", | |||
"description": "Anzahl unterstützter Kanäle", | |||
"type": "string", | |||
"required": true | |||
}, | |||
"HWVoltage": { | |||
"label": "Betriebsspannung (V)", | |||
"description": "Die unterstützte Betriebsspannung(-en) des Geräts", | |||
"example": "230V", | |||
"type": "string", | |||
"required": true, | |||
"suggested": true | |||
}, | |||
"HWPowerConsumption": { | |||
"label": "Leistungsaufnahme (W)", | |||
"description": "Die durchschnittliche Leistungsaufnahme (Watt) im Betriebszustand.", | |||
"example": "ca. 1W", | |||
"type": "string", | |||
"required": true, | |||
"suggested": true | |||
}, | |||
"HWPoweredBy": { | |||
"label": "Stromversorgung", | |||
"description": "Art der Stromversorgung", | |||
"example": "Batterie (2x AA Mignon)", | |||
"type": "string", | |||
"required": true | |||
}, | |||
"HWSize": { | |||
"label": "Abmessungen", | |||
"description": "Die Abmessungen des Geräts (LxBxH)", | |||
"type": "string", | |||
"required": true | |||
}, | |||
"HWDeviceFHEM": { | |||
"label": "FHEM-Modul", | |||
"description": "Das zugehörige FHEM-Modul, welches diese Hardware steuern kann.", | |||
"example": "CUL_HM", | |||
"required": true | |||
}, | |||
"ModOwner": { | |||
"label": "Modulersteller", | |||
"description": "Der Ersteller / Maintainer des zugehörigen FHEM-Moduls." | |||
}, | |||
"HWManufacturer": { | |||
"label": "Hersteller", | |||
"description": "Der Name des Geräteherstellers", | |||
"example": "ELV / eQ3", | |||
"type": "string", | |||
"required": true, | |||
"suggested": true | |||
} | |||
}, | |||
"description": "Zusammenstellung aller wichtigen Daten/Fakten zu einem Hardware-Gerät.", | |||
"paramOrder": [ | |||
"Bild", | |||
"Bildbeschreibung", | |||
"HWProtocol", | |||
"HWType", | |||
"HWCategory", | |||
"HWComm", | |||
"HWChannels", | |||
"HWVoltage", | |||
"HWPowerConsumption", | |||
"HWPoweredBy", | |||
"HWSize", | |||
"HWDeviceFHEM", | |||
"ModOwner", | |||
"HWManufacturer", | |||
"Name" | |||
], | |||
"format": "block" | |||
} | |||
</templatedata> | |||
=== Beispiele === | === Beispiele === | ||
| Zeile 172: | Zeile 295: | ||
Diese Vorlage wird derzeit verwendet auf: [[Special:Linkliste/Vorlage:Infobox Hardware|(Seitenliste)]]. | Diese Vorlage wird derzeit verwendet auf: [[Special:Linkliste/Vorlage:Infobox Hardware|(Seitenliste)]]. | ||
[[Kategorie:Vorlage | [[Kategorie:Vorlage]] | ||
</noinclude> | </noinclude> | ||
Aktuelle Version vom 13. Februar 2020, 13:02 Uhr
| Infobox Hardware | |
|---|---|
| [[Datei:{{{Bild}}}|280px|mini|frameless]] | |
| 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=PlatzHalter.png
|Bildbeschreibung=
|HWProtocol=
|HWType=
|HWCategory=
|HWComm=
|HWChannels=
|HWVoltage=
|HWPowerConsumption=
|HWPoweredBy=
|HWSize=
|HWDeviceFHEM=
<!-- |ModOwner= -->
|HWManufacturer=
}}
Erläuterung der Parameter
| Infobox Hardware | |
|---|---|
| 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 (bitte PlatzHalter.png verwenden, wenn kein eigenes Bild vorhanden ist)
- Bildbeschreibung
- Erläuterungstext zum Bild
- HWProtocol
- Geräteprotokoll (FS20, HomeMatic, etc.)
- HWType
- Gerätetyp (Sensor, Sender, ...); bei HomeMatic Geräten der HomeMatic Type ..., formatiert als [[HomeMatic Type xyz|xyz]]
- 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
Zusammenstellung aller wichtigen Daten/Fakten zu einem Hardware-Gerät.
| Parameter | Beschreibung | Typ | Status | |
|---|---|---|---|---|
| Bild | Bild | Die Bezeichnung des Bildes welches im Wiki dazu hochgeladen ist. | Datei | erforderlich |
| Bildbeschreibung | Bildbeschreibung | Kurzer Erläuterungstext zum Bild. Erscheint direkt unter dem Bild. | Mehrzeiliger Text | erforderlich |
| Protokoll | HWProtocol | Name des Übertragunsprotokolls (z.B. FS20, HomeMatic, etc.)
| Mehrzeiliger Text | erforderlich |
| Typ | HWType | Gerätetyp (Sensor, Sender, ...); bei HomeMatic Geräten der HomeMatic Type ..., formatiert als [[HomeMatic Type xyz|xyz]]
| Wikitext | erforderlich |
| Gerätekategorie | HWCategory | Gerätekategorie (Max, FHT, HMS, HomeMatic, ...)
| Unbekannt | erforderlich |
| Kommunikationsart | HWComm | Art der Kommunikation (z.B. Funk 868MHz, 1-Wire, RS485, ...)
| Unbekannt | erforderlich |
| Unterstützte Kanäle | HWChannels | Anzahl unterstützter Kanäle | Mehrzeiliger Text | erforderlich |
| Betriebsspannung (V) | HWVoltage | Die unterstützte Betriebsspannung(-en) des Geräts
| Mehrzeiliger Text | erforderlich |
| Leistungsaufnahme (W) | HWPowerConsumption | Die durchschnittliche Leistungsaufnahme (Watt) im Betriebszustand.
| Mehrzeiliger Text | erforderlich |
| Stromversorgung | HWPoweredBy | Art der Stromversorgung
| Mehrzeiliger Text | erforderlich |
| Abmessungen | HWSize | Die Abmessungen des Geräts (LxBxH) | Mehrzeiliger Text | erforderlich |
| FHEM-Modul | HWDeviceFHEM | Das zugehörige FHEM-Modul, welches diese Hardware steuern kann.
| Unbekannt | erforderlich |
| Modulersteller | ModOwner | Der Ersteller / Maintainer des zugehörigen FHEM-Moduls. | Unbekannt | optional |
| Hersteller | HWManufacturer | Der Name des Geräteherstellers
| Mehrzeiliger Text | erforderlich |
| Name | Name | Sofern der Gerätename von dem Namen der Wiki-Seite abweicht kann hiermit ein alternativer Name in der Infobox gewählt werden | Mehrzeiliger Text | optional |
Beispiele
Kopiervorlagen für diverse Anwendungssituationen:
HomeMatic, batteriebetrieben
Beispielvorlage für batteriebetriebenes HomeMatic Gerät:
{{Infobox Hardware
|Bild=PlatzHalter.png
|Bildbeschreibung=Vorderseite mit Beschriftungen
|HWProtocol=HomeMatic
|HWType=[[HomeMatic Type ...|...]]
|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]]
Diese Vorlage wird derzeit verwendet auf: (Seitenliste).