DevelopmentGuidelinesReadings

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.

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 respective module only uses the values getting from the device. This means nobody can be sure which of the readings is used in the modul (there is not everywhere a batteryState reading). If the device did send batteryPercent befor and now only sends 'battery: low', the batteryPercent readings stays as it was before.