Merge pull request #10 from sparkfun/encapsulation

Driver encapsulation

Author: sfe-SparkFro

red_vision/__init__.py

@@ -3,11 +3,13 @@
 # 
 # Copyright (c) 2025 SparkFun Electronics
 #-------------------------------------------------------------------------------
-# cv2_drivers/touch_screens/__init__.py
+# red_vision/__init__.py
 # 
-# Imports all available drivers for MicroPython OpenCV.
+# Imports all available Red Vision drivers, modules, and utilities.
 #-------------------------------------------------------------------------------
 
-from . import displays
 from . import cameras
+from . import displays
 from . import touch_screens
+from .utils import colors
+from .utils import memory

red_vision/cameras/__init__.py

@@ -3,15 +3,19 @@
 # 
 # Copyright (c) 2025 SparkFun Electronics
 #-------------------------------------------------------------------------------
-# cv2_drivers/cameras/__init__.py
+# red_vision/cameras/__init__.py
 # 
-# Imports all available camera drivers for MicroPython OpenCV.
+# Imports all available Red Vision camera drivers.
 #-------------------------------------------------------------------------------
 
-# Import sys module to check platform
-import sys
+# Import the generic VideoCapture class.
+from .video_capture import VideoCapture
+
+# Import platform agnostic drivers.
+from .hm01b0 import HM01B0
+from .ov5640 import OV5640
 
-# Import RP2 drivers
+# Import platform specific drivers.
+import sys
 if 'rp2' in sys.platform:
-    from . import hm01b0_pio
-    from . import ov5640_pio
+    from .dvp_rp2_pio import DVP_RP2_PIO

red_vision/cameras/cv2_camera.py

@@ -3,41 +3,52 @@
 # 
 # Copyright (c) 2025 SparkFun Electronics
 #-------------------------------------------------------------------------------
-# dvp_camera.py
+# red_vision/cameras/dvp_camera.py
 # 
-# Base class for OpenCV DVP (Digital Video Port) camera drivers.
+# Red Vision abstract base class for DVP (Digital Video Port) camera drivers.
 #-------------------------------------------------------------------------------
 
-from .cv2_camera import CV2_Camera
+from .video_capture_driver import VideoCaptureDriver
 
-class DVP_Camera(CV2_Camera):
+class DVP_Camera(VideoCaptureDriver):
     """
-    Base class for OpenCV DVP (Digital Video Port) camera drivers.
+    Red Vision abstract base class for DVP (Digital Video Port) camera drivers.
     """
     def __init__(
         self,
         i2c,
-        i2c_address
+        i2c_address,
+        height = None,
+        width = None,
+        color_mode = None,
+        buffer = None,
     ):
         """
         Initializes the DVP camera with I2C communication.
 
         Args:
             i2c (I2C): I2C object for communication
             i2c_address (int): I2C address of the camera
+            height (int, optional): Image height in pixels
+            width (int, optional): Image width in pixels
+            color_mode (int, optional): Color mode to use
+            buffer (ndarray, optional): Pre-allocated image buffer
         """
-        super().__init__()
-
+        # Store I2C parameters.
         self._i2c = i2c
         self._i2c_address = i2c_address
 
+        # Initialize the base VideoCaptureDriver class
+        super().__init__(height, width, color_mode, buffer)
+
     def _read_register(self, reg, nbytes=1):
         """
-        Reads a register from the camera over I2C.
+        Reads a register(s) from the camera over I2C.
 
         Args:
-            reg (int): Register address to read
-            nbytes (int): Number of bytes to read from the register
+            reg (int): Start register address to read
+            nbytes (int, optional): Number of bytes to read from the register
+                (default: 1)
 
         Returns:
             bytes: Data read from the register
@@ -47,11 +58,11 @@ def _read_register(self, reg, nbytes=1):
 
     def _write_register(self, reg, data):
         """
-        Writes data to a register on the camera over I2C.
+        Writes data to a register(s) on the camera over I2C.
 
         Args:
-            reg (int): Register address to write
-            data (bytes, int, list, tuple): Data to write to the register
+            reg (int): Start register address to write
+            data (bytes, int, list, tuple): Data to write to the register(s)
         """
         if isinstance(data, int):
             data = bytes([data])