Add additional API documentation

Author: sebromero

src/modulino/buttons.py

@@ -10,7 +10,15 @@ class ModulinoButtons(Modulino):
   default_addresses = [0x7C]
   _default_long_press_duration = const(1000) # 1 second
 
-  def __init__(self, i2c_bus=None, address=None):
+  def __init__(self, i2c_bus = None, address = None):
+    """
+    Initializes the Modulino Buttons.
+
+    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, "BUTTONS")
     self.long_press_duration = self._default_long_press_duration
 

src/modulino/buzzer.py

@@ -117,6 +117,13 @@ class ModulinoBuzzer(Modulino):
   default_addresses = [0x3C]
 
   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, "BUZZER")
     self.data = bytearray(8)
     self.no_tone()

src/modulino/distance.py

@@ -10,6 +10,14 @@ class ModulinoDistance(Modulino):
     convert_default_addresses = False
 
     def __init__(self, i2c_bus = None, address: int | None = None) -> None:
+        """
+        Initializes the Modulino Distance.
+
+        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, "DISTANCE")
         self.sensor = VL53L4CD(self.i2c_bus, self.address) 
         self.sensor.timing_budget = 20     

src/modulino/knob.py

@@ -10,6 +10,14 @@ class ModulinoKnob(Modulino):
   default_addresses = [0x74, 0x76]
 
   def __init__(self, i2c_bus = None, address = None):
+    """
+    Initializes the Modulino Knob.
+
+    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, "ENCODER")
     self._pressed: bool = None
     self._encoder_value: int = None

src/modulino/modulino.py

@@ -130,6 +130,11 @@ def __init__(self, i2c_bus: I2C = None, address: int = None, name: str = None):
     If the address is provided, the device will check if it is connected to the bus.
     If the address is 8-bit, it will be converted to 7-bit.
     If no bus is provided, the default bus will be used if available.
+
+    Parameters:
+      i2c_bus (I2C): The I2C bus to use. If not provided, the default I2C bus will be used.
+      address (int): The address of the device. If not provided, the device will try to auto discover it.
+      name (str): The name of the device.
     """
 
     if i2c_bus is None:
@@ -159,7 +164,7 @@ def __init__(self, i2c_bus: I2C = None, address: int = None, name: str = None):
   def discover(self, default_addresses: list[int]) -> int | None:
     """
     Tries to find the given modulino device in the device chain
-    based on the pre-defined default addresses.
+    based on the pre-defined default addresses. The first address found will be returned.
     If the address has been changed to a custom one it won't be found with this function.
 
     Returns:

src/modulino/movement.py

@@ -12,6 +12,13 @@ class ModulinoMovement(Modulino):
     convert_default_addresses = False
 
     def __init__(self, i2c_bus = None, address: int | None = None) -> None:
+        """
+        Initializes the Modulino Movement.
+
+        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, "MOVEMENT")
         self.sensor = LSM6DSOX(self.i2c_bus, address=self.address)
 

src/modulino/pixels.py

@@ -58,6 +58,13 @@ class ModulinoPixels(Modulino):
   default_addresses = [0x6C]
 
   def __init__(self, i2c_bus = None, address=None):
+    """
+    Initializes the Modulino Pixels.
+
+    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, "LEDS")
     self.clear_all()
 

src/modulino/pressure.py

@@ -12,6 +12,13 @@ class ModulinoPressure(Modulino):
     convert_default_addresses = False
 
     def __init__(self, i2c_bus: I2C = None, address: int = None) -> None:
+        """
+        Initializes the Modulino Pressure.
+
+        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, "PRESSURE")
         self.sensor = LPS22H(self.i2c_bus, self.address)
 

src/modulino/thermo.py

@@ -18,6 +18,13 @@ class ModulinoThermo(Modulino):
     DEFAULT_ADDRESS = const(0x44)
 
     def __init__(self, i2c_bus: I2C = None, address: int = DEFAULT_ADDRESS) -> None:
+        """
+        Initializes the Modulino Thermo.
+
+        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, "THERMO")
         self.sensor: hs3003.HS3003 = hs3003.HS3003(self.i2c_bus)