Plugin ‚database‘ Konfiguration

plugin logo

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

Beschreibung

Anforderungen

  • Minimum SmartHomeNG Version: 1.9.3.2

Konfiguration

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

connect

  • Datentyp: list(str)

copy_database

  • Datentyp: bool

  • Standardwert: False

copy_database_name

  • Datentyp: str

count_logentries

  • Datentyp: bool

  • Standardwert: False

cycle

  • Datentyp: int

  • Standardwert: 60

default_maxage

  • Datentyp: int

  • Standardwert: 0

  • Minimalwert: 0

driver

  • Datentyp: str

  • Standardwert: sqlite3

max_delete_logentries

  • Datentyp: int

  • Standardwert: 20000

  • Minimalwert: 1000

max_reassign_logentries

  • Datentyp: int

  • Standardwert: 20

  • Minimalwert: 10

precision

  • Datentyp: int

  • Standardwert: 2

prefix

  • Datentyp: str

removeold_cycle

  • Datentyp: int

  • Standardwert: 91

time_precision

  • Datentyp: int

  • Standardwert: 3

  • Minimalwert: 0

  • Maximalwert: 3

Item Attribute

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

database

  • Datentyp: str

database_acl

  • Datentyp: str

  • Standardwert: rw

database_maxage

  • Datentyp: num

  • Minimalwert: 0

database_write_on_shutdown

  • Datentyp: bool

  • Standardwert: True

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.

cleanup()

  • Die Funktion liefert kein Ergebnis

db()

  • Ergebnistyp der Funktion: foo

deleteItem(id)

  • Die Funktion liefert kein Ergebnis

id

  • Datentyp: int

deleteLog(id, time, time_start, time_end, changed, changed_start, changed_end, cur)

  • Die Funktion liefert kein Ergebnis

id

  • Datentyp: int

time

  • Datentyp: int

time_start

  • Datentyp: int

time_end

  • Datentyp: int

changed

  • Datentyp: int

changed_start

  • Datentyp: int

changed_end

  • Datentyp: int

cur

  • Datentyp: foo

dump(dumpfile, id, time, time_start, time_end, changed, changed_start, changed_end, cur)

  • Die Funktion liefert kein Ergebnis

dumpfile

  • Datentyp: str

id

  • Datentyp: int

time

  • Datentyp: int

time_start

  • Datentyp: int

time_end

  • Datentyp: int

changed

  • Datentyp: int

changed_start

  • Datentyp: int

changed_end

  • Datentyp: int

cur

  • Datentyp: foo

id(item)

  • Ergebnistyp der Funktion: int

item

  • Datentyp: foo

insertItem(name, cur)

  • Ergebnistyp der Funktion: int

name

  • Datentyp: str

cur

  • Datentyp: foo

insertLog(id, time, duration, val, it, changed, cur)

  • Die Funktion liefert kein Ergebnis

id

  • Datentyp: int

time

  • Datentyp: int

duration

  • Datentyp: int

val

  • Datentyp: str

it

  • Datentyp: str

changed

  • Datentyp: int

cur

  • Datentyp: foo

readItem(id, cur)

  • Ergebnistyp der Funktion: foo

id

  • Datentyp: int/str

cur

  • Datentyp: foo

readItems(cur)

  • Ergebnistyp der Funktion: foo

cur

  • Datentyp: foo

readLog(id, time)

  • Ergebnistyp der Funktion: foo

id

  • Datentyp: int

time

  • Datentyp: int

readLogs(id, time, time_start, time_end, changed, changed_start, changed_end, cur)

  • Ergebnistyp der Funktion: foo

id

  • Datentyp: int

time

  • Datentyp: int

time_start

  • Datentyp: int

time_end

  • Datentyp: int

changed

  • Datentyp: int

changed_start

  • Datentyp: int

changed_end

  • Datentyp: int

cur

  • Datentyp: foo

updateItem(id, time, duration, val, it, changed, cur)

  • Die Funktion liefert kein Ergebnis

id

  • Datentyp: int

time

  • Datentyp: int

duration

  • Datentyp: int

val

  • Datentyp: str

it

  • Datentyp: str

changed

  • Datentyp: int

cur

  • Datentyp: foo

updateLog(id, time, duration, val, it, changed, cur)

  • Die Funktion liefert kein Ergebnis

id

  • Datentyp: int

time

  • Datentyp: int

duration

  • Datentyp: int

val

  • Datentyp: str

it

  • Datentyp: str

changed

  • Datentyp: int

cur

  • Datentyp: foo