Add header comments to files in cv2_drivers

sfe-SparkFro · sfe-SparkFro · commit 72887c733648 · 2025-07-23T19:27:51.000-06:00
diff --git a/cv2_drivers/__init__.py b/cv2_drivers/__init__.py
@@ -1,3 +1,13 @@
+#-------------------------------------------------------------------------------
+# SPDX-License-Identifier: MIT
+# 
+# Copyright (c) 2025 SparkFun Electronics
+#-------------------------------------------------------------------------------
+# cv2_drivers/touch_screens/__init__.py
+# 
+# Imports all available drivers for MicroPython OpenCV.
+#-------------------------------------------------------------------------------
+
 from . import displays
 from . import cameras
-from . import touch_screens
+from . import touch_screens
diff --git a/cv2_drivers/cameras/__init__.py b/cv2_drivers/cameras/__init__.py
@@ -1,3 +1,13 @@
+#-------------------------------------------------------------------------------
+# SPDX-License-Identifier: MIT
+# 
+# Copyright (c) 2025 SparkFun Electronics
+#-------------------------------------------------------------------------------
+# cv2_drivers/cameras/__init__.py
+# 
+# Imports all available camera drivers for MicroPython OpenCV.
+#-------------------------------------------------------------------------------
+
 # Import sys module to check platform
 import sys
 
diff --git a/cv2_drivers/cameras/cv2_camera.py b/cv2_drivers/cameras/cv2_camera.py
@@ -1,3 +1,13 @@
+#-------------------------------------------------------------------------------
+# SPDX-License-Identifier: MIT
+# 
+# Copyright (c) 2025 SparkFun Electronics
+#-------------------------------------------------------------------------------
+# cv2_camera.py
+# 
+# Base class for OpenCV camera drivers.
+#-------------------------------------------------------------------------------
+
 class CV2_Camera():
     """
     Base class for OpenCV camera drivers.
diff --git a/cv2_drivers/cameras/dvp_camera.py b/cv2_drivers/cameras/dvp_camera.py
@@ -1,3 +1,13 @@
+#-------------------------------------------------------------------------------
+# SPDX-License-Identifier: MIT
+# 
+# Copyright (c) 2025 SparkFun Electronics
+#-------------------------------------------------------------------------------
+# dvp_camera.py
+# 
+# Base class for OpenCV DVP (Digital Video Port) camera drivers.
+#-------------------------------------------------------------------------------
+
 from .cv2_camera import CV2_Camera
 
 class DVP_Camera(CV2_Camera):
diff --git a/cv2_drivers/cameras/dvp_rp2_pio.py b/cv2_drivers/cameras/dvp_rp2_pio.py
@@ -1,10 +1,23 @@
-import rp2
-from machine import Pin, PWM
-
+#-------------------------------------------------------------------------------
+# SPDX-License-Identifier: MIT
+# 
+# Copyright (c) 2025 SparkFun Electronics
+#-------------------------------------------------------------------------------
+# dvp_rp2_pio.py
+#
+# This class implements a DVP (Digital Video Port) interface using the RP2 PIO
+# (Programmable Input/Output) interface. This is only available on Raspberry Pi
+# RP2 processors.
+# 
 # This class is derived from:
 # https://github.com/adafruit/Adafruit_ImageCapture/blob/main/src/arch/rp2040.cpp
 # Released under the MIT license.
 # Copyright (c) 2021 Adafruit Industries
+#-------------------------------------------------------------------------------
+
+import rp2
+from machine import Pin, PWM
+
 class DVP_RP2_PIO():
     """
     This class implements a DVP (Digital Video Port) interface using the RP2 PIO
diff --git a/cv2_drivers/cameras/hm01b0.py b/cv2_drivers/cameras/hm01b0.py
@@ -1,11 +1,22 @@
-from .dvp_camera import DVP_Camera
-from time import sleep_us
-import cv2
-
+#-------------------------------------------------------------------------------
+# SPDX-License-Identifier: MIT
+# 
+# Copyright (c) 2025 SparkFun Electronics
+#-------------------------------------------------------------------------------
+# hm01b0.py
+#
+# Base class for OpenCV HM01B0 camera drivers.
+# 
 # This class is derived from:
 # https://github.com/openmv/openmv/blob/5acf5baf92b4314a549bdd068138e5df6cc0bac7/drivers/sensors/hm01b0.c
 # Released under the MIT license.
 # Copyright (C) 2013-2024 OpenMV, LLC.
