Port to new libraries. Fixup examples and tests.

Author: Gadgetoid

enviroplus/__init__.py

@@ -1 +1 @@
-__version__ = '0.0.6'
+__version__ = "0.0.6"

enviroplus/gas.py

@@ -4,20 +4,29 @@
 import time
 
 import ads1015
-import RPi.GPIO as GPIO
+import gpiod
+import gpiodevice
+from gpiod.line import Direction, Value
 
-MICS6814_HEATER_PIN = 24
 MICS6814_GAIN = 6.144
 
+OUTH = gpiod.LineSettings(direction=Direction.OUTPUT, output_value=Value.ACTIVE)
+PLATFORMS = {
+    "Radxa ROCK 5B": {"heater": ("PIN_18", OUTH)},
+    "Raspberry Pi 5": {"heater": ("PIN18", OUTH)},
+    "Raspberry Pi 4": {"heater": ("GPIO24", OUTH)}
+}
+
 ads1015.I2C_ADDRESS_DEFAULT = ads1015.I2C_ADDRESS_ALTERNATE
 _is_setup = False
 _is_available = False
 _adc_enabled = False
 _adc_gain = 6.148
+_heater = None
 
 
 class Mics6814Reading(object):
-    __slots__ = 'oxidising', 'reducing', 'nh3', 'adc'
+    __slots__ = "oxidising", "reducing", "nh3", "adc"
 
     def __init__(self, ox, red, nh3, adc=None):
         self.oxidising = ox
@@ -26,24 +35,20 @@ def __init__(self, ox, red, nh3, adc=None):
         self.adc = adc
 
     def __repr__(self):
-        fmt = """Oxidising: {ox:05.02f} Ohms
-Reducing: {red:05.02f} Ohms
-NH3: {nh3:05.02f} Ohms"""
+        fmt = f"""Oxidising: {self.oxidising:05.02f} Ohms
+Reducing: {self.reducing:05.02f} Ohms
+NH3: {self.nh3:05.02f} Ohms"""
         if self.adc is not None:
-            fmt += """
-ADC: {adc:05.02f} Volts
+            fmt += f"""
+ADC: {self.adc:05.02f} Volts
 """
-        return fmt.format(
-            ox=self.oxidising,
-            red=self.reducing,
-            nh3=self.nh3,
-            adc=self.adc)
+        return fmt
 
     __str__ = __repr__
 
 
 def setup():
-    global adc, adc_type, _is_setup, _is_available
+    global adc, adc_type, _is_setup, _is_available, _heater
     if _is_setup:
         return
     _is_setup = True
@@ -56,17 +61,15 @@ def setup():
         _is_available = False
         return
 
-    adc.set_mode('single')
+    adc.set_mode("single")
     adc.set_programmable_gain(MICS6814_GAIN)
-    if adc_type == 'ADS1115':
+    if adc_type == "ADS1115":
         adc.set_sample_rate(128)
     else:
         adc.set_sample_rate(1600)
 
-    GPIO.setwarnings(False)
-    GPIO.setmode(GPIO.BCM)
-    GPIO.setup(MICS6814_HEATER_PIN, GPIO.OUT)
-    GPIO.output(MICS6814_HEATER_PIN, 1)
+    _heater = gpiodevice.get_pins_for_platform(PLATFORMS)[0]
+
     atexit.register(cleanup)
 
 
@@ -88,7 +91,10 @@ def set_adc_gain(value):
 
 
 def cleanup():
-    GPIO.output(MICS6814_HEATER_PIN, 0)
+    if _heater is None:
+        return
+    lines, offset = _heater
+    lines.set_value(offset, Value.INACTIVE)
 
 
 def read_all():
@@ -98,9 +104,9 @@ def read_all():
     if not _is_available:
         raise RuntimeError("Gas sensor not connected.")
 
-    ox = adc.get_voltage('in0/gnd')
-    red = adc.get_voltage('in1/gnd')
-    nh3 = adc.get_voltage('in2/gnd')
+    ox = adc.get_voltage("in0/gnd")
+    red = adc.get_voltage("in1/gnd")
+    nh3 = adc.get_voltage("in2/gnd")
 
     try:
         ox = (ox * 56000) / (3.3 - ox)
@@ -121,11 +127,11 @@ def read_all():
 
     if _adc_enabled:
         if _adc_gain == MICS6814_GAIN:
-            analog = adc.get_voltage('ref/gnd')
+            analog = adc.get_voltage("ref/gnd")
         else:
             adc.set_programmable_gain(_adc_gain)
             time.sleep(0.05)
-            analog = adc.get_voltage('ref/gnd')
+            analog = adc.get_voltage("ref/gnd")
             adc.set_programmable_gain(MICS6814_GAIN)
 
     return Mics6814Reading(ox, red, nh3, analog)

enviroplus/noise.py

@@ -2,10 +2,8 @@
 import sounddevice
 
 
-class Noise():
-    def __init__(self,
-                 sample_rate=16000,
-                 duration=0.5):
+class Noise:
+    def __init__(self, sample_rate=16000, duration=0.5):
         """Noise measurement.
 
         :param sample_rate: Sample rate in Hz
