Plugin odlinfo

protocol plugin

Im folgenden sind etwaige Anforderungen und unterstützte Hardware beschrieben. Danach folgt die Beschreibung, wie das Plugin odlinfo konfiguriert wird. Außerdem ist im folgenden beschrieben, wie das Plugin in den Item Definitionen genutzt werden kann. [1]

Beschreibung

Dieses Plugin liefert die Gamme-Ortsdosisleistung (ODL) in µSv/h von mehreren Stationen in Deutschland (zur Verfügung gestellt durch das Bundesamt für Strahlenschutz). Mehr Informationen unter https://odlinfo.bfs.de.

Anforderungen

  • Minimum SmartHomeNG Version: 1.4

Konfiguration

Im folgenden ist beschrieben, wie das Plugin odlinfo konfiguriert wird. Außerdem ist im folgenden beschrieben, wie das Plugin in den Item Definitionen genutzt werden kann.

Parameter

Das Plugin verfügt über folgende Parameter, die in der Datei ../etc/plugin.yaml konfiguriert werden:

password

Persönliches Passwort für odlinfo.bfs.de. Anleitung unter https://odlinfo.bfs.de/DE/service/datenschnittstelle.html.

  • Datentyp: str

user

Persönlicher User für odlinfo.bfs.de. Anleitung unter https://odlinfo.bfs.de/DE/service/datenschnittstelle.html.

  • Datentyp: str

Item Attribute

Das Plugin unterstützt folgende Item Attribute, die in den Dateien im Verzeichnis ../items verwendet werden:

Keine

Logik Parameter

Das Plugin verfügt über folgende Parameter, die in der Datei ../etc/logic.yaml konfiguriert werden:

Keine Logik Parameter in den Metadaten beschrieben - Bitte in der README nachsehen (siehe Fußnote)

Plugin Functions

Das Plugin verfügt über folgende öffentliche Funktionen, die z.B. in Logiken aufgerufen werden können.

get_radiation_data_for_id(odlinfo_id)

Gibt ein DICT mit Infos zur einer Messstation zurück. Keys: ‚plz‘, ‚kid‘, ‚lon‘, ‚lat‘, ‚ort‘, ‚hoehe‘, ‚mw‘, ‚status‘.

  • Ergebnistyp der Funktion: dict

odlinfo_id

ID der Messstation. Siehe https://odlinfo.bfs.de.

  • Datentyp: str

get_radiation_data_for_ids(odlinfo_ids)

Gibt ein Array von DICTs mit Infos zu Messstationen zurück. Keys: ‚plz‘, ‚kid‘, ‚lon‘, ‚lat‘, ‚ort‘, ‚hoehe‘, ‚mw‘, ‚status‘.

  • Ergebnistyp der Funktion: list(dict)

odlinfo_ids

Array der IDs der Messstationen. Siehe https://odlinfo.bfs.de.

  • Datentyp: list(str)
[1]Diese Seite wurde aus den Metadaten des Plugins erzeugt. Für den Fall, dass diese Seite nicht alle benötigten Informationen enthält, bitte auf die englischsprachige README Datei des Plugins zugreifen.