Replace 'state' by 'new state' in 'set state'
authorBenjamin Braatz <bb@bbraatz.eu>
Fri, 5 Mar 2021 22:34:56 +0000 (23:34 +0100)
committerBenjamin Braatz <bb@bbraatz.eu>
Fri, 5 Mar 2021 22:34:56 +0000 (23:34 +0100)
conf.json
controlpi-plugins/util.py
doc/index.md

index d2be6653a160bd931864dc6f1b563dd3a68a87ad..044eaaf12b5dd4a85f107f4d9b916960f0531fcd 100644 (file)
--- a/conf.json
+++ b/conf.json
@@ -23,7 +23,7 @@
     "TriggerStateOnOff": {
         "plugin": "Alias",
         "from": { "sender": "WaitOn", "event": "finished" },
-        "to": { "target": "Example State", "command": "set state", "state": false }
+        "to": { "target": "Example State", "command": "set state", "new state": false }
     },
     "TriggerWaitOnOff": {
         "plugin": "Alias",
@@ -37,7 +37,7 @@
     "TriggerStateOffOn": {
         "plugin": "Alias",
         "from": { "sender": "WaitOff", "event": "finished" },
-        "to": { "target": "Example State", "command": "set state", "state": true }
+        "to": { "target": "Example State", "command": "set state", "new state": true }
     },
     "TriggerWaitOffOn": {
         "plugin": "Alias",
index 68f78b387b3d9856eba36fd83c37fe66b72d363d..ae4907116d9f40d81c33133ed60fa7f3488d552b 100644 (file)
@@ -78,8 +78,9 @@ class State(BasePlugin):
                 answer = {'sender': self._name, 'state': self._state}
                 await self._bus.send(answer)
             elif message['command'] == 'set state':
-                if 'state' in message and self._state != message['state']:
-                    self._state: bool = message['state']
+                if ('new state' in message and
+                    self._state != message['new state']):
+                    self._state: bool = message['new state']
                     event = {'sender': self._name, 'event': 'changed',
                              'state': self._state}
                     await self._bus.send(event)
@@ -92,6 +93,6 @@ class State(BasePlugin):
                                     'command': 'get state'},
                                    {'target': self._name,
                                     'command': 'set state',
-                                    'state': bool}]
+                                    'new state': bool}]
         self._bus.register(self._name, sends, receives, self._receive)
         super()._process_conf(conf)
index aa07ed160483820efdcae9a65cca4111342c3498..5baba4c38d0854765df0868cccb32ae3d834fe12 100644 (file)
@@ -146,9 +146,9 @@ eingehalten werden, sind aber:
   (aber ohne `'event'`-Schlüssel schickt, da kein wirkliches Ereignis
   eingetreten ist) schickt.
   Da in diesem Plugin der Zustand auch von außen setzbar ist, reagiert es
-  auf ein `'set state'`-Kommando, das einen `'state'`-Schlüssel mit einem
-  neuen, zu setzenden Wert enthält, indem es diesen Zustand setzt (und eine
-  Ereignis-Nachricht sendet, wenn dies eine Änderung war).
+  auf ein `'set state'`-Kommando, das einen `'new state'`-Schlüssel mit
+  einem neuen, zu setzenden Wert enthält, indem es diesen Zustand setzt
+  (und eine Ereignis-Nachricht sendet, wenn dies eine Änderung war).
 - Sowohl der Bus selbst als auch das `State`-Plugin senden als Reaktion auf
   `'get …'`-Nachrichten Antworten, die genau so aufgebaut sind wie die
   Ereignis-Nachrichten, die sie auch aktiv senden, wenn eine Änderung
