Merge pull request #15 from arduino/latch-relay

Add Latch relay support

Author: sebromero

examples/latch_relay.py

@@ -0,0 +1,29 @@
+"""
+This example demonstrates how to use the Modulino Latch Relay module 
+to turn a relay on and off repeatedly.
+
+Initial author: Sebastian Romero (s.romero@arduino.cc)
+"""
+
+from modulino import ModulinoLatchRelay
+from time import sleep_ms
+
+relay = ModulinoLatchRelay()
+initial_state = relay.is_on
+
+if initial_state is None:
+    print("Relay state is unknown (last state before poweroff is maintained)")
+else:
+    print(f"Relay is currently {'on' if initial_state else 'off'}")
+
+while True:    
+    print("Turning relay on")
+    relay.on()
+    sleep_ms(150) # Wait for the relay to settle
+    print(f"Relay is currently {'on' if relay.is_on else 'off'}")
+    sleep_ms(1000)  # Keep the relay on for 1 second
+    print("Turning relay off")
+    relay.off()
+    sleep_ms(150) # Wait for the relay to settle
+    print(f"Relay is currently {'on' if relay.is_on else 'off'}")
+    sleep_ms(1000)  # Keep the relay off for 1 second

package.json

@@ -11,7 +11,8 @@
       ["modulino/movement.py", "github:arduino/modulino-mpy/src/modulino/movement.py"],
       ["modulino/pixels.py", "github:arduino/modulino-mpy/src/modulino/pixels.py"],
       ["modulino/thermo.py", "github:arduino/modulino-mpy/src/modulino/thermo.py"],
-      ["modulino/joystick.py", "github:arduino/modulino-mpy/src/modulino/joystick.py"]
+      ["modulino/joystick.py", "github:arduino/modulino-mpy/src/modulino/joystick.py"],
+      ["modulino/latch_relay.py", "github:arduino/modulino-mpy/src/modulino/latch_relay.py"]
     ],
     "deps": [
       ["lsm6dsox", "latest"],

src/modulino/__init__.py

@@ -13,4 +13,5 @@
 from .knob import ModulinoKnob
 from .movement import ModulinoMovement
 from .distance import ModulinoDistance
-from .joystick import ModulinoJoystick
+from .joystick import ModulinoJoystick
+from .latch_relay import ModulinoLatchRelay

src/modulino/latch_relay.py

@@ -0,0 +1,48 @@
+from .modulino import Modulino
+
+class ModulinoLatchRelay(Modulino):
+  """
+  Class to control the relay module of the Modulino.
+  """
+
+  default_addresses = [0x4]
+
+  def __init__(self, i2c_bus=None, address=None):
+    """
+    Initializes the Modulino Buzzer.
+
+    Parameters:
+        i2c_bus (I2C): The I2C bus to use. If not provided, the default I2C bus will be used.
+        address (int): The I2C address of the module. If not provided, the default address will be used.
+    """
+    super().__init__(i2c_bus, address, "Latch Relay")
+    self.data = bytearray(3)
+
+  def on(self) -> None:
+    """
+    Turns on the relay.
+    """
+    self.data[0] = 1
+    self.write(self.data)
+    
+  def off(self) -> None:
+    """
+    Turns off the relay.
+    """
+    self.data[0] = 0
+    self.write(self.data)
+
+  @property
+  def is_on(self) -> bool:
+    """
+    Checks if the relay is currently on.
+    """
+    status = self.read(3)
+    if status[0] == 0 and status[1] == 0:
+      return None # last status before poweroff is maintained
+    
+    if status[0] == 1:
+        return False
+    
+    return True
+    

src/modulino/modulino.py

@@ -21,7 +21,8 @@
   0x76: "Knob",
   0x74: "Knob",
   0x6C: "Pixels",
-  0x58: "Joystick"
+  0x58: "Joystick",
+  0x4: "Latch Relay"
 }
 
 class _I2CHelper: