Plugin ‚jsonread‘ Konfiguration

plugin logo

Im folgenden sind etwaige Anforderungen und unterstützte Hardware beschrieben. Danach folgt die Beschreibung, wie das Plugin jsonread 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

json Parser Plugin

Anforderungen

  • Minimum SmartHomeNG Version: 1.12

  • Minimum Python Version: 3.9

Konfiguration

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

cycle

Das Abfrage-Intervall für die gegebene Datenquelle in Sekunden

  • Datentyp: int

  • Standardwert: 30

  • Minimalwert: 0

jq_syntax

Wenn true (Standard), werden jsonread_filter-Ausdrücke im auch bisher verwendeten jq-Dialekt interpretiert (führender Punkt, [„N“]-Array-Index, select()-Syntax). Wenn false, werden Ausdrücke direkt als native JMESPath-Syntax übergeben — für Nutzer, die zu JMESPath migrieren oder neu einsteigen und von einer vollständig getesteten Bibliothek profitieren wollen.

  • Datentyp: bool

  • Standardwert: True

url

URL der JSON Datenquelle. Aktuell unterstützt werden Webprotokolle https:// und http:// sowie ein Dateiadapter file:/// (benötigt wirklich 3 Schrägstriche)

  • Datentyp: str

Item Attribute

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

jsonread_filter

JQ Pfad, um innerhalb eines JSON-Datensatzes einen Wert auszuwählen. Dieser Wert wird dem Item dann zugewiesen.

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

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.

Keine