Port light.py to gpiozero (#80)

Author: sonnyp

control/planktoscopehat/planktoscope/light.py

@@ -4,22 +4,21 @@
 # Logger library compatible with multiprocessing
 from loguru import logger
 
+from gpiozero import DigitalOutputDevice
+
 import os, time
 
 # Library for starting processes
 import multiprocessing
 
 # Basic planktoscope libraries
-import planktoscope.mqtt
-
-import RPi.GPIO
+from . import mqtt
 
 # Library to send command over I2C for the light module on the fan
 import smbus2 as smbus
 
 import enum
 
-
 logger.info("planktoscope.light is loaded")
 
 class i2c_led:
@@ -40,20 +39,19 @@ class Register(enum.IntEnum):
     # This constant defines the current (mA) sent to the LED, 10 allows the use of the full ISO scale and results in a voltage of 2.77v
     DEFAULT_CURRENT = 10
 
-    # This is the BCM pin of the led
-    LED_PIN = 18
-
     def __init__(self):
+        # The led is controlled by LM36011
+        # but on version < 2 of the PlanktoScope hat (for example PlanktoScope v2.6)
+        # the circuit is connected to that pin so it needs to be high
+        # pin is assigned to self to prevent gpiozero from immediately releasing it
+        self.__pin = DigitalOutputDevice(pin=18, initial_value=True)
+
         self.VLED_short = False
         self.thermal_scale = False
         self.thermal_shutdown = False
         self.UVLO = False
         self.flash_timeout = False
         self.IVFM = False
-        RPi.GPIO.setwarnings(False)
-        RPi.GPIO.setmode(RPi.GPIO.BCM)
-        RPi.GPIO.setup(self.LED_PIN, RPi.GPIO.OUT)
-        RPi.GPIO.output(self.LED_PIN, RPi.GPIO.HIGH)
         self.on = False
         try:
             self.force_reset()
@@ -280,7 +278,7 @@ def run(self):
         )
 
         # MQTT Service connection
-        self.light_client = planktoscope.mqtt.MQTT_Client(
+        self.light_client = mqtt.MQTT_Client(
             topic="light", name="light_client"
         )
 
@@ -299,7 +297,6 @@ def run(self):
         self.led.set_torch_current(1)
         self.led.set_flash_current(1)
         self.led.get_flags()
-        RPi.GPIO.cleanup()
         self.light_client.client.publish("status/light", '{"status":"Dead"}')
         self.light_client.shutdown()
         logger.success("Light process shut down! See you!")
@@ -320,4 +317,3 @@ def run(self):
     led.set_torch_current(1)
     led.set_flash_current(1)
     led.get_flags()
-    RPi.GPIO.cleanup()

control/planktoscopehat/planktoscope/stepper.py

@@ -2,9 +2,8 @@
 import time
 import json
 import os
-import planktoscope.mqtt
+from . import mqtt
 import multiprocessing
-import RPi.GPIO
 
 import shush
 
@@ -417,7 +416,7 @@ def run(self):
         # it doesn't see changes and calls made by self.actuator_client because this one
         # only exist in the master process
         # see https://stackoverflow.com/questions/17172878/using-pythons-multiprocessing-process-class
-        self.actuator_client = planktoscope.mqtt.MQTT_Client(
+        self.actuator_client = mqtt.MQTT_Client(
             topic="actuator/#", name="actuator_client"
         )
         # Publish the status "Ready" to via MQTT to Node-RED

control/poetry.lock

@@ -45,11 +45,12 @@ adafruit-circuitpython-motor = "~3.3.1"
 adafruit-ssd1306 = "~1.6.2"
 adafruit-platformdetect = "~3.45.2"
 smbus2 = "~0.4.1"
+spidev = "~3.5"
+gpiozero = "^2.0.1"
 # Note: the following packages are only indirect dependencies, but we need to download wheels from
 # the appropriate sources, so we must explicitly select them here
 rpi-ws281x = "~5.0.0"
 sysv-ipc = "~1.1.0"
-spidev = "~3.5"
 
 [tool.poetry.group.hw-dev]
 optional = true