Changes between Version 43 and Version 44 of Proposal

Timestamp:

Jul 8, 2013, 2:27:02 PM (11 years ago)

Author:

Frédéric

Comment:

--

Proposal

@@ -154 +154 @@
 == Simple rule ==
 
-My first idea was to provide a special API to create rules, in a simple way, like this:
-
-{{{
-#!python
-from pknyx.api import trigger, group
-
-@trigger.schedule.every(minute=5)
-def heatingBathroomManagement(event):
-
-    tempObj = group.findById("bathroom_temp")
-    tempSetupObj = group.findById("bathroom_temp_setup")
-    heaterObj = group.findById("bathroom_heater")
-
-    if tempObj.value < tempSetupObj.value - 0.25:
-        heaterObj.value = 1
-    elif tempObj.value > tempSetupObj.value + 0.25:
-        heaterObj.value = 0
-}}}
-
-but it implies to define the group objects mapping, which is exactly what we did in the [[#VirtualDevice|Virtual Device]] example! So, let's see rules as virtual devices... All we have to do is to define the needed Datapoints:
-
-{{{
-#!python
-from pknyx.api import Rule, Stack, ETS
-
-stack = Stack()
+My first idea was to provide a special API to create rules, but in fact, they can be implemented as Functional Block. This way, we use the same paradigm, wich is always better ;o)
+
+{{{
+#!python
+from pknyx.api import FunctionalBlock, Stack, ETS, Scheduler
+
+
+stack = Stack(individualAddress="1.2.3")
 ets = ETS(stack)
-
-class BathroomHeater(Rule):
-
-    DP_01 = dict(name="bathroom_temp", dptId="9.001", flags="CWTU", priority="low")
-    DP_02 = dict(name="bathroom_temp_setup", dptId="9.001", flags="CWTU", priority="low")
-    DP_03 = dict(name="bathroom_heater", dptId="1.001", flags="CWTU", priority="low")
-
-    @Rule.schedule.every(minute=5)
-    def checkTemperature(self):
-
-        if self.dp["bathroom_temp"].value < self.dp["bathroom_temp_setup"].value - 0.25:
-            self.dp["bathroom_heater"].value = "On"
-        elif self.dp["bathroom_temp"].value > self.dp["bathroom_temp_setup"].value + 0.25:
-            self.dp["bathroom_heater"].value = "Off"
-
-heater = BathroomHeater(name="bathroom_heater", desc="Bathroom heating management", address="1.2.3")
-ets.register(heaterRule)
-ets.link(rule=heater, dp="bathroom_temp", gad="1/1/1")
-ets.link(rule=heater, dp="bathroom_temp_setup", gad="1/1/2")
-ets.link(rule=heater, dp="bathroom_heater", gad="1/1/3")
-}}}
-
-This way, we use the same paradigm, which is always better ;)
-
+schedule = Scheduler()
+
+
+class HeatingManagerBlock(FunctionalBlock):
+
+    DP_01 = dict(name="temperature", access="input", dptId="9.001", default=19.)
+    DP_02 = dict(name="setup", access="input", dptId="9.001", default=19.)
+    DP_03 = dict(name="heater", access="output", dptId="1.001", default="Off")
+
+    GO_01 = dict(dp="temperature", flags="CWU", priority="low")
+    GO_02 = dict(dp="setup", flags="CWU", priority="low")
+    GO_03 = dict(dp="heater", flags="CRT", priority="low")
+
+    @schedule.every(minute=5)
+    def manageHeater(self):
+
+        # Read inputs
+        temperature = self.dp["bathroom"].value
+        setup = self.dp["setup"].value
+
+        # Manage heater
+        if temperature < setup - 0.25:
+            heater = "On"
+        elif temperature > setup + 0.25:
+            heater = "Off"
+
+        # Set outputs
+        self.dp["bathroom_heater"].value = heater
+
+
+heatingManagerBlock = HeatingManagerBlock(name="heating_manager", desc="A simple heating manager block example")
+
+ets.register(heatingManagerBlock)
+
+ets.weave(fb=heatingManagerBlock, dp="temperature", gad="1/1/1")
+ets.weave(fb=heatingManagerBlock, dp="setup", gad="1/1/2")
+ets.weave(fb=heatingManagerBlock, dp="heater", gad="1/1/3")
+
+stack.serve()
+}}}
+
+All you have to do is to use the Group Addresses you use in your real installation, through ETS application. The first one will update the temperature the Functional Block needs; the second one is used to give the setpoint, and the last one is used to switch on/off a real heater, through a KNX actuator.
+
+Note that it is possible to instanciate several heating managers, and weave them to different heaters.
+
+A more complex heating manager could compute a PID and output the power to use to heat.
 == '''linknx''' compatibility mode ==