Merge master with blinka migration

yeyeto2788 · yeyeto2788 · commit c647efeeaf49 · 2020-11-06T10:24:36.000+01:00
diff --git a/sensors/linux/float_sensor.py b/sensors/linux/float_sensor.py
@@ -25,6 +25,6 @@ def read(self):
         value = self.gpio_pin.value
         return value
 
-    def readRaw(self):
+    def read_raw(self):
         """Read the sensor(s) but return the raw data, useful for debugging"""
         return self.read()
diff --git a/sensors/linux/humidity_sensor.py b/sensors/linux/humidity_sensor.py
@@ -1,15 +1,16 @@
-import time
 import json
-import redis
-from .sensor import Sensor
-import adafruit_dht
 import sys
-sys.path.append('..')
+import time
 
+import adafruit_dht
+
+from sensors.linux.sensor import Sensor
+
+sys.path.append('..')
 
 from logger.Logger import Logger, LOG_LEVEL
 
-# r = redis.Redis(host='127.0.0.1', port=6379)
+
 # PIN MODE : OUT | IN
 
 
@@ -21,46 +22,85 @@ def __init__(self, pin, name=None, key=None, model='11', redis_conn=None):
         return
 
     def init_sensor(self):
-        """Initialize the sensor here (i.e. set pin mode, get addresses, etc) this gets called by the worker"""
-        sensor_types = {'11': adafruit_dht.DHT11,
-                        '22': adafruit_dht.DHT22,
-                        '2302': adafruit_dht.DHT22}  # AM2302 = DHT22
+        """
+        Initialize the sensor here (i.e. set pin mode, get addresses, etc)
+        this gets called by the worker
+        """
+        sensor_types = {
+            '11': adafruit_dht.DHT11,
+            '22': adafruit_dht.DHT22,
+            '2302': adafruit_dht.DHT22
+        }  # AM2302 = DHT22
         if self.type in sensor_types:
             self.sensor = sensor_types[self.type]
         else:
-            Logger.log(LOG_LEVEL["warning"], 'Sensor Model Error: Defaulting to DHT11')
+            Logger.log(
+                LOG_LEVEL["warning"],
+                'Sensor Model Error: Defaulting to DHT11'
+            )
             self.sensor = adafruit_dht.DHT11
         return
 
     def read(self):
-        """Read the sensor(s), parse the data and store it in redis if redis is configured"""
+        """
+        Read the sensor(s), parse the data and store it in redis if redis
+        is configured
+        """
+        # Set values just in case we never set them up.
+
+        humidity = None
+        temperature_c = None
 
-        for i in range(15):            # read_retry() not implemented in new lib
+        # read_retry() not implemented in new lib
+        for i in range(15):
             dhtDevice = self.sensor(self.pin)
+
             try:
                 temperature_c = dhtDevice.temperature
                 humidity = dhtDevice.humidity
                 if humidity is not None and temperature_c is not None:
                     break
+
             except RuntimeError:
-                # Errors happen fairly often, DHT's are hard to read, just keep going:
+                # Errors happen fairly often, DHT's are hard to read,
+                # just keep going:
                 time.sleep(2)
                 continue
+
             except Exception as error:
                 self.sensor(self.pin).exit()
-                Logger.log(LOG_LEVEL["error"], f'DHT Reading was Invalid. Trying again next cycle. Details: {error.args[0]}')
+                Logger.log(
+                    LOG_LEVEL["error"],
+                    f'DHT Reading was Invalid. Trying again next cycle. Details: {error.args[0]}'
+                )
                 return None
 
         if humidity is not None and temperature_c is not None:
-            self.r.set(self.key + '_temperature', round(temperature_c * 1.8 + 32, 2))
-            self.r.set(self.key + '_humidity', humidity)
-            readings = {'temperature': round(temperature_c * 1.8 + 32, 2), 'humidity': round(humidity, 2)}
+            self.r.set(
+                self.key + '_temperature',
+                round(temperature_c * 1.8 + 32, 2)
+            )
+            self.r.set(
+                self.key + '_humidity', humidity
+            )
+            readings = {
+                'temperature': round(temperature_c * 1.8 + 32, 2),
+                'humidity': round(humidity, 2)
+            }
             self.r.set(self.key, json.dumps(readings))
             return readings
         else:
-            Logger.log(LOG_LEVEL["error"], 'DHT Reading was Invalid. Trying again next cycle.')
+            Logger.log(
+                LOG_LEVEL["error"],
+                'DHT Reading was Invalid. Trying again next cycle.'
+            )
             return None
 
-    def readRaw(self):
-        """Read the sensor(s) but return the raw data, useful for debugging"""
+    def read_raw(self):
+        """
+        Read the sensor(s) but return the raw data, useful for debugging
+
+        Returns:
+
+        """
         return self.read()
diff --git a/sensors/linux/i2c/bme680_sensor.py b/sensors/linux/i2c/bme680_sensor.py
@@ -1,18 +1,13 @@
-import time
 import json
-import redis
-from .sensor import Sensor
-import board
-from busio import I2C
+import sys
+
 import adafruit_bme680
 
 from logger.Logger import Logger, LOG_LEVEL
+from sensors.linux.i2c.sensor import Sensor
 
-import sys
 sys.path.append('..')
 
-import variables
-
 
 class Bme680Sensor(Sensor):
 
@@ -21,7 +16,9 @@ def __init__(self, address=None, name=None, key=None, redis_conn=None):
         return
 
     def init_sensor(self):
