From d44615fe8b35ae6e10e634def3858bf9d4866fa0 Mon Sep 17 00:00:00 2001 From: Benjamin Braatz Date: Wed, 9 Nov 2022 15:49:36 +0100 Subject: [PATCH] Add more explanation to documentation. --- doc/index.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/index.md b/doc/index.md index 11baa12..2ffa3d3 100644 --- a/doc/index.md +++ b/doc/index.md @@ -169,6 +169,16 @@ git-Repository enthalten: } ``` +Die Konfiguration einer `StateMachine`-Plugin-Instanz enthält ein Attribut +`init`, das den initialen Zustand der Maschine benennt, und ein Attribut +`states`, das ein Objekt enthält, dessen Schlüssel alle möglichen Zustände +der Statemachine sind. +Für jeden Zustand wird in `commands` eine Liste von Nachrichten angegeben, +die beim Betreten des Zustands gesendet werden sollen, während in +`transitions` eine Liste von Transitionen definiert wird, die jeweils ein +Nachrichten-Schema als `trigger` und den Zustand, in den gewechselt werden +soll, als `to` haben. + In der Debug-Oberfläche sieht das Beispiel folgendermaßen aus: ![Debug-Oberfläche](graphit/controlpi-statemachine/DebugView.png) -- 2.34.1