Add missing docstring comments in drivers

Author: sfe-SparkFro

cv2_drivers/cameras/dvp_rp2_pio.py

@@ -117,6 +117,9 @@ def _active(self, active=None):
                 - True: Activate the DVP interface
                 - False: Deactivate the DVP interface
                 - None: Get the current active state
+        
+        Returns:
+            bool: Current active state if no argument is provided
         """
         # If no argument is provided, return the current active state
         if active == None:

cv2_drivers/cameras/hm01b0.py

@@ -303,14 +303,21 @@ def _set_mode(self, mode):
         """
         Sets the operating mode of the HM01B0 sensor.
         Args:
-            mode (int): The mode to set, e.g., MODE_STREAMING.
+            mode (int): The mode to set, e.g., _HIMAX_MODE_STREAMING.
         """
         self._write_register(self._MODE_SELECT, mode)
 
     def _trigger(self):
+        """
+        Triggers the HM01B0 sensor to capture a number of images. See
+        _set_n_frames().
+        """
         self._write_register(self._MODE_SELECT, self._HIMAX_MODE_STREAMING_NFRAMES)
 
     def _set_n_frames(self, n_frames):
+        """
+        Sets the number of frames to capture before stopping. See _trigger().
+        """
         self._write_register(self._PMU_AUTOSLEEP_FRAMECNT, n_frames)
 
     def _send_init(self, num_data_pins):

cv2_drivers/cameras/ov5640.py

@@ -958,6 +958,9 @@ def _write_list(self, data):
         """
         Initializes the OV5640 sensor with default settings.
         This includes setting up exposure, gain, and frame timing.
+
+        Args:
+            data (list): List of register-value pairs to write to the sensor.
         """
         for i in range(len(data) // 2):
             reg = data[i * 2]
@@ -1038,6 +1041,16 @@ def _set_pll(
     ) -> None:
         """
         Sets the PLL (Phase-Locked Loop) configuration for the OV5640 camera.
+
+        Args:
+            bypass (bool): Whether to bypass the PLL.
+            multiplier (int): PLL multiplier.
+            sys_div (int): System divider.
+            pre_div (int): Pre-divider.
+            root_2x (bool): Whether to use 2x root clock.
+            pclk_root_div (int): PCLK root divider.
+            pclk_manual (bool): Whether to use manual PCLK.
+            pclk_div (int): PCLK divider.
         """
         if (
             multiplier > 252
@@ -1125,6 +1138,11 @@ def _set_image_options(self) -> None:
     def _write_addr_reg(self, reg: int, x_value: int, y_value: int) -> None:
         """
         Writes 2 16-bit values to 4 8-bit registers.
+
+        Args:
+            reg (int): The base register address to write to.
+            x_value (int): The first 16-bit value to write.
+            y_value (int): The second 16-bit value to write.
         """
         self._write_register(reg, [
             (x_value >> 8) & 0xFF,
@@ -1136,6 +1154,12 @@ def _write_addr_reg(self, reg: int, x_value: int, y_value: int) -> None:
     def _write_reg_bits(self, reg: int, mask: int, enable: bool) -> None:
         """
         Writes a bitmask to a register, enabling or disabling specific bits.
+
+        Args:
+            reg (int): The register address to write to.
+            mask (int): The bitmask to apply.
+            enable (bool): If True, enables the bits in the mask; if False,
+                disables them.
         """
         val = self._read_register(reg)[0]
         if enable:

cv2_drivers/displays/st7789_pio.py

@@ -173,6 +173,9 @@ def _write(self, command=None, data=None):
     def _pio_write(self, data):
         """
         Writes data to the display using the PIO.
