Merge pull request #2 from hasenradball/develop

added SANITY check methods for SystemCode or ButtonCode

Author: hasenradball

cRcSocketSwitch/cRcSocketSwitch.py

@@ -11,7 +11,11 @@ class for switching remote socket devices as:
     I calculated the corresponding send code in decimal value
     and uses the library rpi-rf to send the command via 433 MHz send device 
     '''
-    
+
+    _button_list = ['a', 'A', 'b', 'B', 'c', 'C', 'd', 'D', 'e', 'E']
+    _button_mapping = {'A':16, 'B':8, 'C':4, 'D':2, 'E':1}
+
+
     def __init__(self, gpio_pin = 17):
         '''
         Constructor for GPIO Pin and Configuration
@@ -20,17 +24,76 @@ def __init__(self, gpio_pin = 17):
         self.config = {'code': None, 'tx_proto': 1, 'tx_pulselength': 320, 'tx_length': 24}
         logging.info("Brennenstuhl RCS1000 N object created with GPIO pin {}".format(self.gpio))
 
+
+    def sanity_check_Systemcode(self, SystemCode_raw):
+        '''
+        check is SystemCode has the intented format of str (e.g: '10000')
+        '''
+        # check if SystemCode ist of type str
+        if isinstance(SystemCode_raw, str):
+            # check now the length of the SystemCode
+            if len(SystemCode_raw) == 5:
+                if set(SystemCode_raw) <= {'0','1'}:
+                    # check if SystemCode contains only '0' or '1'
+                    # SystemCode ok
+                    logging.info("SystemCode is ok: {} - {}\n".format(SystemCode_raw, type(SystemCode_raw)))
+                    return True
+                else:
+                    logging.error("SystemCode is type of str BUT contains NOT only '0' or '1': {} - {}\n".format(SystemCode_raw, type(SystemCode_raw)))
+                    return False
+            else:
+                # SystemCode not ok
+                logging.error("SystemCode length is NOT 5: {} - {}\n".format(SystemCode_raw, type(SystemCode_raw)))
+                return False
+        else:
+            logging.error("SystemCode is not a type of str: {} - {}\n".format(SystemCode_raw, type(SystemCode_raw)))
+            return False
+
+
+    def sanity_check_Buttoncode(self, ButtonCode_raw):
+        '''
+        check the intented format of ButtonCode
+        The ButtonCode can have the following formats:
+            - type str like 'a' or 'A'
+            - type str like '10000'
+            - type int like 1, 2, 4, ...etc
+        '''
+        # check if ButtonCode is of type str
+        if ButtonCode_raw in self._button_list:
+            # ok fine ButtonCode is type of str like 'A', 'B, etc...
+            logging.info("ButtonCode is ok: {} - {}\n".format(ButtonCode_raw, type(ButtonCode_raw)))
+            return True
+        elif isinstance(ButtonCode_raw, str):
+            if len(ButtonCode_raw) == 5:
+                # check if ButtonCode is like '10000'
+                if set(ButtonCode_raw) <= {'0','1'}:
+                    # check if Buttoncode contains only '0' or '1'
+                    logging.info("ButtonCode is ok: {} - {}\n".format(ButtonCode_raw, type(ButtonCode_raw)))
+                    return True
+                else:
+                    logging.error("ButtonCode is type of str BUT contains NOT only '0' or '1': {} - {}\n".format(ButtonCode_raw, type(ButtonCode_raw)))
+                    return False
+            else:
+                logging.error("ButtonCode is type of str BUT len i NOT 5: {} - {}\n".format(ButtonCode_raw, type(ButtonCode_raw)))
+                return False
+        elif isinstance(ButtonCode_raw, int) and ButtonCode_raw < 32:
+            # ButtonCode is of type int and has valid value
+            logging.info("ButtonCode is ok: {} - {}\n".format(ButtonCode_raw, type(ButtonCode_raw)))
+            return True
+        else:
+            logging.error("ButtonCode is type of int BUT has wrong value: {} - {}\n".format(ButtonCode_raw, type(ButtonCode_raw)))
+            return False
+
+
     def prepareCodes(self, SystemCode_raw, ButtonCode_raw, status):
         '''
         this method prepares the codes and checks the imput format in case
         of different usecases
         '''
-        button_list = ['a', 'A', 'b', 'B', 'c', 'C', 'd', 'D', 'e', 'E']
-        button_mapping = {'A':16, 'B':8, 'C':4, 'D':2, 'E':1}
         # check if the input for the ButtonCode is in the Case 'A', 'B', etc...
-        if ButtonCode_raw in button_list:
+        if ButtonCode_raw in self._button_list:
             ButtonCode_raw = ButtonCode_raw.upper()
-            ButtonCode = button_mapping[ButtonCode_raw]
+            ButtonCode = self._button_mapping[ButtonCode_raw]
             ButtonCode = '{:05b}'.format(ButtonCode)
             logging.info("Buttoncode: {}\n".format(ButtonCode))
 
@@ -139,6 +202,7 @@ def calc_DecimalCode_python_style(self, SystemCode, ButtonCode, status):
         logging.info("binary string: {}\n".format(binstr))
         return int(binstr, 2)
 
+
     def send(self, systemCode, btn_code, status):
         '''
         Method to prepare the codes and send it to the actuator

switchSocket.py

@@ -38,6 +38,8 @@
     try:
         # create Brennenstuhl RCS1000N object 
         obj = cRcSocketSwitch.RCS1000N(gpio_pin)
+        #obj.sanity_check_Systemcode('10000')
+        #obj.sanity_check_Buttoncode(32)
         # prepare and send values
         obj.send(*values1)
     finally: