Created Custom Kettle Controller (markdown)

Custom-Kettle-Controller.md

@@ -0,0 +1,73 @@
+# Sample Code for Custom Controller
+
+With a controller is possible to control the kettle temperature. You could code hysteresis or PID controller or a special controller for pump systems. All you need is to implement one single Pyhton class
+
+```
+from modules import cbpi
+from modules.core.controller import KettleController
+from modules.core.props import Property
+
+
+@cbpi.controller
+class SampleController(KettleController):
+
+    # Custom Properties
+       
+    # will crate a number field for the user interface
+    p1 = Property.Number("My Number Label", True, 0)
+    
+    # will create a text field for the user interface
+    text1 = Property.Text("My Label", True, "Hello World")
+    
+    # Will create a drop down for the web interface
+    s1 = Property.Select("Select Property", [1,2,3] )
+
+    def stop(self):
+        '''
+        Invoked when the automatic is stopped.
+        Normally you switch off the actors and clean up everything
+        :return: None
+        '''
+        super(KettleController, self).stop()
+        pass
+
+
+    def init(self):
+        '''
+        Invoked when the kettle automatic is switched on. 
+        :return: 
+        '''
+        pass
+    
+    def run(self):
+        '''
+        Each controller is exectuted in its own thread. The run method is the entry point
+        :return: 
+        '''
+        while self.is_running():
+            # YOUR LOGIC GOES HERE
+            
+            # Access the properties
+            self.text1
+            self.p1
+            self.s1
+            
+            # get current kettle temperature
+            self.get_temp()
+            
+            # get current kettle target temperature 
+            self.get_target_temp()
+            
+            # switch heater on
+            self.heater_on(100)
+            
+            # switch heater off
+            self.heater_off()
+            
+            # get sensor value. The method takes the sensor id as in value.
+            self.get_sensor_value(1)
+           
+            # Make sure to add a sleep between each iteration. Use self.sleep
+            
+            self.sleep(1)
+```