@@ -39,17 +37,13 @@ def get_amplitude_at_frequency_range(self, start, end):
         """
         n = self.sample_rate // 2
         if start > n or end > n:
-            raise ValueError("Maximum frequency is {}".format(n))
+            raise ValueError(f"Maximum frequency is {n}")
 
         recording = self._record()
         magnitude = numpy.abs(numpy.fft.rfft(recording[:, 0], n=self.sample_rate))
         return numpy.mean(magnitude[start:end])
 
-    def get_noise_profile(self,
-                          noise_floor=100,
-                          low=0.12,
-                          mid=0.36,
-                          high=None):
+    def get_noise_profile(self, noise_floor=100, low=0.12, mid=0.36, high=None):
         """Returns a noise characteristic profile.
 
         Bins all frequencies into 3 weighted groups expressed as a percentage of the total frequency range.
@@ -83,9 +77,9 @@ def get_noise_profile(self,
     def _record(self):
         return sounddevice.rec(
             int(self.duration * self.sample_rate),
-            device='adau7002',
+            device="adau7002",
             samplerate=self.sample_rate,
             blocking=True,
             channels=1,
-            dtype='float64'
+            dtype="float64"
         )

examples/adc.py

@@ -6,9 +6,9 @@
 from enviroplus import gas
 
 logging.basicConfig(
-    format='%(asctime)s.%(msecs)03d %(levelname)-8s %(message)s',
+    format="%(asctime)s.%(msecs)03d %(levelname)-8s %(message)s",
     level=logging.INFO,
-    datefmt='%Y-%m-%d %H:%M:%S')
+    datefmt="%Y-%m-%d %H:%M:%S")
 
 logging.info("""adc.py - Print readings from the MICS6814 Gas sensor.
 

examples/all-in-one-enviro-mini.py

@@ -5,7 +5,7 @@
 import sys
 import time
 
-import ST7735
+import st7735
 
 try:
     # Transitional fix for breaking change in LTR559
@@ -22,23 +22,23 @@
 from PIL import Image, ImageDraw, ImageFont
 
 logging.basicConfig(
-    format='%(asctime)s.%(msecs)03d %(levelname)-8s %(message)s',
+    format="%(asctime)s.%(msecs)03d %(levelname)-8s %(message)s",
     level=logging.INFO,
-    datefmt='%Y-%m-%d %H:%M:%S')
+    datefmt="%Y-%m-%d %H:%M:%S")
 
-logging.info("""all-in-one.py - Displays readings from all of Enviro plus' sensors
+logging.info("""all-in-one.py - Displays readings from all of Enviro plus" sensors
 Press Ctrl+C to exit!
 """)
 
 # BME280 temperature/pressure/humidity sensor
 bme280 = BME280()
 
 # Create ST7735 LCD display class
-st7735 = ST7735.ST7735(
+st7735 = st7735.ST7735(
     port=0,
     cs=1,
-    dc=9,
-    backlight=12,
+    dc="PIN21",         # "GPIO9" on a Raspberry Pi 4
+    backlight="PIN32",  # "GPIO12" on a Raspberry Pi 4
     rotation=270,
     spi_speed_hz=10000000
 )
@@ -50,7 +50,7 @@
 HEIGHT = st7735.height
 
 # Set up canvas and font
-img = Image.new('RGB', (WIDTH, HEIGHT), color=(0, 0, 0))
+img = Image.new("RGB", (WIDTH, HEIGHT), color=(0, 0, 0))
 draw = ImageDraw.Draw(img)
 path = os.path.dirname(os.path.realpath(__file__))
 font_size = 20
@@ -71,7 +71,7 @@ def display_text(variable, data, unit):
     vmax = max(values[variable])
     colours = [(v - vmin + 1) / (vmax - vmin + 1) for v in values[variable]]
     # Format the variable name and value
-    message = "{}: {:.1f} {}".format(variable[:4], data, unit)
+    message = f"{variable[:4]}: {data:.1f} {unit}"
     logging.info(message)
     draw.rectangle((0, 0, WIDTH, HEIGHT), (255, 255, 255))
     for i in range(len(colours)):
@@ -90,9 +90,9 @@ def display_text(variable, data, unit):
 
 # Get the temperature of the CPU for compensation
 def get_cpu_temperature():
-    process = Popen(['vcgencmd', 'measure_temp'], stdout=PIPE, universal_newlines=True)
+    process = Popen(["vcgencmd", "measure_temp"], stdout=PIPE, universal_newlines=True)
     output, _error = process.communicate()
-    return float(output[output.index('=') + 1:output.rindex("'")])
+    return float(output[output.index("=") + 1:output.rindex("'")])
 
 
 # Tuning factor for compensation. Decrease this number to adjust the
@@ -131,7 +131,7 @@ def get_cpu_temperature():
         # One mode for each variable
         if mode == 0:
             # variable = "temperature"
-            unit = "C"
+            unit = "°C"
             cpu_temp = get_cpu_temperature()
             # Smooth out with some averaging to decrease jitter
             cpu_temps = cpu_temps[1:] + [cpu_temp]

examples/all-in-one-no-pm.py

@@ -5,7 +5,7 @@
 import sys
 import time
 
-import ST7735
+import st7735
 
 try:
     # Transitional fix for breaking change in LTR559
@@ -23,9 +23,9 @@
 from enviroplus import gas
 
 logging.basicConfig(
-    format='%(asctime)s.%(msecs)03d %(levelname)-8s %(message)s',
+    format="%(asctime)s.%(msecs)03d %(levelname)-8s %(message)s",
     level=logging.INFO,
-    datefmt='%Y-%m-%d %H:%M:%S')
+    datefmt="%Y-%m-%d %H:%M:%S")
 
 logging.info("""all-in-one.py - Displays readings from all of Enviro plus' sensors
 Press Ctrl+C to exit!
@@ -35,11 +35,11 @@
 bme280 = BME280()
 
 # Create ST7735 LCD display class
-st7735 = ST7735.ST7735(
+st7735 = st7735.ST7735(
     port=0,
     cs=1,
-    dc=9,
-    backlight=12,
+    dc="PIN21",         # "GPIO9" on a Raspberry Pi 4
+    backlight="PIN32",  # "GPIO12" on a Raspberry Pi 4
     rotation=270,
     spi_speed_hz=10000000
 )
@@ -51,7 +51,7 @@
 HEIGHT = st7735.height
 
 # Set up canvas and font
-img = Image.new('RGB', (WIDTH, HEIGHT), color=(0, 0, 0))
+img = Image.new("RGB", (WIDTH, HEIGHT), color=(0, 0, 0))
 draw = ImageDraw.Draw(img)
 path = os.path.dirname(os.path.realpath(__file__))
 font_size = 20
@@ -72,7 +72,7 @@ def display_text(variable, data, unit):
     vmax = max(values[variable])
     colours = [(v - vmin + 1) / (vmax - vmin + 1) for v in values[variable]]
     # Format the variable name and value
-    message = "{}: {:.1f} {}".format(variable[:4], data, unit)
+    message = f"{variable[:4]}: {data:.1f} {unit}"
     logging.info(message)
     draw.rectangle((0, 0, WIDTH, HEIGHT), (255, 255, 255))
     for i in range(len(colours)):
@@ -136,7 +136,7 @@ def get_cpu_temperature():
         # One mode for each variable
         if mode == 0:
             # variable = "temperature"
-            unit = "C"
+            unit = "°C"
             cpu_temp = get_cpu_temperature()
             # Smooth out with some averaging to decrease jitter
             cpu_temps = cpu_temps[1:] + [cpu_temp]

examples/all-in-one.py

@@ -4,7 +4,7 @@
 import sys
 import time
 
-import ST7735
+import st7735
 
 try:
     # Transitional fix for breaking change in LTR559
@@ -24,9 +24,9 @@
 from enviroplus import gas
 
 logging.basicConfig(
-    format='%(asctime)s.%(msecs)03d %(levelname)-8s %(message)s',
+    format="%(asctime)s.%(msecs)03d %(levelname)-8s %(message)s",
     level=logging.INFO,
-    datefmt='%Y-%m-%d %H:%M:%S')
+    datefmt="%Y-%m-%d %H:%M:%S")
 
 logging.info("""all-in-one.py - Displays readings from all of Enviro plus' sensors
 
@@ -41,11 +41,11 @@
 pms5003 = PMS5003()
 
 # Create ST7735 LCD display class
-st7735 = ST7735.ST7735(
+st7735 = st7735.ST7735(
     port=0,
     cs=1,
-    dc=9,
-    backlight=12,
+    dc="PIN21",         # "GPIO9" on a Raspberry Pi 4
+    backlight="PIN32",  # "GPIO12" on a Raspberry Pi 4
     rotation=270,
     spi_speed_hz=10000000
 )
@@ -57,7 +57,7 @@
 HEIGHT = st7735.height
 
 # Set up canvas and font
-img = Image.new('RGB', (WIDTH, HEIGHT), color=(0, 0, 0))
+img = Image.new("RGB", (WIDTH, HEIGHT), color=(0, 0, 0))
 draw = ImageDraw.Draw(img)
 font_size = 20
 font = ImageFont.truetype(UserFont, font_size)
@@ -77,7 +77,7 @@ def display_text(variable, data, unit):
     vmax = max(values[variable])
     colours = [(v - vmin + 1) / (vmax - vmin + 1) for v in values[variable]]
     # Format the variable name and value
-    message = "{}: {:.1f} {}".format(variable[:4], data, unit)
+    message = f"{variable[:4]}: {data:.1f} {unit}"
     logging.info(message)
     draw.rectangle((0, 0, WIDTH, HEIGHT), (255, 255, 255))
     for i in range(len(colours)):
@@ -144,7 +144,7 @@ def get_cpu_temperature():
         # One mode for each variable
         if mode == 0:
             # variable = "temperature"
-            unit = "C"
+            unit = "°C"
             cpu_temp = get_cpu_temperature()
             # Smooth out with some averaging to decrease jitter
             cpu_temps = cpu_temps[1:] + [cpu_temp]