-        self.sensor = adafruit_bme680.Adafruit_BME680_I2C(self.i2c, debug=False)
+        self.sensor = adafruit_bme680.Adafruit_BME680_I2C(
+            self.i2c, debug=False
+        )
         # change this to match the location's pressure (hPa) at sea level
         self.sensor.sea_level_pressure = 1013.25
         return
@@ -39,13 +36,22 @@ def read(self):
             self.r.set(self.key + '_gas', gas)
             self.r.set(self.key + '_pressure', pressure)
             self.r.set(self.key + '_altitude', altitude)
-            readings = {'temperature': temperature, 'humidity': humidity, 'pressure': pressure, 'gas': gas, 'altitude': altitude}
+            readings = {
+                'temperature': temperature,
+                'humidity': humidity,
+                'pressure': pressure,
+                'gas': gas,
+                'altitude': altitude
+            }
             self.r.set(self.key, json.dumps(readings))
             # print('BME680:', readings)
             return readings
         else:
-            Logger.log(LOG_LEVEL["error"], 'Failed to get reading [BME680]. Try again!')
+            Logger.log(
+                LOG_LEVEL["error"],
+                'Failed to get reading [BME680]. Try again!'
+            )
 
-    def readRaw(self):
+    def read_raw(self):
         """Read the sensor(s) but return the raw data, useful for debugging"""
         return self.read()
diff --git a/sensors/linux/i2c/sensor.py b/sensors/linux/i2c/sensor.py
@@ -40,13 +40,13 @@ def read(self):
         # GPIO.input(pin)
         pass
 
-    def readRaw(self):
+    def read_raw(self):
         """Read the sensor(s) but return the raw data, useful for debugging"""
         pass
 
-    # self.pin not defined and readPin() doesn't seemto be called. So I commented it
+    # self.pin not defined and read_pin() doesn't seemto be called. So I commented it
     '''
-    def readPin(self):
+    def read_pin(self):
         """Read the pin from the board. Can be analog or digital based on \"analog_pin_mode\""""
         data = self.gpio.input(self.pin)
         return data
diff --git a/sensors/linux/sensor.py b/sensors/linux/sensor.py
@@ -1,67 +1,53 @@
-import time
-import json
-import redis
-import digitalio
-import board
 import re
+
+import board
+import digitalio
+
 from logger.Logger import Logger, LOG_LEVEL
+from sensors.base_sensor import BaseSensor
 
 
 # PIN MODE : OUT | IN
 
-class Sensor():
+class Sensor(BaseSensor):
 
     def __init__(self, pin, name=None, key=None, redis_conn=None):
+
+        super().__init__(
+            pin=pin,
+            name=name,
+            key=key,
+            redis_conn=redis_conn
+        )
         self.pin_obj = getattr(board, pin)
 
         if re.match(r'D\d+$', pin):
             self.is_digital = True
         elif re.match(r'A\d+$', pin):
             self.is_digital = False
         else:
-            Logger.log(LOG_LEVEL["error"], "Cannot detect pin type (Digital or analog), should be Dxx or Axx for digital or analog. Please refer to https://github.com/adafruit/Adafruit_Blinka/tree/master/src/adafruit_blinka/board")
-
-        if key is None:
-            raise Exception('No "key" Found in Sensor Config')
-        else:
-            self.key = key.replace(" ", "_").lower()
-
-        if name is None:
-            self.name = self.key.replace("_", " ").title()
-        else:
-            self.name = name
+            Logger.log(
+                LOG_LEVEL["error"],
+                "Cannot detect pin type (Digital or analog), should be Dxx or Axx for digital or analog. "
+                "Please refer to "
+                "https://github.com/adafruit/Adafruit_Blinka/tree/master/src/adafruit_blinka/board"
+            )
 
         self.gpio = digitalio
-        try:
-            self.r = redis_conn if redis_conn is not None else redis.Redis(host='127.0.0.1', port=6379)
-        except KeyError:
-            self.r = redis.Redis(host='127.0.0.1', port=6379)
-        return
-
-    def init_sensor(self):
-        """Initialize the sensor here (i.e. set pin mode, get addresses, etc)"""
-        # GPIO.setmode(GPIO.BCM)
-        # GPIO.setup(pin, GPIO.IN)
-        pass
 
-    def read(self):
-        """Read the sensor(s), parse the data and store it in redis if redis is configured"""
-        # GPIO.input(pin)
-        pass
-
-    def readRaw(self):
-        # Read the sensor(s) but return the raw data, useful for debugging
-        pass
-
-    def readPin(self):
+    def read_pin(self):
         """Read the pin from the board.
 
-        pin value must be a blinka Pin. D for a digital input and A for an analog input, followed by the pin number.
-        You check the board-specific pin mapping [here](https://github.com/adafruit/Adafruit_Blinka/blob/master/src/adafruit_blinka/board/).
+        Pin value must be a blinka Pin.
+        D for a digital input and A for an analog input, followed by the
+        pin number.
+
+        You check the board-specific pin mapping
+        [here](https://github.com/adafruit/Adafruit_Blinka/blob/master/src/adafruit_blinka/board/).
 
         Examples:
-        readPin(board.D12)
-        readPin(board.A12)
+        read_pin(board.D12)
+        read_pin(board.A12)
         """
         if self.is_digital:
             data = self.gpio.DigitalInOut(self.pin_obj).value
