Skip to content

Commit

Permalink
stateengine plugin: update docu with info about list items
Browse files Browse the repository at this point in the history
  • Loading branch information
onkelandy committed Oct 3, 2023
1 parent e3168f4 commit f535193
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
2 changes: 1 addition & 1 deletion stateengine/user_doc/05_bedingungen.rst
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ Wertevergleich
Der zu vergleichende Wert einer Bedingung kann auf folgende Arten definiert werden:

- statischer Wert (also z.B. 500 Lux). Wird angegegeben mit ``value:500``, wobei das value: auch weggelassen werden kann.
- Item (beispielsweise ein Item namens settings.helligkeitsschwellwert). Wird angegeben mit ``item:settings.helligkeitsschwellwert``
- Item (beispielsweise ein Item namens settings.helligkeitsschwellwert). Wird angegeben mit ``item:settings.helligkeitsschwellwert``. Das Item kann auch eine Liste von Werten beinhalten.
- Eval-Funktion (siehe auch `eval Ausdrücke <https://www.smarthomeng.de/user/referenz/items/standard_attribute/eval.html>`_). Wird angegeben mit ``eval:1*2*se_eval.get_relative_itemvalue('..bla')``
- Regular Expression (siehe auch ` RegEx Howto <https://docs.python.org/3/howto/regex.html>`_) - Vergleich mittels re.fullmatch, wobei Groß/Kleinschreibung ignoriert wird. Wird angegeben mit ``regex:StateEngine Plugin:(.*)``
- Template: eine Vorlage, z.B. eine eval Funktion, die immer wieder innerhalb
Expand Down
10 changes: 6 additions & 4 deletions stateengine/user_doc/13_sonstiges.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,9 @@ Seit Version 1.8 wird se_use gleich behandelt wie andere Plugin spezifische Attr
Dadurch ist es nicht nur möglich, eine Liste von einzubindenden Zuständen zu deklarieren,
sondern auch auf die verschiedenen Schlüsselwörter zurückzugreifen:

- item:<Itempfad> liest den Wert aus gegebenem Item aus und nutzt diesen als Zustandserweiterung
- item:<Itempfad> liest den Wert aus gegebenem Item aus und nutzt diesen als Zustandserweiterung. Es ist möglich,
mehrere Zustände als Liste im Item zu deklarieren, indem entweder ein Item mit Typ "list" referenziert wird
oder mehrere Einträge in einem "str" Item durch ein Komma getrennt angegeben werden.
- eval:<Ausdruck> ermöglicht das dynamische Erweitern des Zustands, z.B. abhängig von einem vorigen Zustand, etc.
- value:<Itempfad> sucht das angegebene Item und bindet dieses ein. Der Wert kann auch als
relativer Pfad angegeben werden. Hierbei ist zu beachten, dass die relative Adressierung
Expand Down Expand Up @@ -65,9 +67,9 @@ eingenommen werden könnten. Gewünscht wird dies normalerweise beim
Suspendzustand, allerdings kann das Attribut bei jedem
beliebigem Zustand genutzt werden. Seit Version 2.0 wird se_released_by gleich
behandelt wie andere Plugin spezifische Attribute mit Wertzuweisung, es können
also alle gültigen Schlüsselwörter genutzt werden. Außerdem wurde in
der Pluginversion 2.0 das released_by Feature komplett überarbeitet, sodass
es nun zuverlässig funktionieren sollte ;)
also alle gültigen Schlüsselwörter und auch Listenangaben in Items genutzt werden.
Außerdem wurde in der Pluginversion 2.0 das released_by Feature komplett überarbeitet,
sodass es nun zuverlässig funktionieren sollte ;)

Ein Zustand mit diesem Attribut wird aufgelöst, also
(vorerst) nicht mehr eingenommen, sobald ein mit dem
Expand Down

0 comments on commit f535193

Please sign in to comment.