+
+        Args:
+            data (bytes, bytearray, or ndarray): Data to write to the display
         """
         # Configure the DMA transfer count and read address
         count = len(data) if isinstance(data, (bytes, bytearray)) else data.size

cv2_drivers/displays/st7789_spi.py

@@ -62,7 +62,13 @@ def __init__(
         super().__init__(width, height, rotation, bgr_order, reverse_bytes_in_word)
 
     def _write(self, command=None, data=None):
-        """SPI write to the device: commands and data."""
+        """
+        Writes commands and data to the display.
+
+        Args:
+            command (bytes, optional): Command to send to the display
+            data (bytes, optional): Data to send to the display
+        """
         # Save the current mode and alt of the DC pin in case it's used by
         # another device on the same SPI bus
         dcMode, dcAlt = self._save_pin_mode_alt(self._dc)

cv2_drivers/touch_screens/cst816.py

@@ -16,6 +16,9 @@
 from .cv2_touch_screen import CV2_Touch_Screen
 
 class CST816(CV2_Touch_Screen):
+    """
+    OpenCV CST816 touch screen driver using an I2C interface.
+    """
     _I2C_ADDRESS = 0x15
     _CHIP_ID = 0xB6
 
@@ -53,24 +56,42 @@ class CST816(CV2_Touch_Screen):
     _REG_IO_CTL = 0xFD
     _REG_DIS_AUTO_SLEEP = 0xFE
 
-    def __init__(self, i2c, address=_I2C_ADDRESS, width=240, height=320, rotation=1):
+    def __init__(self, i2c, width=240, height=320, rotation=1, address=_I2C_ADDRESS):
+        """
+        Initializes the CST816 driver.
+
+        Args:
+            i2c (I2C): I2C object for communication
+            width (int, optional): Touch screen width in pixels.
+                Default is 240
+            height (int, optional): Touch screen height in pixels.
+                Default is 320
+            rotation (int, optional): Orientation of touch screen
+              - 0: Portrait (default)
+              - 1: Landscape
+              - 2: Inverted portrait
+              - 3: Inverted landscape
+            address (int, optional): I2C address of the camera.
+                Default is 0x15
+        """
         self.i2c = i2c
         self.address = address
         self.width = width
         self.height = height
         self.rotation = rotation
 
-    def is_connected(self):
+    def _is_connected(self):
         """
-        Check if the CST816 touch screen is connected by reading the chip ID.
+        Checks if the touch screen is connected by reading the chip ID.
 
         Returns:
-            bool: True if connected, False otherwise
+            bool: True if the touch screen is connected and the chip ID is
+                  correct, otherwise False.
         """
         try:
             # Try to read the chip ID
             # If it throws an I/O error - the device isn't connected
-            chip_id = self.read_register_value(self._REG_CHIP_ID)
+            chip_id = self._get_chip_id()
 
             # Confirm the chip ID is correct
             if chip_id == self._CHIP_ID:
@@ -80,7 +101,13 @@ def is_connected(self):
         except:
             return False
 
-    def getChipID(self):
+    def _get_chip_id(self):
+        """
+        Reads the chip ID.
+
+        Returns:
+            int: The chip ID of the HM01B0 (should be 0xB6).
+        """
         return self.read_register_value(self._REG_CHIP_ID)
 
     def is_touched(self):
@@ -97,6 +124,13 @@ def is_touched(self):
         return touch_num > 0
 
     def get_touch_xy(self):
+        """
+        Get the X and Y coordinates of the touch point. Will return the last
+        touch point if no touch is currently detected.
+
+        Returns:
+            tuple: (x, y) coordinates of the touch point
+        """
         x = self.read_register_value(self._REG_X_POS_H, 2) & 0x0FFF
         y = self.read_register_value(self._REG_Y_POS_H, 2) & 0x0FFF
 
@@ -118,6 +152,8 @@ def read_register_value(self, reg, num_bytes=1):
 
         Args:
             reg (int): Register address to read from
+            num_bytes (int, optional): Number of bytes to read from the register.
+                Default is 1
 
         Returns:
             int: Value read from the register

cv2_drivers/touch_screens/cv2_touch_screen.py

@@ -9,7 +9,13 @@
 #-------------------------------------------------------------------------------
 
 class CV2_Touch_Screen():
+    """
+    Base class for OpenCV touch screen drivers.
+    """
     def __init__(self):
+        """
+        Initializes the touch screen.
+        """
         pass
 
     # TODO: Implement common methods for all touch screens