+#-------------------------------------------------------------------------------
+
+from .dvp_camera import DVP_Camera
+from time import sleep_us
+import cv2
+
 class HM01B0(DVP_Camera):
     """
     Base class for OpenCV HM01B0 camera drivers.
diff --git a/cv2_drivers/cameras/hm01b0_pio.py b/cv2_drivers/cameras/hm01b0_pio.py
@@ -1,3 +1,14 @@
+#-------------------------------------------------------------------------------
+# SPDX-License-Identifier: MIT
+# 
+# Copyright (c) 2025 SparkFun Electronics
+#-------------------------------------------------------------------------------
+# hm01b0_pio.py
+# 
+# OpenCV HM01B0 camera driver using a PIO interface. Only available on
+# Raspberry Pi RP2 processors.
+#-------------------------------------------------------------------------------
+
 from .hm01b0 import HM01B0
 from .dvp_rp2_pio import DVP_RP2_PIO
 from ulab import numpy as np
diff --git a/cv2_drivers/cameras/ov5640.py b/cv2_drivers/cameras/ov5640.py
@@ -1,11 +1,22 @@
-from .dvp_camera import DVP_Camera
-from time import sleep_us
-import cv2
-
+#-------------------------------------------------------------------------------
+# SPDX-License-Identifier: MIT
+# 
+# Copyright (c) 2025 SparkFun Electronics
+#-------------------------------------------------------------------------------
+# ov5640.py
+#
+# Base class for OpenCV OV5640 camera drivers.
+# 
 # This class is derived from:
 # https://github.com/adafruit/Adafruit_CircuitPython_OV5640
 # Released under the MIT license.
 # Copyright (c) 2021 Jeff Epler for Adafruit Industries
+#-------------------------------------------------------------------------------
+
+from .dvp_camera import DVP_Camera
+from time import sleep_us
+import cv2
+
 class OV5640(DVP_Camera):
     """
     Base class for OpenCV OV5640 camera drivers.
diff --git a/cv2_drivers/cameras/ov5640_pio.py b/cv2_drivers/cameras/ov5640_pio.py
@@ -1,3 +1,14 @@
+#-------------------------------------------------------------------------------
+# SPDX-License-Identifier: MIT
+# 
+# Copyright (c) 2025 SparkFun Electronics
+#-------------------------------------------------------------------------------
+# ov5640_pio.py
+# 
+# OpenCV OV5640 camera driver using a PIO interface. Only available on
+# Raspberry Pi RP2 processors.
+#-------------------------------------------------------------------------------
+
 from .ov5640 import OV5640
 from .dvp_rp2_pio import DVP_RP2_PIO
 from ulab import numpy as np
diff --git a/cv2_drivers/displays/__init__.py b/cv2_drivers/displays/__init__.py
@@ -1,3 +1,13 @@
+#-------------------------------------------------------------------------------
+# SPDX-License-Identifier: MIT
+# 
+# Copyright (c) 2025 SparkFun Electronics
+#-------------------------------------------------------------------------------
+# cv2_drivers/displays/__init__.py
+# 
+# Imports all available display drivers for MicroPython OpenCV.
+#-------------------------------------------------------------------------------
+
 # Import platform agnostic drivers
 from . import st7789_spi
 
diff --git a/cv2_drivers/displays/cv2_display.py b/cv2_drivers/displays/cv2_display.py
@@ -1,3 +1,13 @@
+#-------------------------------------------------------------------------------
+# SPDX-License-Identifier: MIT
+# 
+# Copyright (c) 2025 SparkFun Electronics
+#-------------------------------------------------------------------------------
+# cv2_display.py
+# 
+# Base class for OpenCV display drivers.
+#-------------------------------------------------------------------------------
+
 import cv2
 from ulab import numpy as np
 from machine import Pin
diff --git a/cv2_drivers/displays/st7789.py b/cv2_drivers/displays/st7789.py
@@ -1,14 +1,25 @@
-from .cv2_display import CV2_Display
-from time import sleep_ms
-import struct
-
+#-------------------------------------------------------------------------------
+# SPDX-License-Identifier: MIT
+# 
+# Copyright (c) 2025 SparkFun Electronics
+#-------------------------------------------------------------------------------
+# st7789.py
+#
+# Base class for OpenCV ST7789 display drivers.
+# 
 # This class is derived from:
 # https://github.com/easytarget/st7789-framebuffer/blob/main/st7789_purefb.py
 # Released under the MIT license.
 # Copyright (c) 2024 Owen Carter
 # Copyright (c) 2024 Ethan Lacasse
 # Copyright (c) 2020-2023 Russ Hughes
 # Copyright (c) 2019 Ivan Belokobylskiy
