Add documentation

Allow to init the db with a dummy unit

Author: Nicolas

pybecker/becker.py

@@ -9,29 +9,60 @@
 from .becker_helper import generate_code
 
 COMMAND_UP = 0x20
-COMMAND_UP2 = 0x24  # intermediate position "up"
+COMMAND_UP2 = 0x21  # move up
+COMMAND_UP3 = 0x22  # move up
+COMMAND_UP4 = 0x23  # move up
+COMMAND_UP5 = 0x24  # intermediate position "up"
 COMMAND_DOWN = 0x40
-COMMAND_DOWN2 = 0x44  # intermediate position "down"
+COMMAND_DOWN2 = 0x41  # move down
+COMMAND_DOWN3 = 0x42  # move down
+COMMAND_DOWN4 = 0x43  # move down
+COMMAND_DOWN5 = 0x44  # intermediate position "down" (sun protection)
 COMMAND_HALT = 0x10
 COMMAND_PAIR = 0x80  # pair button press
 COMMAND_PAIR2 = 0x81  # pair button pressed for 3 seconds (without releasing)
 COMMAND_PAIR3 = 0x82  # pair button pressed for 6 seconds (without releasing)
 COMMAND_PAIR4 = 0x83  # pair button pressed for 10 seconds (without releasing)
 
+COMMAND_CLEARPOS = 0x90
+COMMAND_CLEARPOS2 = 0x91
+COMMAND_CLEARPOS3 = 0x92
+COMMAND_CLEARPOS4 = 0x93
+
 DEFAULT_DEVICE_NAME = '/dev/serial/by-id/usb-BECKER-ANTRIEBE_GmbH_CDC_RS232_v125_Centronic-if00'
 
 logging.basicConfig()
 _LOGGER = logging.getLogger(__name__)
 
 
 class Becker:
+    """
+        Becker Shutter Controller
+        =========================
+
+        Use this class to perform operations on your Becker Shutter using a centronic USB Stick
+        This class will as well maintain a call increment in an internal database
+    """
+    def __init__(self, device_name=DEFAULT_DEVICE_NAME, init_dummy=False):
+        """
+            Create a new instance of the Becker controller
 
-    def __init__(self, device_name=DEFAULT_DEVICE_NAME):
+            :param  device_name: The path for the centronic stick (default /dev/serial/by-id/usb-BECKER-ANTRIEBE_GmbH_CDC_RS232_v125_Centronic-if00).
+            :param  init_dummy: Boolean that indicate if the database should be initialized with a dummy unit (default False).
+            :type device_name: str
+            :type init_dummy: bool
+        """
         self.is_serial = "/" in device_name
         if self.is_serial and not os.path.exists(device_name):
             raise FileExistsError(device_name + " don't exists")
         self.device = device_name
         self.db = Database()
+
+        # If no unit is defined create a dummy one
+        units = self.db.get_all_units()
+        if not units and init_dummy:
+            self.db.init_dummy()
+
         if self.is_serial:
             self.s = serial.Serial(self.device, 115200, timeout=1)
             self.write_function = self.s.write
@@ -59,13 +90,13 @@ async def run_codes(self, channel, unit, cmd, test):
         if cmd == "UP":
             codes.append(generate_code(channel, unit, COMMAND_UP))
         elif cmd == "UP2":
-            codes.append(generate_code(channel, unit, COMMAND_UP2))
+            codes.append(generate_code(channel, unit, COMMAND_UP5))
         elif cmd == "HALT":
             codes.append(generate_code(channel, unit, COMMAND_HALT))
         elif cmd == "DOWN":
             codes.append(generate_code(channel, unit, COMMAND_DOWN))
         elif cmd == "DOWN2":
-            codes.append(generate_code(channel, unit, COMMAND_DOWN2))
+            codes.append(generate_code(channel, unit, COMMAND_DOWN5))
         elif cmd == "TRAIN":
             codes.append(generate_code(channel, unit, COMMAND_PAIR))
             unit[1] += 1
