Changes between Version 40 and Version 41 of Proposal

Timestamp:

Jul 8, 2013, 1:31:51 PM (11 years ago)

Author:

Frédéric

Comment:

--

Proposal

@@ -99 +99 @@
 
 The {{{Stack}}} object is used to communicate over the bus (real bus, of course, but also on virtual bus). We can give it an Individual Address, to mimic real devices behaviour.
-The {{{ETS}}} object is a tool which works like the reall ETS application.
-
-The {{{Stack}}} object is used to weave (bind, link...) our Group Objects to Group Addresses:
+
+The {{{ETS}}} object is a tool which works like the reall ETS application, and used to weave (bind, link...) our Group Objects to Group Addresses:
 
 {{{
@@ -116 +115 @@
 }}}
 
-This call is blocking. We now have a process (Device) running, listening to the bus. The Datapoints, through their respective Group Objects, will react to requests on the Group Addresses their are weaved to ("1/1/1" and "1/1/2"). According to the flags, they will transmit their internal value on a Read request, or if this value changes.
+This call is blocking, and launch the framework main loop.
+
+We now have a process (Device) running, listening to the bus. The Datapoints, through their respective Group Objects, will react to requests on the Group Addresses their are weaved to ("1/1/1" and "1/1/2"). According to the flags, they will transmit their internal value on a Read request, or if this value changes.
 
 Ok, but our Functional Block is not really usefull yet, as it does not refresh its Datapoints! Let's see how it can be done:
@@ -137 +138 @@
     GO_02 = dict(dp="humidity", flags="CRT", priority="low")
 
-    schedule.every(minute=5)
+    @schedule.every(minute=5)
     def updateTemperaturHumidity(self, event):
 
@@ -146 +147 @@
         self.dp["humidity"] = humidity
 
+
 weatherTempBlock = WeatherTemperatureBlock(name="weather_tempertature", desc="A simple weather block example")
 
@@ -157 +159 @@
 }}}
 
-All we do, here, is adding a method periodically called by the framework (every 5 minutes in the above example). In this method, we retreive the temperature and humidity values (not explained here), and give the value to the respective Datapoints. If the value has changed from the previous call, the Datapoint will automagically transmit it to the bus (according to the flags, of course).
+We have just imported and instanciated an additionnal object:
+
+{{{
+#!python
+from pknyx.api import Scheduler
+
+
+schedule = Scheduler()
+}}}
+
+We have also defined a method which role is to update the temperature and humidity Datapoints values:
+
+{{{
+#!python
+    @schedule.every(minute=5)
+    def updateTemperaturHumidity(self, event):
+
+        # How we retreive the temperature/humidity is out of the scope of this proposal
+        # temperature = xxx
+        # humidity = xxx
+        self.dp["temperature"] = temperature
+        self.dp["humidity"] = humidity
+}}}
+
+Note how this method is periodically called, using the {{{schedule.every()}}} method as python decorator. This decorator will automatically register our method and call it every 5 minutes.
+
+In our method, we retreive the temperature and humidity values (not explained here), and give the value to the respective Datapoints. If the value has changed from the previous call, the Datapoint will automagically transmit it to the bus (according to the flags, of course).
 
 That's it for now. This is only a draft version; final implementation may change, according to feedback/suggestions I will get. But the core is all there. Again, the goal of the framework is to provide very high level tools to build complete and powerfull applications and KNX extensions.