Skip to content

Commit

Permalink
plugin stateengine: minor updates and documentation update for se_lea…
Browse files Browse the repository at this point in the history
…ve_action
  • Loading branch information
onkelandy committed Aug 23, 2023
1 parent 42581b1 commit e303121
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 7 deletions.
6 changes: 3 additions & 3 deletions stateengine/StateEngineItem.py
Original file line number Diff line number Diff line change
Expand Up @@ -446,7 +446,7 @@ def run_queue(self):
SeLogger.manage_logdirectory(base, SeLogger.log_directory, True)
self.__logger.debug("Current log level {}, default {}, currently using default {}",
self.__logger.log_level, _default_log_level, self.__logger.using_default_log_level)
if self.__instant_leaveaction.get() == -1:
if self.__instant_leaveaction.get() <= -1:
self.__using_default_instant_leaveaction = True
else:
self.__using_default_instant_leaveaction = False
Expand Down Expand Up @@ -607,9 +607,9 @@ def run_queue(self):
_instant_leaveaction = self.__instant_leaveaction.get()
if self.__using_default_instant_leaveaction:
_instant_leaveaction = self.__default_instant_leaveaction.get()
if _instant_leaveaction == 1:
if _instant_leaveaction >= 1:
_instant_leaveaction = True
elif _instant_leaveaction == 0:
else:
_instant_leaveaction = False
if result is False and last_state == state and _instant_leaveaction is True:
self.__logger.info("Leaving {0} ('{1}'). Running actions immediately.", last_state.id,
Expand Down
2 changes: 1 addition & 1 deletion stateengine/StateEngineLogger.py
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ def decrease_indent(self, by=1):
def log(self, level, text, *args):
# Section given: Check level
_log_level = self.get_loglevel()
if _log_level == -1:
if _log_level <= -1:
self.using_default_log_level = True
_log_level = SeLogger.default_log_level.get()
else:
Expand Down
9 changes: 9 additions & 0 deletions stateengine/user_doc/07_zeitpunkt.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,12 @@ als Attribute definiert werden.

- **on_leave**: Aktionen, die ausgeführt werden, direkt bevor ein
anderer Zustand aktiv wird.

Die Konfiguration von instant_leaveaction bestimmt, ob on_leave Aktionen sofort nach dem Verlassen
eines Zustands ausgeführt werden oder erst am Ende der Statusevaluierung.
Die Option kann sowohl in der globalen Pluginkonfiguration
mittels ``instant_leaveaction`` (boolscher Wert True oder False), als auch pro Item
mittels ``se_instant_leaveaction``festgelegt werden. Letzteres Attribut kann auch
auf ein Item verweisen, dem der Wert -1 = Nutzen des Default Wertes, 0 = False,
1 = True zugewiesen werden kann. Im ``general struct`` sind bereits entsprechende
Einträge und Items angelegt (mit einem Wert von -1).
11 changes: 8 additions & 3 deletions stateengine/user_doc/10_funktionen_variablen.rst
Original file line number Diff line number Diff line change
Expand Up @@ -149,10 +149,15 @@ Bedarf aber auch für andere Zwecke, welche auch immer, genutzt werden.

**item.instant_leaveaction:**
*Information, wie das leave_action Attribut für das Regelwerkitem gesetzt ist*
Die Option instant_leaveaction kann sowohl in der globalen Pluginkonfiguration
mittels ``instant_leaveaction``, als auch pro Item mittels ``se_instant_leaveaction``
festgelegt werden. Sie bestimmt, ob on_leave Aktionen sofort nach dem Verlassen
Die Konfiguration von instant_leaveaction bestimmt, ob on_leave Aktionen sofort nach dem Verlassen
eines Zustands ausgeführt werden oder erst am Ende der Statusevaluierung.
Die Option kann sowohl in der globalen Pluginkonfiguration
mittels ``instant_leaveaction`` (boolscher Wert True oder False), als auch pro Item
mittels ``se_instant_leaveaction`` festgelegt werden. Letzteres Attribut kann auch
auf ein Item verweisen, dem der Wert -1 = Nutzen des Default Wertes, 0 = False,
1 = True zugewiesen werden kann. Im ``general struct`` sind bereits entsprechende
Einträge und Items angelegt (mit einem Wert von -1).


**current.action_name:**
*Der Name der Aktion, in der auf die Variable zugegriffen wird*
Expand Down

0 comments on commit e303121

Please sign in to comment.