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

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

  • Datentyp: str

details_update_cycle

  • Datentyp: str

  • Standardwert: weekly

  • Mögliche Werte:

    • daily

    • weekly

    • monthly

price_update_cycle

  • 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

  • Datentyp: str

tankerkoenig_attr

  • Datentyp: str

  • Mögliche Werte:

    • E5

    • E10

    • Diesel

    • Open

    • street

    • houseNumber

    • postCode

    • place

    • address

    • brand

    • name

    • lng

    • lat

tankerkoenig_id

  • 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)

  • Ergebnistyp der Funktion: dict

id

  • Datentyp: str

get_petrol_station_detail_reduced(id)

  • Ergebnistyp der Funktion: dict

id

  • Datentyp: str

get_petrol_station_prices(ids)

  • Ergebnistyp der Funktion: dict

ids

  • Datentyp: list(str)

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

  • Ergebnistyp der Funktion: dict

lat

  • Datentyp: float

lon

  • Datentyp: float

type

  • Datentyp: str

sort

  • Datentyp: str

rad

  • Datentyp: float