@@ -235,7 +235,7 @@ Verschaltungen eleganter konfigurieren lassen.
     "TriggerStateOnOff": {
         "plugin": "Alias",
         "from": { "sender": "WaitOn", "event": "finished" },
-        "to": { "target": "Example State", "command": "set state", "state": false }
+        "to": { "target": "Example State", "command": "set state", "new state": false }
     },
     "TriggerWaitOnOff": {
         "plugin": "Alias",
@@ -249,7 +249,7 @@ Verschaltungen eleganter konfigurieren lassen.
     "TriggerStateOffOn": {
         "plugin": "Alias",
         "from": { "sender": "WaitOff", "event": "finished" },
-        "to": { "target": "Example State", "command": "set state", "state": true }
+        "to": { "target": "Example State", "command": "set state", "new state": true }
     },
     "TriggerWaitOffOn": {
         "plugin": "Alias",
@@ -347,7 +347,7 @@ Debug Logger: {'sender': '', 'event': 'registered', 'client': 'Example State',
               {'state': "<class 'bool'>"}],
     'receives': [{'target': 'Example State', 'command': 'get state'},
                  {'target': 'Example State', 'command': 'set state',
-                  'state': "<class 'bool'>"}]}
+                  'new state': "<class 'bool'>"}]}
 Debug Logger: {'sender': '', 'event': 'registered', 'client': 'WaitCheck',
     'sends': [{'event': 'finished'}],
     'receives': [{'target': 'WaitCheck', 'command': 'wait'}]}
@@ -361,7 +361,7 @@ Debug Logger: {'sender': '', 'event': 'registered', 'client': 'WaitOn',
     'sends': [{'event': 'finished'}],
     'receives': [{'target': 'WaitOn', 'command': 'wait'}]}
 Debug Logger: {'sender': '', 'event': 'registered', 'client': 'TriggerStateOnOff',
-    'sends': [{'target': 'Example State', 'command': 'set state', 'state': False}],
+    'sends': [{'target': 'Example State', 'command': 'set state', 'new state': False}],
     'receives': [{'sender': 'WaitOn', 'event': 'finished'}]}
 Debug Logger: {'sender': '', 'event': 'registered', 'client': 'TriggerWaitOnOff',
     'sends': [{'target': 'WaitOff', 'command': 'wait'}],
@@ -370,7 +370,7 @@ Debug Logger: {'sender': '', 'event': 'registered', 'client': 'WaitOff',
     'sends': [{'event': 'finished'}],
     'receives': [{'target': 'WaitOff', 'command': 'wait'}]}
 Debug Logger: {'sender': '', 'event': 'registered', 'client': 'TriggerStateOffOn',
-    'sends': [{'target': 'Example State', 'command': 'set state', 'state': True}],
+    'sends': [{'target': 'Example State', 'command': 'set state', 'new state': True}],
     'receives': [{'sender': 'WaitOff', 'event': 'finished'}]}
 Debug Logger: {'sender': '', 'event': 'registered', 'client': 'TriggerWaitOffOn',
     'sends': [{'target': 'WaitOn', 'command': 'wait'}],
@@ -419,7 +419,7 @@ geändert hat) antwortet.
 ```
 Debug Logger: {'sender': 'WaitOff', 'event': 'finished'}
 Debug Logger: {'sender': 'TriggerStateOffOn', 'target': 'Example State',
-    'command': 'set state', 'state': True}
+    'command': 'set state', 'new state': True}
 Debug Logger: {'sender': 'TriggerWaitOffOn', 'target': 'WaitOn', 'command': 'wait'}
 Debug Logger: {'sender': 'Example State', 'event': 'changed', 'state': True}
 State Change Logger: {'sender': 'Example State', 'event': 'changed', 'state': True}
@@ -440,7 +440,7 @@ eine Abfrage des Zustands ausgelöst.
 ```
 Debug Logger: {'sender': 'WaitOn', 'event': 'finished'}
 Debug Logger: {'sender': 'TriggerStateOnOff', 'target': 'Example State',
-    'command': 'set state', 'state': False}
+    'command': 'set state', 'new state': False}
 Debug Logger: {'sender': 'TriggerWaitOnOff', 'target': 'WaitOff', 'command': 'wait'}
 Debug Logger: {'sender': 'Example State', 'event': 'changed', 'state': False}
 State Change Logger: {'sender': 'Example State', 'event': 'changed', 'state': False}