Plugin ‚tankerkoenig‘ Konfiguration

plugin logo

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

Es handelt sich bei diesem Plugin um ein web Plugin.

Beschreibung

Benzinpreise über die API von Tankerkönig. Bitte sicherstellen, die API nicht zu oft aufzurufen. Bitte Hinweise unter https://creativecommons.tankerkoenig.de/#techInfo beachten!

Anforderungen

  • Minimum SmartHomeNG Version: 1.9

Konfiguration

Im folgenden ist beschrieben, wie das Plugin tankerkoenig 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:

apikey

Persönlicher API Key für TankerKoenig. Registrierung unter https://creativecommons.tankerkoenig.de.

  • Datentyp: str

details_update_cycle

(optional) Zeit zwischen zwei Aktualisierung der Tankstellen Details.

  • Datentyp: str

  • Standardwert: weekly

  • Mögliche Werte:

    • daily

    • weekly

    • monthly

price_update_cycle

(optional) Zeit zwischen zwei Preisaktualisierungen.

  • Datentyp: int

  • Standardwert: 900

  • Minimalwert: 60

Item Attribute

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

tankerkoenig_admin

Admin-Funktionen des Plugins

  • Datentyp: str

tankerkoenig_attr

  • Datentyp: str

  • Mögliche Werte:

    • E5

    • E10

    • Diesel

    • Open

    • street

    • houseNumber

    • postCode

    • place

    • address

    • brand

    • name

    • lng

    • lat

tankerkoenig_id

Id der Tankstelle auf tankerkoenig.de

  • Datentyp: str

Item-Structs

Das Plugin stellt die folgenden Item-Structs zur Verfügung. Diese Informationen sind aus der plugin.yaml entnommen und möglicherweise nicht vollständig.

petrol_station

  • petrol_station (foo, —)

    • isopen (bool, —)

    • e5 (num, —)

    • e10 (num, —)

    • diesel (num, —)

    • adresse (str, —)

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_petrol_station_detail(id)

Diese Funktion gibt Details über eine Tankstelle als DICT mit folgenden Keys zurück: ‚e5‘, ‚e10‘, ‚diesel‘, ‚street‘, ‚houseNumber‘, ‚postCode‘, ‚place‘, ‚brand‘, ‚id‘, ‚lng‘, ‚name‘, ‚lat‘, ‚isOpen‘

  • Ergebnistyp der Funktion: dict

id

UUID für die anzufragende Tankstelle.

  • Datentyp: str

get_petrol_station_detail_reduced(id)

Diese Funktion gibt Details über eine Tankstelle als DICT mit folgenden Keys zurück: ‚street‘, ‚houseNumber‘, ‚postCode‘, ‚place‘, ‚brand‘, ‚id‘, ‚lng‘, ‚name‘, ‚lat‘

  • Ergebnistyp der Funktion: dict

id

UUID für die anzufragende Tankstelle.

  • Datentyp: str

get_petrol_station_prices(ids)

Gibt ein DICT mit Preisen für ein Array an Tankstellen-IDs zurück. Benutzung wird vom Tankerkoenig Team aus Performanzgründen empfohlen!!!

  • Ergebnistyp der Funktion: dict

ids

Array der Tankstellen IDs, für die Preise angefragt werden sollen.

  • Datentyp: list(str)

get_petrol_stations(lat, lon, type, sort, rad)

Diese Funktion liefert ein DICT mit den Tankstellen im Umkreis.

  • Ergebnistyp der Funktion: dict

lat

Breitengrad des Mittelpunkts der Anfrage.

  • Datentyp: float

lon

Längengrad des Mittelpunkts der Anfrage.

  • Datentyp: float

type

Typ des Benzins: ‚e5‘, ‚e10‘, ‚diesel‘ oder ‚all‘.

  • Datentyp: str

sort

Sortierreihenfolge der Ergebnisse, ‚price‘ oder ‚dist‘.

  • Datentyp: str

rad

Suchradius in km, Max: 25

  • Datentyp: float