Add header comments to examples

Author: sfe-SparkFro

examples/ex01_hello_opencv.py

@@ -1,3 +1,16 @@
+#-------------------------------------------------------------------------------
+# SPDX-License-Identifier: MIT
+# 
+# Copyright (c) 2025 SparkFun Electronics
+#-------------------------------------------------------------------------------
+# ex01_hello_opencv.py
+# 
+# This example demonstrates near-minimal code to get started with OpenCV in
+# MicroPython. It can be used to verify that OpenCV is working correctly, and
+# that the display driver is functioning. It simpy imports the required modules,
+# creates a blank image, draws some things on it, and shows it on the display.
+#-------------------------------------------------------------------------------
+
 # Import OpenCV, just as you would in any other Python environment!
 import cv2 as cv
 

examples/ex02_camera.py

@@ -1,3 +1,15 @@
+#-------------------------------------------------------------------------------
+# SPDX-License-Identifier: MIT
+# 
+# Copyright (c) 2025 SparkFun Electronics
+#-------------------------------------------------------------------------------
+# ex02_camera.py
+# 
+# This example demonstrates how to read frames from a camera and show them on a
+# display using OpenCV in MicroPython. It can be used to verify that the camera
+# driver is functioning.
+#-------------------------------------------------------------------------------
+
 # Import OpenCV and hardware initialization module
 import cv2 as cv
 from cv2_hardware_init import *

examples/ex03_touch_screen.py

@@ -1,3 +1,15 @@
+#-------------------------------------------------------------------------------
+# SPDX-License-Identifier: MIT
+# 
+# Copyright (c) 2025 SparkFun Electronics
+#-------------------------------------------------------------------------------
+# ex03_touch_screen.py
+# 
+# This example demonstrates how to read input from a touch screen, which can be
+# used to verify that the touch screen driver is functioning. It simply draws
+# lines on a blank image based on touch input, similar to a drawing application.
+#-------------------------------------------------------------------------------
+
 # Import OpenCV and hardware initialization module
 import cv2 as cv
 from cv2_hardware_init import *

examples/ex04_imread_imwrite.py

@@ -1,3 +1,16 @@
+#-------------------------------------------------------------------------------
+# SPDX-License-Identifier: MIT
+# 
+# Copyright (c) 2025 SparkFun Electronics
+#-------------------------------------------------------------------------------
+# ex04_imread_imwrite.py
+# 
+# This example demonstrates how to read and write images to and from the
+# MicroPython filesystem using `cv.imread()` and `cv.imwrite()`. Any paths
+# accessible to the MicroPython filesystem can be used, including an SD card if
+# your board has one connected.
+#-------------------------------------------------------------------------------
+
 # Import OpenCV and hardware initialization module
 import cv2 as cv
 from cv2_hardware_init import *

examples/ex05_detect_sfe_logo.py

@@ -1,3 +1,34 @@
+#-------------------------------------------------------------------------------
+# SPDX-License-Identifier: MIT
+# 
+# Copyright (c) 2025 SparkFun Electronics
+#-------------------------------------------------------------------------------
+# ex05_detect_sfe_logo.py
+# 
+# This example demonstrates a basic vision processing pipeline. It reads frames
+# from the camera, finds contours in the image, and compares them to a reference
+# contour to detect the SparkFun flame logo. Below is some (bad) ASCII art of
+# the logo for reference. The example draws the actual contour that it's looking
+# for in the top left corner of the display.
+# 
+#     ___
+#    /  _\
+#    \  \
+#  /|_|  \/\
+# |         |
+# |         |
+# |        /
+# |  _____/
+# | /
+# |/
+# 
+# If the logo is detected, it will be highlighted in red on the display. Note
+# that this vision pipeline is very simple and does not include many of the
+# steps that would typically be included in more robust pipelines for the sake
+# of simplicity and performance. So it may produce false positives or miss the
+# logo entirely in some cases.
+#-------------------------------------------------------------------------------
+
 # Import OpenCV
 import cv2 as cv
 from cv2_hardware_init import *