DevelopmentGuidelinesReadings

Aus FHEMWiki
Version vom 21. Februar 2025, 21:26 Uhr von Beta-User (Diskussion | Beiträge) (Teilweise Übernahme aus Diskussionssthread)
(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)

Deutsch

Einleitung

Auf dieser Seite werden Richtlinien für Readings gesammelt, welche in mehreren Modulen auftauchen können um eine Vereinheitlichung zu erreichen. Dadurch soll es Hilfsmodulen und Anwendern leichter fallen, mit den Werten der Readings zu arbeiten.

Batterie-Readings

Basierend auf dieser Diskussion haben sich die Entwickler für Readings, welche in Zusammenhang mit Batterien stehen auf folgendes geeinigt: Es gibt nur diese drei Readings für den Batteriestatus:

  • batteryState
  • batteryPercent
  • batteryVoltage

Wertebereich:

  • batteryState: ok|low
  • batteryPercent: \d{1,2}|100
  • batteryVoltage: \d+.\d+

Wichtig: das jeweilige Modul setzt nur die Readings, die es aus den aktuellen Daten vom Gerät bestimmen kann. Konkret: niemand kann sich darauf verlassen, welche der drei battery Readings vorhanden sind (es gibt nicht überall ein batteryState). Wenn das Gerät früher ein Percent gemeldet hat, aber in der letzten Nachricht nur state, dann wird das Percent Reading nicht angefasst.

#### ab hier Entwurf #####

Energieflüsse

Siehe Thread Frevel: Die Idee einheitlicher Devicenamen und Readings

Diskussionsvorschläge für künftige Module

Quelle: Diskussion

Schaltbare Geräte (mehrkanalig=>erster Kanal, "Hauptschalter" oä.): - "state" mit Werten "on" bzw. "off" (für laufende Schaltvorgänge auch "set_xx", s.u.)

Leuchtmittel:

- "state" wie "schaltbare Geräte"

- "pct" für Helligkeit (Wertebereich: 0-100), alternativ "dim" (Wertebereich: 0-99) oder "brightness" (Wertebereich: 0-255 (bzw. 254))

- "ct" (alternativ: "colorTemp") für die Farbtemperatur

- "hue" für den Farbwert (ohne Helligkeitsanteil)

- "rgb" (alternativ: "color" oder "hex") für Farbwerte mit Helligkeitsanteil (rrggbb)

- "sat" (oder "saturation") für die Farbsättigung

Rollladen- und Jalousieaktoren:

Wie Leuchtmittel, in der Regel sollte "offen" = "on" = "100" (pct) sein (komplett invertiert ist zulässig)

Falls drehbare Lamellen (direkt) im Device einstellbar sind: "pctSlats" (0-100, 100= ganz nach oben gekippt) (to be verified!)

Thermostate (einstellbare Wunschtemperatur):

- "desired-temp" für die Wunschtemperatur (typischerweise in °C)

- "temperature" für die gemessene Temperatur, alternativ auch "measured-temp"

- "valve" (oder "level") für Stellgrößen (z.B. Ventilöffnung, "valve" typischerweise 0-100 (%))

Thermometer:

Temperatur in Reading "temperature" oder "state"

Feuchtigkeitsmesser:

Luftfeuchte in "humidity", Bodenfeuchte als "moisture"

Bewegungs- oder Präsenzmelder, Kontakte:

"motion" mit "on" oder "off" bzw. motion/noMotion

"presence" mit "on" oder "off" bzw. present/absent

"contact" mit "open" oder "closed" bzw. "on" oder "off"

Füllstandssensoren:

"pct" oder "level" (typischerweise in %), bei Koexistenz mit "pct" ggf. "level" als absoluter Messwert (Einheit nicht festgelegt)

Drucksensoren:

"pressure"

Schlösser:

"state" für den Haupt-Schließzustand (locked / unlocked?)

set-Befehle: "lock" und "unlock"

Geräte, die voreingestellte Szenarien einstellen können:

set-Befehl mit "scene"

Allgemeiner Gerätestatus

- "availability" ("online"/"offline" bzw. "present" / "absent") (Für MQTT alternativer Readingname: "LWT")

- "lastseen" (Zeitstempel in Sekunden)

Allgemeines:

Als "Transitstatus" darf (analog z.B. CUL_HM) auch ein "set_xx" in allen Readings stehen, bis (hoffentlich...) die Bestätigung vom Gerät zurückkommt, dass das ausgeführt wurde.

also Anweisung "set DEVICE brightness 77" ergibt übergangsweisen Readinginhalt für "brightness" mit "set_77".


##### Ende Entwurf #####

English

Start

On this page you will find guidlines how to name common readings. These guidlines are for readings which are used in more than one module and should have the same possible values. This makes it helper modules and users easier, to work with the values from common readings.

Battery Reading

Based on this discussion battery-readings should only be named like:

  • batteryState
  • batteryPercent
  • batteryVoltage

The values should only be:

  • batteryState: ok|low
  • batteryPercent: \d{1,2}|100
  • batteryVoltage: \d+.\d+

Important: The FHEM module will only report the values received from the device, i.e. not each module reports a batteryState reading. Additionally, if the device sent a batteryPercent value earlier but the last message from the device only contained a 'battery: low', the batteryPercent reading wont be changed.