@@ -76,6 +107,16 @@ async def run_codes(self, channel, unit, cmd, test):
             codes.append(generate_code(channel, unit, COMMAND_PAIR2))
             # set unit as configured
             unit[2] = 1
+        elif cmd == "CLEARPOS":
+            codes.append(generate_code(channel, unit, COMMAND_PAIR))
+            unit[1] += 1
+            codes.append(generate_code(channel, unit, COMMAND_CLEARPOS))
+            unit[1] += 1
+            codes.append(generate_code(channel, unit, COMMAND_CLEARPOS2))
+            unit[1] += 1
+            codes.append(generate_code(channel, unit, COMMAND_CLEARPOS3))
+            unit[1] += 1
+            codes.append(generate_code(channel, unit, COMMAND_CLEARPOS4))
         elif cmd == "REMOVE":
             codes.append(generate_code(channel, unit, COMMAND_PAIR))
             unit[1] += 1
@@ -125,43 +166,55 @@ async def send(self, channel, cmd, test=False):
                 await self.run_codes(ch, unit, cmd, test)
 
     async def move_up(self, channel):
-        """ Sent the command to move up for a given channel.
+        """
+            Send the command to move up for a given channel.
 
-        :param channel: the channel on which the shutter is listening
+            :param channel: the channel on which the shutter is listening
+            :type channel: str
         """
         await self.send(channel, "UP")
 
     async def move_up_intermediate(self, channel):
-        """ Sent the command to move up in the intermediate position for a given channel.
+        """
+            Send the command to move up in the intermediate position for a given channel.
 
-        :param channel: the channel on which the shutter is listening
+            :param channel: the channel on which the shutter is listening
+            :type channel: str
         """
         await self.send(channel, "UP2")
 
     async def move_down(self, channel):
-        """ Sent the command to move down for a given channel.
+        """
+            Sent the command to move down for a given channel.
 
-        :param channel: the channel on which the shutter is listening
+            :param channel: the channel on which the shutter is listening
+            :type channel: str
         """
         await self.send(channel, "DOWN")
 
     async def move_down_intermediate(self, channel):
-        """ Sent the command to move down in the intermediate position for a given channel.
+        """
+            Send the command to move down in the intermediate position for a given channel.
 
-        :param channel: the channel on which the shutter is listening
+            :param channel: the channel on which the shutter is listening
+            :type channel: str
         """
         await self.send(channel, "DOWN2")
 
     async def stop(self, channel):
-        """ Sent the command to stop for a given channel.
+        """
+            Send the command to stop for a given channel.
 
-        :param channel: the channel on which the shutter is listening
+            :param channel: the channel on which the shutter is listening
+            :type channel: str
         """
         await self.send(channel, "HALT")
 
     async def pair(self, channel):
-        """ Initiate the pairing for a given channel.
+        """
+            Initiate the pairing for a given channel.
 
-        :param channel: the channel on which the shutter is listening
+            :param channel: the channel on which the shutter is listening
+            :type channel: str
         """
         await self.send(channel, "TRAIN")

pybecker/database.py

@@ -2,6 +2,7 @@
 import os
 import time
 import sqlite3
+from random import randrange
 
 NUMBER_FILE = "centronic-stick.num"
 
@@ -45,6 +46,16 @@ def migrate(self):
             _LOGGER.error('Migration failed')
             self.conn.rollback()
 
+    def init_dummy(self):
+        try:
+            c = self.conn.cursor()
+            inc = randrange(10, 40, 1)
+            c.execute("UPDATE unit SET increment = ?, configured = ? WHERE code = ?", (inc, 1, '1737b',))
+            self.conn.commit()
+        except (sqlite3.Error, OSError):
+            _LOGGER.error('Dummy Unit initialization failed')
+            self.conn.rollback()
+
     def create(self):
         # create the database table
 

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="pybecker",
-    version="1.0.0",
+    version="1.0.1",
     author="Nicolas Berthel",
     author_email="[email protected]",
     install_requires=['pyserial>=3.4'],