+#-------------------------------------------------------------------------------
+
+from .cv2_display import CV2_Display
+from time import sleep_ms
+import struct
+
 class ST7789(CV2_Display):
     """
     Base class for OpenCV ST7789 display drivers.
diff --git a/cv2_drivers/displays/st7789_pio.py b/cv2_drivers/displays/st7789_pio.py
@@ -1,9 +1,26 @@
+#-------------------------------------------------------------------------------
+# SPDX-License-Identifier: MIT
+# 
+# Copyright (c) 2025 SparkFun Electronics
+#-------------------------------------------------------------------------------
+# st7789_pio.py
+#
+# OpenCV ST7789 display driver using a PIO interface. Only available on 
+# Raspberry Pi RP2 processors.
+# 
+# This class is derived from:
+# https://github.com/raspberrypi/pico-examples/tree/master/pio/st7789_lcd
+# Released under the MIT license.
+# Copyright (c) 2024 Owen Carter
+# Copyright (c) 2024 Ethan Lacasse
+# Copyright (c) 2020-2023 Russ Hughes
+# Copyright (c) 2019 Ivan Belokobylskiy
+#-------------------------------------------------------------------------------
+
 from .st7789 import ST7789
 from machine import Pin
 import rp2
 
-# Derived from:
-# https://github.com/raspberrypi/pico-examples/tree/master/pio/st7789_lcd
 class ST7789_PIO(ST7789):
     """
     OpenCV ST7789 display driver using a PIO interface. Only available on
diff --git a/cv2_drivers/displays/st7789_spi.py b/cv2_drivers/displays/st7789_spi.py
@@ -1,13 +1,24 @@
-from .st7789 import ST7789
-from machine import Pin
-
+#-------------------------------------------------------------------------------
+# SPDX-License-Identifier: MIT
+# 
+# Copyright (c) 2025 SparkFun Electronics
+#-------------------------------------------------------------------------------
+# st7789_spi.py
+#
+# OpenCV ST7789 display driver using a SPI interface.
+# 
 # This class is derived from:
 # https://github.com/easytarget/st7789-framebuffer/blob/main/st7789_purefb.py
 # Released under the MIT license.
 # Copyright (c) 2024 Owen Carter
 # Copyright (c) 2024 Ethan Lacasse
 # Copyright (c) 2020-2023 Russ Hughes
 # Copyright (c) 2019 Ivan Belokobylskiy
+#-------------------------------------------------------------------------------
+
+from .st7789 import ST7789
+from machine import Pin
+
 class ST7789_SPI(ST7789):
     """
     OpenCV ST7789 display driver using a SPI interface.
diff --git a/cv2_drivers/touch_screens/__init__.py b/cv2_drivers/touch_screens/__init__.py
@@ -1,2 +1,12 @@
+#-------------------------------------------------------------------------------
+# SPDX-License-Identifier: MIT
+# 
+# Copyright (c) 2025 SparkFun Electronics
+#-------------------------------------------------------------------------------
+# cv2_drivers/touch_screens/__init__.py
+# 
+# Imports all available touch screen drivers for MicroPython OpenCV.
+#-------------------------------------------------------------------------------
+
 # Import platform agnostic drivers
 from . import cst816
diff --git a/cv2_drivers/touch_screens/cst816.py b/cv2_drivers/touch_screens/cst816.py
@@ -1,7 +1,20 @@
+#-------------------------------------------------------------------------------
+# SPDX-License-Identifier: MIT
+# 
+# Copyright (c) 2025 SparkFun Electronics
+#-------------------------------------------------------------------------------
+# st7789.py
+#
+# Base class for OpenCV ST7789 display drivers.
+# 
+# This class is derived from:
+# https://github.com/fbiego/CST816S
+# Released under the MIT license.
+# Copyright (c) 2021 Felix Biego
+#-------------------------------------------------------------------------------
+
 from .cv2_touch_screen import CV2_Touch_Screen
 
-# Derived from:
-# https://github.com/fbiego/CST816S
 class CST816(CV2_Touch_Screen):
     _I2C_ADDRESS = 0x15
     _CHIP_ID = 0xB6
diff --git a/cv2_drivers/touch_screens/cv2_touch_screen.py b/cv2_drivers/touch_screens/cv2_touch_screen.py
@@ -1,3 +1,13 @@
+#-------------------------------------------------------------------------------
+# SPDX-License-Identifier: MIT
+# 
+# Copyright (c) 2025 SparkFun Electronics
+#-------------------------------------------------------------------------------
+# cv2_touch_screen.py
+#
+# Base class for OpenCV touch screen drivers.
+#-------------------------------------------------------------------------------
+
 class CV2_Touch_Screen():
     def __init__(self):
         pass
