Gerät

Begriff

Ein Gerät (engl. Device) ist eine elementare Komponente im FHEM-System. Geräte werden in der Regel vom Benutzer per Definition erzeugt oder automatisch per autocreate angelegt. Eine Definition beinhaltet drei wesentliche Parameter.

• Gerätename, eine eindeutige Bezeichnung, die der Benutzer vergibt.
• Typ, mit dieser Angabe wird das Modul festgelegt von dem das Gerät instanziert wird. Das Modul bestimmt die Funktionen des Gerätes. Typen sind mit den Namen in der Inhaltsangabe der Befehlsreferenz identisch, z.B. ist der Name Calendar der Typ und bezieht sich auf das Modul 57_Calendar.pm. Der Typ wird im Internal TYPE vermerkt. Typ und Modulname werden synonym verwendet
• typspezifische Angaben, das sind Angaben, die in der Befehlsreferenz zu den einzelnen Gerätetypen beschrieben sind.

Erzeugen eines Gerätes

Ein Gerät wird mit dem Befehl define erzeugt.

define <Gerätename> <Typ> <typspezifische Angaben>

Funktion eines Gerätes

• Angaben zur Darstellung im Frontend liefern, z.B. Temperatur, Feuchte, Schaltzustand, Set- u. Get-Befehl oder die Gerätezeile der Raumansicht
• typenbedingte Aufbereitung von Daten, z.B.
• typenbedingte Funktionen ausführen, z.B. auf Ereignisse reagieren und verknüpfen, Befehle ausführen, Daten liefern.
• Schnittstelle zu anderen Geräten bereitstellen und bedienen, z.B. ein Gerät vom Typ SOMFY tauscht Daten mit einem Ein- u. Ausgabegerät (E/A-Gerät) vom Typ SIGNALduino aus.
• Datenaustauch mit Hardware realisieren, z.B. ein Gerät vom Typ SIGNALduino bedient als E/A-Gerät über eine USB-Schnittstelle die Hardware SIGNALduino.

Detailansicht im FHEMWEB-Frontend

Die Detailansicht eines Gerätes kann aus der Raumansicht aufgerufen werden, über den Link mit dem Gerätenamen oder dem Alias.

Die Detailansicht dient der Konfiguration und der Darstellung von Gerätevariablen.

Die Detailansicht ist in die nachfolgend beschriebenen Bereiche gegliedert.

A) Gerätezeile (DeviceOverview)

Die Gerätezeile zeigt eine Vorschau der Gerätedarstellung, wie sie in der Raumansicht zusehen ist. Diese Ansicht kann durch Attribute, wie (readingList, webCmd, setList, widgetOverride, devStateIcon, icon) verändert werden, sofern die Attribute vom Gerät unterstützt werden.

B) typspezifischer Bereich

In diesem Bereich legt das Modul fest welche Dinge angezeigt werden. Im Bild ist zu sehen, dass der Event-Monitor in der Detailansicht des DOIF eingeblendet werden kann, siehe auch DevelopmentFHEMWEB#FW_detailFn.

C) Bereich der Set- u. Get-Befehle

In diesem Bereich befinden sich die Knöpfe set und get, sofern ein Modul Set- o. Get-Befehle bereitstellt. Der Bereich stellt eine, durch den Gerätetyp festgelegte Benutzerschnittstelle dar, z.B. kann ein Gerät, dass für eine Funksteckdose angelegt wurde, durch Bedienen des Set-Knopfes die Funksteckdose ein- o. ausgeschalteten.

D) Liste der Internals

Die Liste der Internals stellt die meist statischen, bei der Definition erzeugten Gerätedaten dar. Internals besitzen, im Gegensatz zu Readings keinen Zeitstempel. Eine Aktualisierung von Internals erzeugt keine Ereignisse.

Das Internal DEF hat in der Detailansicht eine besondere Funktion, bei einem Klick auf DEF öffnet sich ein Editorfenster, mit dem die Definition des Gerätes verändert werden kann. Die Funktionalität des Editors kann mit der Codemirror-Erweiterung verbessert werden.

E) Liste der Readings

In diesem Bereich werden die Readings eines Gerätes aufgelistet. Readings setzen sich aus einem Namen, einem Wert und einem Zeitstempel zusammen. Der Zeistempel gibt den Zeitpunkt der letzten Aktualisierung an. Eine Aktualisierung kann mit oder ohne Ereignis erfolgen. Welche Readings angezeigt werden, bestimmt das Modu, bzw. der Modul-Autor. Der Benutzer kann zusätzliche Readings anlegen

• entweder als userReadings, die durch die Aktualisierung vorhandener Readings aktualisiert werden
• oder über den FHEM-Befehl setreading, mit deletereading können Readings gelöscht werden.

F) Attr-Befehl und Liste der gesetzten Attribute (Attributes)

Mit dem Knopf attr wird für das ausgewählte Attribut ein Wert gesetzt.

Durch Attribute kann der Benutzer das Verhalten des Gerätes beinflussen, siehe Attribute in der Befehlsreferenz

Die Liste der Attribute zeigt alle für das Gerät gesetzten Attribute.

G) Liste der wahrscheinlich verbundenen Geräte (Probably associated with)

Diese Liste zeigt Gerätenamen an, die wahrscheinlich mit dem Gerät verbunden sind. Es werden alle Geräte angezeigt, die im Internal DEF erkennbar sind. Zusätzlich wird der Inhalt der Internals STATE und TYPE angezeigt.

H) zusätzliche Befehle

• Select Icon zeigt eine Icon-Seite an und setzt das Attribut Icon auf das ausgewählte Icon.
• Extend devStateIcon zeigt eine Icon-Seite an und setzt das Attribut devStateIcon auf das ausgewählte Icon.
• Raw definition bietet die Möglichkeit die Definition zu ändern und zu im- oder exportieren.
• Delete this device (<device name>) löscht das Gerät
• Device specific help zeigt die Hilfe zum Modul an.

Links

Forenthread Begriffsklärung Gerät, Gerätetyp, Gerätemodul