From accbb99e51aaa3e0e51e7fb4ea64f519154ea748 Mon Sep 17 00:00:00 2001 From: Tekktrik Date: Thu, 11 May 2023 08:20:01 -0400 Subject: [PATCH 01/29] Linted per pre-commit --- examples/ov5640_directio_kaluga1_3_ili9341.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/examples/ov5640_directio_kaluga1_3_ili9341.py b/examples/ov5640_directio_kaluga1_3_ili9341.py index 4069a07..346fda4 100644 --- a/examples/ov5640_directio_kaluga1_3_ili9341.py +++ b/examples/ov5640_directio_kaluga1_3_ili9341.py @@ -176,6 +176,9 @@ def test_modes(cam_obj): def main(): + deadline = 0 + effects = iter((None,)) + display.auto_refresh = False display_bus.send(42, struct.pack(">hh", 0, bitmap.width - 1)) display_bus.send(43, struct.pack(">hh", 0, bitmap.height - 1)) From 66786ddbd70914083b298e1440155b1f0083be1b Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Tue, 23 May 2023 23:49:26 -0400 Subject: [PATCH 02/29] Update .pylintrc, fix jQuery for docs --- .pylintrc | 2 +- docs/conf.py | 1 + docs/requirements.txt | 1 + 3 files changed, 3 insertions(+), 1 deletion(-) diff --git a/.pylintrc b/.pylintrc index 40208c3..f945e92 100644 --- a/.pylintrc +++ b/.pylintrc @@ -396,4 +396,4 @@ min-public-methods=1 # Exceptions that will emit a warning when being caught. Defaults to # "Exception" -overgeneral-exceptions=Exception +overgeneral-exceptions=builtins.Exception diff --git a/docs/conf.py b/docs/conf.py index 6d2e5a6..45e47a3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -17,6 +17,7 @@ # ones. extensions = [ "sphinx.ext.autodoc", + "sphinxcontrib.jquery", "sphinx.ext.intersphinx", "sphinx.ext.napoleon", "sphinx.ext.todo", diff --git a/docs/requirements.txt b/docs/requirements.txt index 88e6733..797aa04 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -3,3 +3,4 @@ # SPDX-License-Identifier: Unlicense sphinx>=4.0.0 +sphinxcontrib-jquery From 0e1c2c65ec56d13d01beb45ed0b41c88a144fd16 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 24 Jul 2023 10:45:10 -0500 Subject: [PATCH 03/29] update for blit refactor to bitmaptools --- examples/ov5640_stopmotion_kaluga1_3.py | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/examples/ov5640_stopmotion_kaluga1_3.py b/examples/ov5640_stopmotion_kaluga1_3.py index 40d7d02..08b095d 100644 --- a/examples/ov5640_stopmotion_kaluga1_3.py +++ b/examples/ov5640_stopmotion_kaluga1_3.py @@ -235,7 +235,26 @@ def take_stop_motion_gif(n_frames=10, replay_frame_time=0.3): g.add_frame(frame, replay_frame_time) for i in range(1, n_frames): print(f"{i}/{n_frames}") - old_frame.blit(0, 0, frame, x1=0, y1=0, x2=frame.width, y2=frame.height) + + # CircuitPython Versions <= 8.2.0 + if hasattr(old_frame, "blit"): + old_frame.blit( + 0, 0, frame, x1=0, y1=0, x2=frame.width, y2=frame.height + ) + + # CircuitPython Versions >= 9.0.0 + elif hasattr(bitmaptools, "blit"): + bitmaptools.blit( + old_frame, + frame, + 0, + 0, + x1=0, + y1=0, + x2=frame.width, + y2=frame.height, + ) + frame = wait_record_pressed_update_display(False, cap) g.add_frame(frame, replay_frame_time) print("done") From 227338552896bcca696fb018238fddab77ede9d6 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 31 Jul 2023 15:58:43 -0500 Subject: [PATCH 04/29] change to else --- examples/ov5640_stopmotion_kaluga1_3.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/ov5640_stopmotion_kaluga1_3.py b/examples/ov5640_stopmotion_kaluga1_3.py index 08b095d..1d9c95a 100644 --- a/examples/ov5640_stopmotion_kaluga1_3.py +++ b/examples/ov5640_stopmotion_kaluga1_3.py @@ -243,7 +243,7 @@ def take_stop_motion_gif(n_frames=10, replay_frame_time=0.3): ) # CircuitPython Versions >= 9.0.0 - elif hasattr(bitmaptools, "blit"): + else: bitmaptools.blit( old_frame, frame, From 67db66fc90a5025133b289ed4bedcab9ccfe6517 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 19 Sep 2023 18:29:46 -0500 Subject: [PATCH 05/29] fix rtd theme --- docs/conf.py | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 45e47a3..6660b03 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -121,19 +121,10 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -on_rtd = os.environ.get("READTHEDOCS", None) == "True" - -if not on_rtd: # only import and set the theme if we're building docs locally - try: - import sphinx_rtd_theme - - html_theme = "sphinx_rtd_theme" - html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] - except: - html_theme = "default" - html_theme_path = ["."] -else: - html_theme_path = ["."] +import sphinx_rtd_theme + +html_theme = "sphinx_rtd_theme" +html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, From 97d0edd164c769fe106795dca48e5242af6df4ad Mon Sep 17 00:00:00 2001 From: Paul Cutler Date: Thu, 2 Nov 2023 14:10:01 -0500 Subject: [PATCH 06/29] Fixes #23 --- examples/ov5640_pico_st7789.py | 2 +- examples/ov5640_stopmotion_kaluga1_3.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/ov5640_pico_st7789.py b/examples/ov5640_pico_st7789.py index 3e08559..80c8d49 100644 --- a/examples/ov5640_pico_st7789.py +++ b/examples/ov5640_pico_st7789.py @@ -82,7 +82,7 @@ bitmap, pixel_shader=ColorConverter(input_colorspace=Colorspace.RGB565_SWAPPED) ) g.append(tg) -display.show(g) +display.root_group = g t0 = time.monotonic_ns() display.auto_refresh = False diff --git a/examples/ov5640_stopmotion_kaluga1_3.py b/examples/ov5640_stopmotion_kaluga1_3.py index 1d9c95a..3c4b428 100644 --- a/examples/ov5640_stopmotion_kaluga1_3.py +++ b/examples/ov5640_stopmotion_kaluga1_3.py @@ -153,7 +153,7 @@ def next_filename(extension="jpg"): # Blank the whole display, we'll draw what we want with directio empty_group = displayio.Group() -display.show(empty_group) +display.root_group = empty_group display.auto_refresh = False display.refresh() From f52a1b3e0d1e23371c46273aa1cf705b40e5404a Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 4 Dec 2023 14:06:17 -0600 Subject: [PATCH 07/29] unpin sphinx and add sphinx-rtd-theme to docs reqs --- docs/requirements.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 797aa04..979f568 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,5 +2,6 @@ # # SPDX-License-Identifier: Unlicense -sphinx>=4.0.0 +sphinx sphinxcontrib-jquery +sphinx-rtd-theme From 81858f14259d37da50a7f367287a99bac96664fb Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 26 Feb 2024 11:24:44 -0600 Subject: [PATCH 08/29] fix circup install instruction --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index cfcae3e..b9e5c4d 100644 --- a/README.rst +++ b/README.rst @@ -39,7 +39,7 @@ following command to install: .. code-block:: shell - circup install ov5640 + circup install adafruit_ov5640 Or the following command to update an existing version: From 79849cb8fb5386f0924d0f461bf87d993b191a6e Mon Sep 17 00:00:00 2001 From: jerryneedell Date: Thu, 2 May 2024 14:53:11 -0400 Subject: [PATCH 09/29] add autofocus --- adafruit_ov5640.py | 139 ++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 138 insertions(+), 1 deletion(-) diff --git a/adafruit_ov5640.py b/adafruit_ov5640.py index f4ca233..a9d12ed 100644 --- a/adafruit_ov5640.py +++ b/adafruit_ov5640.py @@ -25,7 +25,7 @@ """ # pylint: disable=too-many-lines - +# pylint: disable=too-many-public-methods # imports import time import imagecapture @@ -414,6 +414,28 @@ _REG_DLY = const(0xFFFF) _REGLIST_TAIL = const(0x0000) +_OV5640_STAT_FIRMWAREBAD = const(0x7F) +_OV5640_STAT_STARTUP = const(0x7E) +_OV5640_STAT_IDLE = const(0x70) +_OV5640_STAT_FOCUSING = const(0x00) +_OV5640_STAT_FOCUSED = const(0x10) + +_OV5640_CMD_TRIGGER_AUTOFOCUS = const(0x03) +_OV5640_CMD_AUTO_AUTOFOCUS = const(0x04) +_OV5640_CMD_RELEASE_FOCUS = const(0x08) +_OV5640_CMD_AF_SET_VCM_STEP = const(0x1A) +_OV5640_CMD_AF_GET_VCM_STEP = const(0x1B) + +_OV5640_CMD_MAIN = const(0x3022) +_OV5640_CMD_ACK = const(0x3023) +_OV5640_CMD_PARA0 = const(0x3024) +_OV5640_CMD_PARA1 = const(0x3025) +_OV5640_CMD_PARA2 = const(0x3026) +_OV5640_CMD_PARA3 = const(0x3027) +_OV5640_CMD_PARA4 = const(0x3028) +_OV5640_CMD_FW_STATUS = const(0x3029) + + _sensor_default_regs = [ _SYSTEM_CTROL0, 0x82, # software reset _REG_DLY, 10, # delay 10ms @@ -936,6 +958,27 @@ def __set__(self, obj: "OV5640", value: int) -> None: class _SCCB16CameraBase: # pylint: disable=too-few-public-methods + _finalize_firmware_load = ( + 0x3022, + 0x00, + 0x3023, + 0x00, + 0x3024, + 0x00, + 0x3025, + 0x00, + 0x3026, + 0x00, + 0x3027, + 0x00, + 0x3028, + 0x00, + 0x3029, + 0x7F, + 0x3000, + 0x00, + ) + def __init__(self, i2c_bus: I2C, i2c_address: int) -> None: self._i2c_device = I2CDevice(i2c_bus, i2c_address) self._bank = None @@ -1004,6 +1047,7 @@ def __init__( mclk_frequency: int = 20_000_000, i2c_address: int = 0x3C, size: int = OV5640_SIZE_QQVGA, + init_autofocus: bool = True, ): # pylint: disable=too-many-arguments """ Args: @@ -1028,6 +1072,7 @@ def __init__( with sufficiently low jitter. i2c_address (int): The I2C address of the camera. size (int): The captured image size + init_autofocus (bool): initialize autofocus """ # Initialize the master clock @@ -1078,8 +1123,100 @@ def __init__( self._white_balance = 0 self.size = size + if init_autofocus: + self.autofocus_init() + chip_id = _RegBits16(_CHIP_ID_HIGH, 0, 0xFFFF) + def autofocus_init_from_file(self, filename): + """Initialize the autofocus engine from a .bin file""" + with open(filename, mode="rb") as file: + firmware = file.read() + self.autofocus_init_from_bitstream(firmware) + + def autofocus_init_from_bitstream(self, firmware: bytes): + """Initialize the autofocus engine from a bytestring""" + self._write_register(0x3000, 0x20) # reset autofocus coprocessor + time.sleep(0.01) + + arr = bytearray(256) + with self._i2c_device as i2c: + for offset in range(0, len(firmware), 254): + num_firmware_bytes = min(254, len(firmware) - offset) + reg = offset + 0x8000 + arr[0] = reg >> 8 + arr[1] = reg & 0xFF + arr[2 : 2 + num_firmware_bytes] = firmware[ + offset : offset + num_firmware_bytes + ] + i2c.write(arr, end=2 + num_firmware_bytes) + + self._write_list(self._finalize_firmware_load) + for _ in range(100): + if self.autofocus_status == _OV5640_STAT_IDLE: + break + time.sleep(0.01) + else: + raise RuntimeError("Timed out after trying to load autofocus firmware") + + def autofocus_init(self): + """Initialize the autofocus engine from ov5640_autofocus.bin""" + if "/" in __file__: + binfile = ( + __file__.rsplit("/", 1)[0].rsplit(".", 1)[0] + "/ov5640_autofocus.bin" + ) + else: + binfile = "ov5640_autofocus.bin" + print(binfile) + return self.autofocus_init_from_file(binfile) + + @property + def autofocus_status(self): + """Read the camera autofocus status register""" + return self._read_register(_OV5640_CMD_FW_STATUS) + + def _send_autofocus_command(self, command, msg): # pylint: disable=unused-argument + self._write_register(_OV5640_CMD_ACK, 0x01) # clear command ack + self._write_register(_OV5640_CMD_MAIN, command) # send command + for _ in range(100): + if self._read_register(_OV5640_CMD_ACK) == 0x0: # command is finished + return True + time.sleep(0.01) + return False + + def autofocus(self) -> list[int]: + """Perform an autofocus operation. + + If all elements of the list are 0, the autofocus operation failed. Otherwise, + if at least one element is nonzero, the operation succeeded. + + In principle the elements correspond to 5 autofocus regions, if configured.""" + if not self._send_autofocus_command(_OV5640_CMD_RELEASE_FOCUS, "release focus"): + return [False] * 5 + if not self._send_autofocus_command(_OV5640_CMD_TRIGGER_AUTOFOCUS, "autofocus"): + return [False] * 5 + zone_focus = [self._read_register(_OV5640_CMD_PARA0 + i) for i in range(5)] + print(f"zones focused: {zone_focus}") + return zone_focus + + @property + def autofocus_vcm_step(self): + """Get the voice coil motor step location""" + if not self._send_autofocus_command( + _OV5640_CMD_AF_GET_VCM_STEP, "get vcm step" + ): + return None + return self._read_register(_OV5640_CMD_PARA4) + + @autofocus_vcm_step.setter + def autofocus_vcm_step(self, step): + """Get the voice coil motor step location, from 0 to 255""" + if not 0 <= step <= 255: + raise RuntimeError("VCM step must be 0 to 255") + self._write_register(_OV5640_CMD_PARA3, 0x00) + self._write_register(_OV5640_CMD_PARA4, step) + self._send_autofocus_command(_OV5640_CMD_AF_SET_VCM_STEP, "set vcm step") + def capture(self, buf: Union[bytearray, memoryview]) -> None: """Capture an image into the buffer. From 74559930eca431e25f0909b5b77682fa8c7fb402 Mon Sep 17 00:00:00 2001 From: jerryneedell Date: Fri, 3 May 2024 12:53:55 -0400 Subject: [PATCH 10/29] add longer delay to autofocus --- adafruit_ov5640.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_ov5640.py b/adafruit_ov5640.py index a9d12ed..3c6a665 100644 --- a/adafruit_ov5640.py +++ b/adafruit_ov5640.py @@ -1178,7 +1178,7 @@ def autofocus_status(self): def _send_autofocus_command(self, command, msg): # pylint: disable=unused-argument self._write_register(_OV5640_CMD_ACK, 0x01) # clear command ack self._write_register(_OV5640_CMD_MAIN, command) # send command - for _ in range(100): + for _ in range(1000): if self._read_register(_OV5640_CMD_ACK) == 0x0: # command is finished return True time.sleep(0.01) From 7ed61b0fef1929e7a2b90d76d0cb0e9e01f64c89 Mon Sep 17 00:00:00 2001 From: jerryneedell Date: Sun, 5 May 2024 14:29:34 -0400 Subject: [PATCH 11/29] make into a package --- LICENSES/GPL-2.0-only.txt | 117 ++++++++++++++++++ adafruit_ov5640/__init__.py | 0 .../adafruit_ov5640.py | 0 adafruit_ov5640/ov5640_autofocus.bin | Bin 0 -> 4077 bytes adafruit_ov5640/ov5640_autofocus.bin.license | 3 + pyproject.toml | 2 +- 6 files changed, 121 insertions(+), 1 deletion(-) create mode 100644 LICENSES/GPL-2.0-only.txt create mode 100644 adafruit_ov5640/__init__.py rename adafruit_ov5640.py => adafruit_ov5640/adafruit_ov5640.py (100%) create mode 100644 adafruit_ov5640/ov5640_autofocus.bin create mode 100644 adafruit_ov5640/ov5640_autofocus.bin.license diff --git a/LICENSES/GPL-2.0-only.txt b/LICENSES/GPL-2.0-only.txt new file mode 100644 index 0000000..17cb286 --- /dev/null +++ b/LICENSES/GPL-2.0-only.txt @@ -0,0 +1,117 @@ +GNU GENERAL PUBLIC LICENSE +Version 2, June 1991 + +Copyright (C) 1989, 1991 Free Software Foundation, Inc. +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA + +Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. + +Preamble + +The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser General Public License instead.) You can apply it to your programs, too. + +When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. + +To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. + +For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. + +We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. + +Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. + +Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. + +The precise terms and conditions for copying, distribution and modification follow. + +TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + +0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. + +1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. + +You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. + +2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. + + c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. + +3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. + +If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. + +4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. + +5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. + +6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. + +7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. + +This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. + +8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. + +9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. + +10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. + +NO WARRANTY + +11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + +12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +END OF TERMS AND CONDITIONS + +How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. + +To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. + + one line to give the program's name and an idea of what it does. Copyright (C) yyyy name of author + + This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. + +signature of Ty Coon, 1 April 1989 Ty Coon, President of Vice diff --git a/adafruit_ov5640/__init__.py b/adafruit_ov5640/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/adafruit_ov5640.py b/adafruit_ov5640/adafruit_ov5640.py similarity index 100% rename from adafruit_ov5640.py rename to adafruit_ov5640/adafruit_ov5640.py diff --git a/adafruit_ov5640/ov5640_autofocus.bin b/adafruit_ov5640/ov5640_autofocus.bin new file mode 100644 index 0000000000000000000000000000000000000000..06e4b5adbc39a1058b79faf9cdc0e57445228280 GIT binary patch literal 4077 zcmZu!d2kd}8t>^j(sN{H?0^P$18jpXC`X4mGJzb85MZIojTlk!*tmt3s7qxvL%pa= zh6!Vd5D>C!VhRsTtx~R9O2UlpVnL9aS%vi<$KCD@M~>F29uhJ$z2EB&pj$gN z@AY^5-uJ%uzVCbensj|b+Dc;vh9OAT`{JCs=atzBpE`a=YW}?wLYhju2E0G=&ZrPo z#SQW9YEz>*L^e*L&-(Icmx(hq8i8fer+s-+VVaWA$7%Gbgg!~5f$biFN~4dq8-nXe z^dVTPSJ6p$1m_q45|quo$_Cn|#!49Uk(BHpIPz9ToO9efPf+H>4Cq5CM@cHWx6eZL z<-JiNc$6}pT_6W%yAwV}+yLWup-}+X_q~T{?<8G z*vaK%x4^j%HGA4H(8f^=YpXRaIDJyn>T_eA3Q81Dg9p5GpHN6UFL7j|1WZwPQfYC{ z7DL^7DUJqd=Xac$c7Ds1(k>GABnNv!;w?fSOY@CrAdR0{G?>O}3mTNvkO>XI>Q40K z1?P}>lSpzs*duF=BzYG)A*q_x6i0#8YLG3^4Xa?-Fl`ttV7oKGY@rqkuu3)(XrM1I zNl9Bm9U;y%EgJ00ix*1{sA+8+eDugKMktj z$tA}-Tx0qkHxeN;$W1DGtuGH2Zm>xZMbjVzmcgqDX{*6hSYOvR2{oq?^eyQ|11_}R zPR7wrX@8+KYk#$kc7$OFPT%@%OD9pY6yIM>0Xcz3>F6YC($SoT4&Ow#NXh-&G`c12 z8sFlsI}&f$IgFY*)mg)k%e!zc#~Yf5QA;P4PGVJKC)RLg>o66v#2Xri(M}zlL$7EK z13HQJ+}x!-!>Aedwhga#3t6|7ckYdm`@4&31T70cd5r@MmRGOl&SHh>X;`t;>nC1 z9y!37;gNHFEngDOW|`3mMIPHVH}T8dFB_+T-w0=?grRG~ znaQJJ<|E?d$Hc>*5Q|6l$h*EeJCqUS)03!BHwM1LDzA8^+~-cHkQ*;hFZ_T- z<8cp;g6<-SglMMT5Y5(;(OkVTsxs0PB~4P&HA*@?!HlG-(KI!drpD7u?;T+!EXuwn zrHMJ$bS^w0MC)i6T9@C`6P*A;3BTGTya0xtt{v~`=?Q(u2TW)qZO`%nB9-e&Wk=OG zZ9l>X+_b%&4_Hu*rXzo*qe0h`I$oTIHa2Xe9R++~M(X$+F6SOIbHfz<@Uj^c0 zMqRW?7p=qo9T!(kO(P%G#cOsDSn=U?^h26BjvkRZC|pFZ%@%s_PIxo= zbLc4;h91@#jCckRwEZl|EzMfpQqx=)cKjUH>vG!-z6(7e@wEmSJt_6bXe;g>fbLHQ z^aO3cG~Ynm`_Pk^A~CfUQ$|ev0aGTR@;@{GGvpuA?y1)ZAEQ1D{m{> zYb$EE6-8}D9k!waw%fXGw~r8nEkL{K8E6S31OJ$j(XS??ttbWuQ_M)`=LcukC43+t zZKepfK2nBnIlxBNbCC^YKnMz>%!_cvkxDjFu{2V?gm$e7%?UC@aGs%FRTe9Yl)II? zKp0ufMHW>??yiX3RW2xHp*q@iYv|cXc~zuhjkq>mpo&#+=#p(!;yTQ%(HLEm6{{9! z1y4p?O}lu`EUxZWbW~PcqbpYFidEgp8rpI`G$X>Ti&U-!%V0lbAuZ?W{2j2JV!7NS zRzRzS#z8BSd3K&4GlQwYror&wIlj`7QkIF!*#FeC{-^lbSt-Q^n{MZ8i&DxApl0&5 zze*_%pz`_Jg(<}el#8z|PAP7nZsBW7Qwj}K0c)_Z9%C|Oh__o=@&;{VJr34rol9Eg z8g#9lXAP;5I3L^UU5ZLiLydm zUgcMoi=|aQrBn=5d6j^k3M+~u%h^cj(nw$l=~|QONd;xHSA9>03tD#?DmKliqU^10 z3oA_{GJ`hmAhf$KX*vlthimdtDUJ)e0Cd`|8N|%+=My#Zsi&`6hd-}zt-H!dnbDwZ z>Sbul%Wdmg*S4%_u41&~Z!A4ZrI`XXE_K6O{78-gV^_hL^(u3$^xc5A)&+P!T1uM( z@07glf6I5&%S2U}1npl0`lp7rA_naq zzcXDZ_|r^qw=sCs5d6p#^r}IhGw7cgEXk*x2Wi3zRX`J#1d;G2`mbw$6D%=;mZhvQ zFHN0}Q3)?=x5oT5`CQDN@UvD-6V8|wXr~bpp7kYpcA+?1KJGSa2_5r=P72Bf-uWUd zt?hqe$vdCD${$?%Z;%Qv}g zz(K4C(Vr7Q zo=00YAvf(hD5yEnmlZO|2@=|M82GH{)dp@t6abj(k<$WS+{(5rZC=7eCnreDRsw#s z;Wnyx=KVFR=i*<1!EM;Y-OeuDL9nK|-?3(HpxQ`etAB0C)e^T5m1dTxv@k@a;Vz<* zBnZDHkEpb}WNe5va09G?7+@FH5z7fe#m#T@lPgz0G`G-gGnojZx`iM@7)ubO$zmal z_Yp5vmo1p>c2_T6aI4!*5^jgv% z7V8)1RYB4}R_ml)r&G!z+I1?WEDkw<6ImHJu~>d%S$jY8KUY}HUcb;XQ_0ao^`VL9 z4nVxNiri9#6Duo}O0l9`sSwM{l=A6=m#@rEDIU=y-#EyArypcWxV4EvjY9fDHn?+$ PbR1{{0aX4dX?gR%8vtA( literal 0 HcmV?d00001 diff --git a/adafruit_ov5640/ov5640_autofocus.bin.license b/adafruit_ov5640/ov5640_autofocus.bin.license new file mode 100644 index 0000000..bbb9ced --- /dev/null +++ b/adafruit_ov5640/ov5640_autofocus.bin.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2023 Unknown + +SPDX-License-Identifier: GPL-2.0-only diff --git a/pyproject.toml b/pyproject.toml index 076c802..42ea705 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -38,7 +38,7 @@ classifiers = [ dynamic = ["dependencies", "optional-dependencies"] [tool.setuptools] -py-modules = ["adafruit_ov5640"] +packages = ["adafruit_ov5640"] [tool.setuptools.dynamic] dependencies = {file = ["requirements.txt"]} From 583187421fb79f56428172e05634906cdde0db9c Mon Sep 17 00:00:00 2001 From: jerryneedell Date: Sun, 5 May 2024 14:32:26 -0400 Subject: [PATCH 12/29] add Licence file --- .../adafruit_ov5640.py => adafruit_ov5640.py | 0 adafruit_ov5640/__init__.py | 0 .../ov5640_autofocus.bin => ov5640_autofocus.bin | Bin ...ocus.bin.license => ov5640_autofocus.bin.license | 0 pyproject.toml | 2 +- 5 files changed, 1 insertion(+), 1 deletion(-) rename adafruit_ov5640/adafruit_ov5640.py => adafruit_ov5640.py (100%) delete mode 100644 adafruit_ov5640/__init__.py rename adafruit_ov5640/ov5640_autofocus.bin => ov5640_autofocus.bin (100%) rename adafruit_ov5640/ov5640_autofocus.bin.license => ov5640_autofocus.bin.license (100%) diff --git a/adafruit_ov5640/adafruit_ov5640.py b/adafruit_ov5640.py similarity index 100% rename from adafruit_ov5640/adafruit_ov5640.py rename to adafruit_ov5640.py diff --git a/adafruit_ov5640/__init__.py b/adafruit_ov5640/__init__.py deleted file mode 100644 index e69de29..0000000 diff --git a/adafruit_ov5640/ov5640_autofocus.bin b/ov5640_autofocus.bin similarity index 100% rename from adafruit_ov5640/ov5640_autofocus.bin rename to ov5640_autofocus.bin diff --git a/adafruit_ov5640/ov5640_autofocus.bin.license b/ov5640_autofocus.bin.license similarity index 100% rename from adafruit_ov5640/ov5640_autofocus.bin.license rename to ov5640_autofocus.bin.license diff --git a/pyproject.toml b/pyproject.toml index 42ea705..076c802 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -38,7 +38,7 @@ classifiers = [ dynamic = ["dependencies", "optional-dependencies"] [tool.setuptools] -packages = ["adafruit_ov5640"] +py-modules = ["adafruit_ov5640"] [tool.setuptools.dynamic] dependencies = {file = ["requirements.txt"]} From 8337b975955a72de6d4787f56d1ff00e2acb9797 Mon Sep 17 00:00:00 2001 From: jerryneedell Date: Sat, 25 May 2024 12:46:12 -0400 Subject: [PATCH 13/29] convert to package --- adafruit_ov5640.py => adafruit_ov5640/__init__.py | 0 .../ov5640_autofocus.bin | Bin .../ov5640_autofocus.bin.license | 0 pyproject.toml | 2 +- 4 files changed, 1 insertion(+), 1 deletion(-) rename adafruit_ov5640.py => adafruit_ov5640/__init__.py (100%) rename ov5640_autofocus.bin => adafruit_ov5640/ov5640_autofocus.bin (100%) rename ov5640_autofocus.bin.license => adafruit_ov5640/ov5640_autofocus.bin.license (100%) diff --git a/adafruit_ov5640.py b/adafruit_ov5640/__init__.py similarity index 100% rename from adafruit_ov5640.py rename to adafruit_ov5640/__init__.py diff --git a/ov5640_autofocus.bin b/adafruit_ov5640/ov5640_autofocus.bin similarity index 100% rename from ov5640_autofocus.bin rename to adafruit_ov5640/ov5640_autofocus.bin diff --git a/ov5640_autofocus.bin.license b/adafruit_ov5640/ov5640_autofocus.bin.license similarity index 100% rename from ov5640_autofocus.bin.license rename to adafruit_ov5640/ov5640_autofocus.bin.license diff --git a/pyproject.toml b/pyproject.toml index 076c802..42ea705 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -38,7 +38,7 @@ classifiers = [ dynamic = ["dependencies", "optional-dependencies"] [tool.setuptools] -py-modules = ["adafruit_ov5640"] +packages = ["adafruit_ov5640"] [tool.setuptools.dynamic] dependencies = {file = ["requirements.txt"]} From a311de150ff7a9497537a243a1cfbb687a5b22fc Mon Sep 17 00:00:00 2001 From: jerryneedell Date: Sun, 26 May 2024 09:43:22 -0400 Subject: [PATCH 14/29] add autofoxus example --- examples/ov5640_jpeg_capture_af.py | 105 +++++++++++++++++++++++++++++ 1 file changed, 105 insertions(+) create mode 100644 examples/ov5640_jpeg_capture_af.py diff --git a/examples/ov5640_jpeg_capture_af.py b/examples/ov5640_jpeg_capture_af.py new file mode 100644 index 0000000..3cabda0 --- /dev/null +++ b/examples/ov5640_jpeg_capture_af.py @@ -0,0 +1,105 @@ +# SPDX-FileCopyrightText: Copyright (c) 2023 Limor Fried for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense +""" +This demo is designed for the Raspberry Pi Pico and Camera PiCowbell +When the shutter is pressed the camera is autofocussed before capturing +an image andsaving it to the microSD card. +""" + +import os +import time +import busio +import board +import digitalio +import keypad +import sdcardio +import storage +import adafruit_ov5640 + +print("Initializing SD card") +sd_spi = busio.SPI(clock=board.GP18, MOSI=board.GP19, MISO=board.GP16) +sd_cs = board.GP17 +sdcard = sdcardio.SDCard(sd_spi, sd_cs) +vfs = storage.VfsFat(sdcard) +storage.mount(vfs, "/sd") + +print("construct bus") +i2c = busio.I2C(board.GP5, board.GP4) +print("construct camera") +reset = digitalio.DigitalInOut(board.GP14) +cam = adafruit_ov5640.OV5640( + i2c, + data_pins=( + board.GP6, + board.GP7, + board.GP8, + board.GP9, + board.GP10, + board.GP11, + board.GP12, + board.GP13, + ), + clock=board.GP3, + vsync=board.GP0, + href=board.GP2, + mclk=None, + shutdown=None, + reset=reset, + size=adafruit_ov5640.OV5640_SIZE_VGA, +) +print("print chip id") +print(cam.chip_id) + +keys = keypad.Keys((board.GP22,), value_when_pressed=False, pull=True) + + +def exists(filename): + try: + os.stat(filename) + return True + except OSError as _: + return False + + +_image_counter = 0 + + +def open_next_image(): + global _image_counter # pylint: disable=global-statement + while True: + filename = f"/sd/img{_image_counter:04d}.jpg" + _image_counter += 1 + if exists(filename): + continue + print("# writing to", filename) + return open(filename, "wb") + + +cam.colorspace = adafruit_ov5640.OV5640_COLOR_JPEG +cam.quality = 3 +b = bytearray(cam.capture_buffer_size) + +cam.autofocus() +print("AF Status: ", cam.autofocus_status, cam.autofocus_vcm_step) + +jpeg = cam.capture(b) + +while True: + shutter = keys.events.get() + # event will be None if nothing has happened. + if shutter: + if shutter.pressed: + cam.autofocus() + print("AF Status: ", cam.autofocus_status, cam.autofocus_vcm_step) + time.sleep(0.01) + jpeg = cam.capture(b) + print(f"Captured {len(jpeg)} bytes of jpeg data") + print(f" (had allocated {cam.capture_buffer_size} bytes") + print(f"Resolution {cam.width}x{cam.height}") + try: + with open_next_image() as f: + f.write(jpeg) + print("# Wrote image") + except OSError as e: + print(e) From c02956c208bfcb4d32ba4df73aae3c554967e368 Mon Sep 17 00:00:00 2001 From: jerryneedell Date: Sun, 26 May 2024 11:45:22 -0400 Subject: [PATCH 15/29] add another example for manual focus --- examples/ov5640_jpeg_capture_manual_focus.py | 115 +++++++++++++++++++ 1 file changed, 115 insertions(+) create mode 100644 examples/ov5640_jpeg_capture_manual_focus.py diff --git a/examples/ov5640_jpeg_capture_manual_focus.py b/examples/ov5640_jpeg_capture_manual_focus.py new file mode 100644 index 0000000..165b055 --- /dev/null +++ b/examples/ov5640_jpeg_capture_manual_focus.py @@ -0,0 +1,115 @@ +# SPDX-FileCopyrightText: Copyright (c) 2023 Limor Fried for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense +""" +This demo is designed for the Raspberry Pi Pico and Camera PiCowbell +When the shutter is pressed, a prompt is given to enter a step +for the focus. Enter a value 0-255 to set the focus or +enter a value >255 to execute an autofocus. +After the value is input, an image is captured and saved +to the microSD card. +""" + +import os +import time +import busio +import board +import digitalio +import keypad +import sdcardio +import storage +import adafruit_ov5640 + +print("Initializing SD card") +sd_spi = busio.SPI(clock=board.GP18, MOSI=board.GP19, MISO=board.GP16) +sd_cs = board.GP17 +sdcard = sdcardio.SDCard(sd_spi, sd_cs) +vfs = storage.VfsFat(sdcard) +storage.mount(vfs, "/sd") + +print("construct bus") +i2c = busio.I2C(board.GP5, board.GP4) +print("construct camera") +reset = digitalio.DigitalInOut(board.GP14) +cam = adafruit_ov5640.OV5640( + i2c, + data_pins=( + board.GP6, + board.GP7, + board.GP8, + board.GP9, + board.GP10, + board.GP11, + board.GP12, + board.GP13, + ), + clock=board.GP3, + vsync=board.GP0, + href=board.GP2, + mclk=None, + shutdown=None, + reset=reset, + size=adafruit_ov5640.OV5640_SIZE_VGA, +) +print("print chip id") +print(cam.chip_id) + +keys = keypad.Keys((board.GP22,), value_when_pressed=False, pull=True) + + +def exists(filename): + try: + os.stat(filename) + return True + except OSError as _: + return False + + +_image_counter = 0 + + +def open_next_image(): + global _image_counter # pylint: disable=global-statement + while True: + filename = f"/sd/img{_image_counter:04d}.jpg" + _image_counter += 1 + if exists(filename): + continue + print("# writing to", filename) + return open(filename, "wb") + + +cam.colorspace = adafruit_ov5640.OV5640_COLOR_JPEG +cam.quality = 3 +b = bytearray(cam.capture_buffer_size) + +cam.autofocus() +print("AF Status: ", cam.autofocus_status, cam.autofocus_vcm_step) + +jpeg = cam.capture(b) + +while True: + shutter = keys.events.get() + # event will be None if nothing has happened. + if shutter: + if shutter.pressed: + """Captures an image and send it to Adafruit IO.""" + step = int(input("enter AF step:")) + if step > 255: + # Force autofocus and capture a JPEG image + cam.autofocus() + print("AF Status: ", cam.autofocus_status, cam.autofocus_vcm_step) + else: + cam.autofocus_vcm_step = step + print("AF Status: ", cam.autofocus_status, cam.autofocus_vcm_step) + time.sleep(0.01) + jpeg = cam.capture(b) + print(f"Captured {len(jpeg)} bytes of jpeg data") + print(f" (had allocated {cam.capture_buffer_size} bytes") + print(f"Resolution {cam.width}x{cam.height}") + try: + with open_next_image() as f: + f.write(jpeg) + print("# Wrote image") + except OSError as e: + print(e) From 07d39a0116638c11852b663af90ff3104780ffc9 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 7 Oct 2024 09:24:05 -0500 Subject: [PATCH 16/29] remove deprecated get_html_theme_path() call Signed-off-by: foamyguy --- docs/conf.py | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 6660b03..c975c6a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -124,7 +124,6 @@ import sphinx_rtd_theme html_theme = "sphinx_rtd_theme" -html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, From 8fabc6d5fd6ce90a0a7998888f4be2cac17fc72e Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sat, 21 Dec 2024 11:49:36 -0600 Subject: [PATCH 17/29] fix ev and white balance getters --- adafruit_ov5640/__init__.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/adafruit_ov5640/__init__.py b/adafruit_ov5640/__init__.py index 3c6a665..6589107 100644 --- a/adafruit_ov5640/__init__.py +++ b/adafruit_ov5640/__init__.py @@ -1543,15 +1543,16 @@ def contrast(self, value: int) -> None: @property def exposure_value(self) -> int: - """Sensor exposure (EV) adjustment, from -4 to 4 inclusive""" + """Sensor exposure (EV) adjustment, from -3 to 3 inclusive""" return self._ev @exposure_value.setter def exposure_value(self, value: int) -> None: if not -3 <= value <= 3: raise ValueError( - "Invalid exposure value (EV) {value}, use a value from -4..4 inclusive" + "Invalid exposure value (EV) {value}, use a value from -3..3 inclusive" ) + self._ev = value for offset, reg_value in enumerate(_sensor_ev_levels[value]): self._write_register(0x5381 + offset, reg_value) @@ -1567,6 +1568,7 @@ def white_balance(self, value: int) -> None: "Invalid exposure value (EV) {value}, " "use one of the OV5640_WHITE_BALANCE_* constants" ) + self._white_balance = value self._write_register(0x3212, 0x3) # start group 3 for reg_addr, reg_value in zip(_light_registers, _light_modes[value]): self._write_register(reg_addr, reg_value) From d2b84ed5f804907b8acc5e9b43c1c35f4245e0ca Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 14 Jan 2025 11:32:34 -0600 Subject: [PATCH 18/29] add sphinx configuration to rtd.yaml Signed-off-by: foamyguy --- .readthedocs.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 33c2a61..88bca9f 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,6 +8,9 @@ # Required version: 2 +sphinx: + configuration: docs/conf.py + build: os: ubuntu-20.04 tools: From 36d77ee7f082cc90a1de7f802fb37ce0495f9a62 Mon Sep 17 00:00:00 2001 From: jerryneedell Date: Mon, 3 Feb 2025 20:00:52 -0500 Subject: [PATCH 19/29] revise calculation of JPEG buffer --- adafruit_ov5640/__init__.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/adafruit_ov5640/__init__.py b/adafruit_ov5640/__init__.py index 6589107..7d60bba 100644 --- a/adafruit_ov5640/__init__.py +++ b/adafruit_ov5640/__init__.py @@ -1236,7 +1236,9 @@ def capture(self, buf: Union[bytearray, memoryview]) -> None: def capture_buffer_size(self) -> int: """Return the size of capture buffer to use with current resolution & colorspace settings""" if self.colorspace == OV5640_COLOR_JPEG: - return self.width * self.height // self.quality + # This is somewhat arbirary but seems to work for a wide range of JPEG images + # the user can chose to further scale the buffer in the user code if necessary + return 2 * (self.width * self.height // self.quality) if self.colorspace == OV5640_COLOR_GRAYSCALE: return self.width * self.height return self.width * self.height * 2 From d0767a12ef2f9ed56922bf8cfe1715eb0202ceee Mon Sep 17 00:00:00 2001 From: Casten Riepling Date: Thu, 10 Apr 2025 22:45:02 -0700 Subject: [PATCH 20/29] fix comment and style for quality range checking Fix comment and style for quality range checking Comments on lines: 1490, 1497 use range verbiage such as: """Controls the JPEG quality. Valid range is from 2..55 inclusive""" However, 55 is not included. Also, the check on 1495 uses the following checking style using '<': if not 2 <= value < 55: --- adafruit_ov5640/__init__.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/adafruit_ov5640/__init__.py b/adafruit_ov5640/__init__.py index 6589107..ab0a094 100644 --- a/adafruit_ov5640/__init__.py +++ b/adafruit_ov5640/__init__.py @@ -1487,14 +1487,14 @@ def effect(self, value: int) -> None: @property def quality(self) -> int: - """Controls the JPEG quality. Valid range is from 2..55 inclusive""" + """Controls the JPEG quality. Valid range is from 2..54 inclusive""" return self._read_register(_COMPRESSION_CTRL07) & 0x3F @quality.setter def quality(self, value: int) -> None: - if not 2 <= value < 55: + if not 2 <= value <= 54: raise ValueError( - f"Invalid quality value {value}, use a value from 2..55 inclusive" + f"Invalid quality value {value}, use a value from 2..54 inclusive" ) self._write_register(_COMPRESSION_CTRL07, value & 0x3F) From de1a06bc4ac400212cc6eb00e66cfea4b7841fab Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 13 May 2025 15:10:43 +0000 Subject: [PATCH 21/29] change to ruff --- .gitattributes | 11 + .pre-commit-config.yaml | 43 +- .pylintrc | 399 ------------------ adafruit_ov5640/__init__.py | 48 +-- docs/api.rst | 3 + docs/conf.py | 8 +- examples/ov5640_directio_kaluga1_3_ili9341.py | 27 +- examples/ov5640_jpeg_capture_af.py | 29 +- examples/ov5640_jpeg_capture_manual_focus.py | 29 +- examples/ov5640_jpeg_kaluga1_3.py | 2 +- examples/ov5640_pico_simpletest.py | 5 +- examples/ov5640_pico_st7789.py | 20 +- examples/ov5640_sdcard_kaluga_1_3.py | 31 +- examples/ov5640_simpletest.py | 2 +- examples/ov5640_stopmotion_kaluga1_3.py | 55 +-- ruff.toml | 105 +++++ 16 files changed, 261 insertions(+), 556 deletions(-) create mode 100644 .gitattributes delete mode 100644 .pylintrc create mode 100644 ruff.toml diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..21c125c --- /dev/null +++ b/.gitattributes @@ -0,0 +1,11 @@ +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +.py text eol=lf +.rst text eol=lf +.txt text eol=lf +.yaml text eol=lf +.toml text eol=lf +.license text eol=lf +.md text eol=lf diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 70ade69..ff19dde 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,42 +1,21 @@ -# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries # # SPDX-License-Identifier: Unlicense repos: - - repo: https://github.com/python/black - rev: 23.3.0 - hooks: - - id: black - - repo: https://github.com/fsfe/reuse-tool - rev: v1.1.2 - hooks: - - id: reuse - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.4.0 + rev: v4.5.0 hooks: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace - - repo: https://github.com/pycqa/pylint - rev: v2.17.4 + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.3.4 hooks: - - id: pylint - name: pylint (library code) - types: [python] - args: - - --disable=consider-using-f-string - exclude: "^(docs/|examples/|tests/|setup.py$)" - - id: pylint - name: pylint (example code) - description: Run pylint rules on "examples/*.py" files - types: [python] - files: "^examples/" - args: - - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code - - id: pylint - name: pylint (test code) - description: Run pylint rules on "tests/*.py" files - types: [python] - files: "^tests/" - args: - - --disable=missing-docstring,consider-using-f-string,duplicate-code + - id: ruff-format + - id: ruff + args: ["--fix"] + - repo: https://github.com/fsfe/reuse-tool + rev: v3.0.1 + hooks: + - id: reuse diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index f945e92..0000000 --- a/.pylintrc +++ /dev/null @@ -1,399 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -[MASTER] - -# A comma-separated list of package or module names from where C extensions may -# be loaded. Extensions are loading into the active Python interpreter and may -# run arbitrary code -extension-pkg-whitelist= - -# Add files or directories to the ignore-list. They should be base names, not -# paths. -ignore=CVS - -# Add files or directories matching the regex patterns to the ignore-list. The -# regex matches against base names, not paths. -ignore-patterns= - -# Python code to execute, usually for sys.path manipulation such as -# pygtk.require(). -#init-hook= - -# Use multiple processes to speed up Pylint. -jobs=1 - -# List of plugins (as comma separated values of python modules names) to load, -# usually to register additional checkers. -load-plugins=pylint.extensions.no_self_use - -# Pickle collected data for later comparisons. -persistent=yes - -# Specify a configuration file. -#rcfile= - -# Allow loading of arbitrary C extensions. Extensions are imported into the -# active Python interpreter and may run arbitrary code. -unsafe-load-any-extension=no - - -[MESSAGES CONTROL] - -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED -confidence= - -# Disable the message, report, category or checker with the given id(s). You -# can either give multiple identifiers separated by comma (,) or put this -# option multiple times (only on the command line, not in the configuration -# file where it should appear only once).You can also use "--disable=all" to -# disable everything first and then reenable specific checks. For example, if -# you want to run only the similarities checker, you can use "--disable=all -# --enable=similarities". If you want to run only the classes checker, but have -# no Warning level messages displayed, use"--disable=all --enable=classes -# --disable=W" -# disable=import-error,raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,deprecated-str-translate-call -disable=raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,import-error,pointless-string-statement,unspecified-encoding - -# Enable the message, report, category or checker with the given id(s). You can -# either give multiple identifier separated by comma (,) or put this option -# multiple time (only on the command line, not in the configuration file where -# it should appear only once). See also the "--disable" option for examples. -enable= - - -[REPORTS] - -# Python expression which should return a note less than 10 (10 is the highest -# note). You have access to the variables errors warning, statement which -# respectively contain the number of errors / warnings messages and the total -# number of statements analyzed. This is used by the global evaluation report -# (RP0004). -evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) - -# Template used to display messages. This is a python new-style format string -# used to format the message information. See doc for all details -#msg-template= - -# Set the output format. Available formats are text, parseable, colorized, json -# and msvs (visual studio).You can also give a reporter class, eg -# mypackage.mymodule.MyReporterClass. -output-format=text - -# Tells whether to display a full report or only the messages -reports=no - -# Activate the evaluation score. -score=yes - - -[REFACTORING] - -# Maximum number of nested blocks for function / method body -max-nested-blocks=5 - - -[LOGGING] - -# Logging modules to check that the string format arguments are in logging -# function parameter format -logging-modules=logging - - -[SPELLING] - -# Spelling dictionary name. Available dictionaries: none. To make it working -# install python-enchant package. -spelling-dict= - -# List of comma separated words that should not be checked. -spelling-ignore-words= - -# A path to a file that contains private dictionary; one word per line. -spelling-private-dict-file= - -# Tells whether to store unknown words to indicated private dictionary in -# --spelling-private-dict-file option instead of raising a message. -spelling-store-unknown-words=no - - -[MISCELLANEOUS] - -# List of note tags to take in consideration, separated by a comma. -# notes=FIXME,XXX,TODO -notes=FIXME,XXX - - -[TYPECHECK] - -# List of decorators that produce context managers, such as -# contextlib.contextmanager. Add to this list to register other decorators that -# produce valid context managers. -contextmanager-decorators=contextlib.contextmanager - -# List of members which are set dynamically and missed by pylint inference -# system, and so shouldn't trigger E1101 when accessed. Python regular -# expressions are accepted. -generated-members= - -# Tells whether missing members accessed in mixin class should be ignored. A -# mixin class is detected if its name ends with "mixin" (case insensitive). -ignore-mixin-members=yes - -# This flag controls whether pylint should warn about no-member and similar -# checks whenever an opaque object is returned when inferring. The inference -# can return multiple potential results while evaluating a Python object, but -# some branches might not be evaluated, which results in partial inference. In -# that case, it might be useful to still emit no-member and other checks for -# the rest of the inferred objects. -ignore-on-opaque-inference=yes - -# List of class names for which member attributes should not be checked (useful -# for classes with dynamically set attributes). This supports the use of -# qualified names. -ignored-classes=optparse.Values,thread._local,_thread._local - -# List of module names for which member attributes should not be checked -# (useful for modules/projects where namespaces are manipulated during runtime -# and thus existing member attributes cannot be deduced by static analysis. It -# supports qualified module names, as well as Unix pattern matching. -ignored-modules=board - -# Show a hint with possible names when a member name was not found. The aspect -# of finding the hint is based on edit distance. -missing-member-hint=yes - -# The minimum edit distance a name should have in order to be considered a -# similar match for a missing member name. -missing-member-hint-distance=1 - -# The total number of similar names that should be taken in consideration when -# showing a hint for a missing member. -missing-member-max-choices=1 - - -[VARIABLES] - -# List of additional names supposed to be defined in builtins. Remember that -# you should avoid to define new builtins when possible. -additional-builtins= - -# Tells whether unused global variables should be treated as a violation. -allow-global-unused-variables=yes - -# List of strings which can identify a callback function by name. A callback -# name must start or end with one of those strings. -callbacks=cb_,_cb - -# A regular expression matching the name of dummy variables (i.e. expectedly -# not used). -dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ - -# Argument names that match this expression will be ignored. Default to name -# with leading underscore -ignored-argument-names=_.*|^ignored_|^unused_ - -# Tells whether we should check for unused import in __init__ files. -init-import=no - -# List of qualified module names which can have objects that can redefine -# builtins. -redefining-builtins-modules=six.moves,future.builtins - - -[FORMAT] - -# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. -# expected-line-ending-format= -expected-line-ending-format=LF - -# Regexp for a line that is allowed to be longer than the limit. -ignore-long-lines=^\s*(# )??$ - -# Number of spaces of indent required inside a hanging or continued line. -indent-after-paren=4 - -# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 -# tab). -indent-string=' ' - -# Maximum number of characters on a single line. -max-line-length=100 - -# Maximum number of lines in a module -max-module-lines=1000 - -# Allow the body of a class to be on the same line as the declaration if body -# contains single statement. -single-line-class-stmt=no - -# Allow the body of an if to be on the same line as the test if there is no -# else. -single-line-if-stmt=no - - -[SIMILARITIES] - -# Ignore comments when computing similarities. -ignore-comments=yes - -# Ignore docstrings when computing similarities. -ignore-docstrings=yes - -# Ignore imports when computing similarities. -ignore-imports=yes - -# Minimum lines number of a similarity. -min-similarity-lines=12 - - -[BASIC] - -# Regular expression matching correct argument names -argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct attribute names -attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Bad variable names which should always be refused, separated by a comma -bad-names=foo,bar,baz,toto,tutu,tata - -# Regular expression matching correct class attribute names -class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Regular expression matching correct class names -# class-rgx=[A-Z_][a-zA-Z0-9]+$ -class-rgx=[A-Z_][a-zA-Z0-9_]+$ - -# Regular expression matching correct constant names -const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - -# Minimum line length for functions/classes that require docstrings, shorter -# ones are exempt. -docstring-min-length=-1 - -# Regular expression matching correct function names -function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Good variable names which should always be accepted, separated by a comma -# good-names=i,j,k,ex,Run,_ -good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ - -# Include a hint for the correct naming format with invalid-name -include-naming-hint=no - -# Regular expression matching correct inline iteration names -inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ - -# Regular expression matching correct method names -method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct module names -module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ - -# Colon-delimited sets of names that determine each other's naming style when -# the name regexes allow several styles. -name-group= - -# Regular expression which should only match function or class names that do -# not require a docstring. -no-docstring-rgx=^_ - -# List of decorators that produce properties, such as abc.abstractproperty. Add -# to this list to register other decorators that produce valid properties. -property-classes=abc.abstractproperty - -# Regular expression matching correct variable names -variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - - -[IMPORTS] - -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no - -# Analyse import fallback blocks. This can be used to support both Python 2 and -# 3 compatible code, which means that the block might have code that exists -# only in one or another interpreter, leading to false positives when analysed. -analyse-fallback-blocks=no - -# Deprecated modules which should not be used, separated by a comma -deprecated-modules=optparse,tkinter.tix - -# Create a graph of external dependencies in the given file (report RP0402 must -# not be disabled) -ext-import-graph= - -# Create a graph of every (i.e. internal and external) dependencies in the -# given file (report RP0402 must not be disabled) -import-graph= - -# Create a graph of internal dependencies in the given file (report RP0402 must -# not be disabled) -int-import-graph= - -# Force import order to recognize a module as part of the standard -# compatibility libraries. -known-standard-library= - -# Force import order to recognize a module as part of a third party library. -known-third-party=enchant - - -[CLASSES] - -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__,__new__,setUp - -# List of member names, which should be excluded from the protected access -# warning. -exclude-protected=_asdict,_fields,_replace,_source,_make - -# List of valid names for the first argument in a class method. -valid-classmethod-first-arg=cls - -# List of valid names for the first argument in a metaclass class method. -valid-metaclass-classmethod-first-arg=mcs - - -[DESIGN] - -# Maximum number of arguments for function / method -max-args=5 - -# Maximum number of attributes for a class (see R0902). -# max-attributes=7 -max-attributes=11 - -# Maximum number of boolean expressions in a if statement -max-bool-expr=5 - -# Maximum number of branch for function / method body -max-branches=12 - -# Maximum number of locals for function / method body -max-locals=15 - -# Maximum number of parents for a class (see R0901). -max-parents=7 - -# Maximum number of public methods for a class (see R0904). -max-public-methods=20 - -# Maximum number of return / yield for function / method body -max-returns=6 - -# Maximum number of statements in function / method body -max-statements=50 - -# Minimum number of public methods for a class (see R0903). -min-public-methods=1 - - -[EXCEPTIONS] - -# Exceptions that will emit a warning when being caught. Defaults to -# "Exception" -overgeneral-exceptions=builtins.Exception diff --git a/adafruit_ov5640/__init__.py b/adafruit_ov5640/__init__.py index 1e82b64..daca3b6 100644 --- a/adafruit_ov5640/__init__.py +++ b/adafruit_ov5640/__init__.py @@ -28,15 +28,17 @@ # pylint: disable=too-many-public-methods # imports import time + import imagecapture import pwmio from adafruit_bus_device.i2c_device import I2CDevice try: - from typing import Optional, Sequence, List, Union + from typing import List, Optional, Sequence, Union + from busio import I2C - from microcontroller import Pin from digitalio import DigitalInOut + from microcontroller import Pin except ImportError: pass @@ -927,9 +929,7 @@ def __get__(self, obj: "OV5640", objtype: Optional[type] = None) -> int: def __set__(self, obj: "OV5640", value: int) -> None: if value & ~self.mask: - raise ValueError( - f"Value 0x{value:02x} does not fit in mask 0x{self.mask:02x}" - ) + raise ValueError(f"Value 0x{value:02x} does not fit in mask 0x{self.mask:02x}") reg_value = obj._read_register(self.reg) reg_value &= ~(self.mask << self.shift) reg_value |= value << self.shift @@ -948,9 +948,7 @@ def __get__(self, obj: "OV5640", objtype: Optional[type] = None) -> int: def __set__(self, obj: "OV5640", value: int) -> None: if value & ~self.mask: - raise ValueError( - f"Value 0x{value:02x} does not fit in mask 0x{self.mask:02x}" - ) + raise ValueError(f"Value 0x{value:02x} does not fit in mask 0x{self.mask:02x}") reg_value = obj._read_register16(self.reg) reg_value &= ~(self.mask << self.shift) reg_value |= value << self.shift @@ -1023,7 +1021,7 @@ def _write_list(self, reg_list: Sequence[int]) -> None: self._write_register(register, value) def _write_reg_bits(self, reg: int, mask: int, enable: bool) -> None: - val = val = self._read_register(reg) + val = self._read_register(reg) if enable: val |= mask else: @@ -1146,9 +1144,7 @@ def autofocus_init_from_bitstream(self, firmware: bytes): reg = offset + 0x8000 arr[0] = reg >> 8 arr[1] = reg & 0xFF - arr[2 : 2 + num_firmware_bytes] = firmware[ - offset : offset + num_firmware_bytes - ] + arr[2 : 2 + num_firmware_bytes] = firmware[offset : offset + num_firmware_bytes] i2c.write(arr, end=2 + num_firmware_bytes) self._write_list(self._finalize_firmware_load) @@ -1162,9 +1158,7 @@ def autofocus_init_from_bitstream(self, firmware: bytes): def autofocus_init(self): """Initialize the autofocus engine from ov5640_autofocus.bin""" if "/" in __file__: - binfile = ( - __file__.rsplit("/", 1)[0].rsplit(".", 1)[0] + "/ov5640_autofocus.bin" - ) + binfile = __file__.rsplit("/", 1)[0].rsplit(".", 1)[0] + "/ov5640_autofocus.bin" else: binfile = "ov5640_autofocus.bin" print(binfile) @@ -1202,9 +1196,7 @@ def autofocus(self) -> list[int]: @property def autofocus_vcm_step(self): """Get the voice coil motor step location""" - if not self._send_autofocus_command( - _OV5640_CMD_AF_GET_VCM_STEP, "get vcm step" - ): + if not self._send_autofocus_command(_OV5640_CMD_AF_GET_VCM_STEP, "get vcm step"): return None return self._read_register(_OV5640_CMD_PARA4) @@ -1467,9 +1459,7 @@ def saturation(self) -> int: @saturation.setter def saturation(self, value: int) -> None: if not -4 <= value <= 4: - raise ValueError( - "Invalid saturation {value}, use a value from -4..4 inclusive" - ) + raise ValueError("Invalid saturation {value}, use a value from -4..4 inclusive") for offset, reg_value in enumerate(_sensor_saturation_levels[value]): self._write_register(0x5381 + offset, reg_value) self._saturation = value @@ -1495,9 +1485,7 @@ def quality(self) -> int: @quality.setter def quality(self, value: int) -> None: if not 2 <= value <= 54: - raise ValueError( - f"Invalid quality value {value}, use a value from 2..54 inclusive" - ) + raise ValueError(f"Invalid quality value {value}, use a value from 2..54 inclusive") self._write_register(_COMPRESSION_CTRL07, value & 0x3F) def _write_group_3_settings(self, settings): @@ -1518,12 +1506,8 @@ def brightness(self) -> int: @brightness.setter def brightness(self, value: int) -> None: if not -4 <= value <= 4: - raise ValueError( - "Invalid brightness value {value}, use a value from -4..4 inclusive" - ) - self._write_group_3_settings( - [0x5587, abs(value) << 4, 0x5588, 0x9 if value < 0 else 0x1] - ) + raise ValueError("Invalid brightness value {value}, use a value from -4..4 inclusive") + self._write_group_3_settings([0x5587, abs(value) << 4, 0x5588, 0x9 if value < 0 else 0x1]) @property def contrast(self) -> int: @@ -1537,9 +1521,7 @@ def contrast(self) -> int: @contrast.setter def contrast(self, value: int) -> None: if not -3 <= value <= 3: - raise ValueError( - "Invalid contrast value {value}, use a value from -3..3 inclusive" - ) + raise ValueError("Invalid contrast value {value}, use a value from -3..3 inclusive") setting = _contrast_settings[value] self._write_group_3_settings([0x5586, setting[0], 0x5585, setting[1]]) diff --git a/docs/api.rst b/docs/api.rst index ac659e5..c618d4a 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,5 +4,8 @@ .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py) .. use this format as the module name: "adafruit_foo.foo" +API Reference +############# + .. automodule:: adafruit_ov5640 :members: diff --git a/docs/conf.py b/docs/conf.py index c975c6a..cbacf15 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,12 +1,10 @@ -# -*- coding: utf-8 -*- - # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries # # SPDX-License-Identifier: MIT +import datetime import os import sys -import datetime sys.path.insert(0, os.path.abspath("..")) @@ -62,9 +60,7 @@ creation_year = "2021" current_year = str(datetime.datetime.now().year) year_duration = ( - current_year - if current_year == creation_year - else creation_year + " - " + current_year + current_year if current_year == creation_year else creation_year + " - " + current_year ) copyright = year_duration + " Jeff Epler" author = "Jeff Epler" diff --git a/examples/ov5640_directio_kaluga1_3_ili9341.py b/examples/ov5640_directio_kaluga1_3_ili9341.py index 346fda4..128be80 100644 --- a/examples/ov5640_directio_kaluga1_3_ili9341.py +++ b/examples/ov5640_directio_kaluga1_3_ili9341.py @@ -22,7 +22,8 @@ import busio import digitalio import displayio -from adafruit_ticks import ticks_ms, ticks_less +from adafruit_ticks import ticks_less, ticks_ms + import adafruit_ov5640 # Set to True to enable the various effects & exposure modes to be tested @@ -44,13 +45,13 @@ ) _INIT_SEQUENCE = ( b"\x01\x80\x80" # Software reset then delay 0x80 (128ms) - b"\xEF\x03\x03\x80\x02" - b"\xCF\x03\x00\xC1\x30" - b"\xED\x04\x64\x03\x12\x81" - b"\xE8\x03\x85\x00\x78" - b"\xCB\x05\x39\x2C\x00\x34\x02" - b"\xF7\x01\x20" - b"\xEA\x02\x00\x00" + b"\xef\x03\x03\x80\x02" + b"\xcf\x03\x00\xc1\x30" + b"\xed\x04\x64\x03\x12\x81" + b"\xe8\x03\x85\x00\x78" + b"\xcb\x05\x39\x2c\x00\x34\x02" + b"\xf7\x01\x20" + b"\xea\x02\x00\x00" b"\xc0\x01\x23" # Power control VRH[5:0] b"\xc1\x01\x10" # Power control SAP[2:0];BT[3:0] b"\xc5\x02\x3e\x28" # VCM control @@ -60,10 +61,10 @@ b"\x3a\x01\x55" # COLMOD: Pixel Format Set b"\xb1\x02\x00\x18" # Frame Rate Control (In Normal Mode/Full Colors) b"\xb6\x03\x08\x82\x27" # Display Function Control - b"\xF2\x01\x00" # 3Gamma Function Disable + b"\xf2\x01\x00" # 3Gamma Function Disable b"\x26\x01\x01" # Gamma curve selected - b"\xe0\x0f\x0F\x31\x2B\x0C\x0E\x08\x4E\xF1\x37\x07\x10\x03\x0E\x09\x00" # Set Gamma - b"\xe1\x0f\x00\x0E\x14\x03\x11\x07\x31\xC1\x48\x08\x0F\x0C\x31\x36\x0F" # Set Gamma + b"\xe0\x0f\x0f\x31\x2b\x0c\x0e\x08\x4e\xf1\x37\x07\x10\x03\x0e\x09\x00" # Set Gamma + b"\xe1\x0f\x00\x0e\x14\x03\x11\x07\x31\xc1\x48\x08\x0f\x0c\x31\x36\x0f" # Set Gamma b"\x11\x80\x78" # Exit Sleep then delay 0x78 (120ms) b"\x29\x80\x78" # Display on then delay 0x78 (120ms) ) @@ -133,9 +134,7 @@ def contrast_modes(cam_obj): def white_balance_modes(cam_obj): # pylint: disable=unused-variable for i in ["AUTO", "SUNNY", "FLUORESCENT", "CLOUDY", "INCANDESCENT"]: print(f"White Balance {i}") - cam_obj.white_balance = getattr( - adafruit_ov5640, f"OV5640_WHITE_BALANCE_{i}" - ) + cam_obj.white_balance = getattr(adafruit_ov5640, f"OV5640_WHITE_BALANCE_{i}") yield cam_obj.white_balance = adafruit_ov5640.OV5640_WHITE_BALANCE_AUTO diff --git a/examples/ov5640_jpeg_capture_af.py b/examples/ov5640_jpeg_capture_af.py index 3cabda0..8be8b5d 100644 --- a/examples/ov5640_jpeg_capture_af.py +++ b/examples/ov5640_jpeg_capture_af.py @@ -9,12 +9,14 @@ import os import time -import busio + import board +import busio import digitalio import keypad import sdcardio import storage + import adafruit_ov5640 print("Initializing SD card") @@ -62,18 +64,25 @@ def exists(filename): return False -_image_counter = 0 +class ImageCounter: + def __init__(self): + self.count = 0 + + def get_next(self): + while True: + filename = f"/sd/img{self.count:04d}.jpg" + self.count += 1 + if exists(filename): + continue + print("# writing to", filename) + return open(filename, "wb") + + +_image_counter = ImageCounter() def open_next_image(): - global _image_counter # pylint: disable=global-statement - while True: - filename = f"/sd/img{_image_counter:04d}.jpg" - _image_counter += 1 - if exists(filename): - continue - print("# writing to", filename) - return open(filename, "wb") + return _image_counter.get_next() cam.colorspace = adafruit_ov5640.OV5640_COLOR_JPEG diff --git a/examples/ov5640_jpeg_capture_manual_focus.py b/examples/ov5640_jpeg_capture_manual_focus.py index 165b055..d55db0a 100644 --- a/examples/ov5640_jpeg_capture_manual_focus.py +++ b/examples/ov5640_jpeg_capture_manual_focus.py @@ -12,12 +12,14 @@ import os import time -import busio + import board +import busio import digitalio import keypad import sdcardio import storage + import adafruit_ov5640 print("Initializing SD card") @@ -65,18 +67,25 @@ def exists(filename): return False -_image_counter = 0 +class ImageCounter: + def __init__(self): + self.count = 0 + + def get_next(self): + while True: + filename = f"/sd/img{self.count:04d}.jpg" + self.count += 1 + if exists(filename): + continue + print("# writing to", filename) + return open(filename, "wb") + + +_image_counter = ImageCounter() def open_next_image(): - global _image_counter # pylint: disable=global-statement - while True: - filename = f"/sd/img{_image_counter:04d}.jpg" - _image_counter += 1 - if exists(filename): - continue - print("# writing to", filename) - return open(filename, "wb") + return _image_counter.get_next() cam.colorspace = adafruit_ov5640.OV5640_COLOR_JPEG diff --git a/examples/ov5640_jpeg_kaluga1_3.py b/examples/ov5640_jpeg_kaluga1_3.py index 3a0a4d3..da637a9 100644 --- a/examples/ov5640_jpeg_kaluga1_3.py +++ b/examples/ov5640_jpeg_kaluga1_3.py @@ -17,12 +17,12 @@ import time +import adafruit_ili9341 import board import busio import displayio import microcontroller -import adafruit_ili9341 import adafruit_ov5640 # Release any resources currently in use for the displays diff --git a/examples/ov5640_pico_simpletest.py b/examples/ov5640_pico_simpletest.py index cee840a..60e9b56 100644 --- a/examples/ov5640_pico_simpletest.py +++ b/examples/ov5640_pico_simpletest.py @@ -17,11 +17,14 @@ Remember to take the lens cap off! """ + import sys import time -import busio + import board +import busio import digitalio + import adafruit_ov5640 print("construct bus") diff --git a/examples/ov5640_pico_st7789.py b/examples/ov5640_pico_st7789.py index 80c8d49..2c7f9fe 100644 --- a/examples/ov5640_pico_st7789.py +++ b/examples/ov5640_pico_st7789.py @@ -11,21 +11,23 @@ Remember to take the lens cap off! """ + import time + +import board +import busio +import digitalio from adafruit_ov7670 import OV7670, OV7670_SIZE_DIV1, OV7670_SIZE_DIV16 +from adafruit_st7789 import ST7789 from displayio import ( Bitmap, + ColorConverter, + Colorspace, + FourWire, Group, TileGrid, - FourWire, release_displays, - ColorConverter, - Colorspace, ) -from adafruit_st7789 import ST7789 -import board -import busio -import digitalio # Set up the display (You must customize this block for your display!) release_displays() @@ -78,9 +80,7 @@ raise SystemExit("Could not allocate a bitmap") g = Group(scale=1, x=(width - cam.width) // 2, y=(height - cam.height) // 2) -tg = TileGrid( - bitmap, pixel_shader=ColorConverter(input_colorspace=Colorspace.RGB565_SWAPPED) -) +tg = TileGrid(bitmap, pixel_shader=ColorConverter(input_colorspace=Colorspace.RGB565_SWAPPED)) g.append(tg) display.root_group = g diff --git a/examples/ov5640_sdcard_kaluga_1_3.py b/examples/ov5640_sdcard_kaluga_1_3.py index b8d5601..4702b49 100644 --- a/examples/ov5640_sdcard_kaluga_1_3.py +++ b/examples/ov5640_sdcard_kaluga_1_3.py @@ -23,6 +23,7 @@ import os import time +import adafruit_ili9341 import analogio import board import busio @@ -31,7 +32,6 @@ import sdcardio import storage -import adafruit_ili9341 import adafruit_ov5640 # Release any resources currently in use for the displays @@ -79,18 +79,25 @@ def exists(filename): return False -_image_counter = 0 +class ImageCounter: + def __init__(self): + self.count = 0 + + def get_next(self): + while True: + filename = f"/sd/img{self.count:04d}.jpg" + self.count += 1 + if exists(filename): + continue + print("# writing to", filename) + return open(filename, "wb") + + +_image_counter = ImageCounter() def open_next_image(): - global _image_counter # pylint: disable=global-statement - while True: - filename = f"/sd/img{_image_counter:04d}.jpg" - _image_counter += 1 - if exists(filename): - continue - print("# writing to", filename) - return open(filename, "wb") + return _image_counter.get_next() cam.colorspace = adafruit_ov5640.OV5640_COLOR_JPEG @@ -124,7 +131,5 @@ def open_next_image(): except OSError as e: print(e) while record_pressed: - a_voltage = ( - a.value * a.reference_voltage / 65535 - ) # pylint: disable=no-member + a_voltage = a.value * a.reference_voltage / 65535 # pylint: disable=no-member record_pressed = abs(a_voltage - V_RECORD) < 0.05 diff --git a/examples/ov5640_simpletest.py b/examples/ov5640_simpletest.py index bd497ac..20abada 100644 --- a/examples/ov5640_simpletest.py +++ b/examples/ov5640_simpletest.py @@ -23,8 +23,8 @@ import sys import time -import busio import board +import busio import adafruit_ov5640 diff --git a/examples/ov5640_stopmotion_kaluga1_3.py b/examples/ov5640_stopmotion_kaluga1_3.py index 3c4b428..100f27d 100644 --- a/examples/ov5640_stopmotion_kaluga1_3.py +++ b/examples/ov5640_stopmotion_kaluga1_3.py @@ -81,13 +81,13 @@ def record_pressed(): ) _INIT_SEQUENCE = ( b"\x01\x80\x80" # Software reset then delay 0x80 (128ms) - b"\xEF\x03\x03\x80\x02" - b"\xCF\x03\x00\xC1\x30" - b"\xED\x04\x64\x03\x12\x81" - b"\xE8\x03\x85\x00\x78" - b"\xCB\x05\x39\x2C\x00\x34\x02" - b"\xF7\x01\x20" - b"\xEA\x02\x00\x00" + b"\xef\x03\x03\x80\x02" + b"\xcf\x03\x00\xc1\x30" + b"\xed\x04\x64\x03\x12\x81" + b"\xe8\x03\x85\x00\x78" + b"\xcb\x05\x39\x2c\x00\x34\x02" + b"\xf7\x01\x20" + b"\xea\x02\x00\x00" b"\xc0\x01\x23" # Power control VRH[5:0] b"\xc1\x01\x10" # Power control SAP[2:0];BT[3:0] b"\xc5\x02\x3e\x28" # VCM control @@ -97,10 +97,10 @@ def record_pressed(): b"\x3a\x01\x55" # COLMOD: Pixel Format Set b"\xb1\x02\x00\x18" # Frame Rate Control (In Normal Mode/Full Colors) b"\xb6\x03\x08\x82\x27" # Display Function Control - b"\xF2\x01\x00" # 3Gamma Function Disable + b"\xf2\x01\x00" # 3Gamma Function Disable b"\x26\x01\x01" # Gamma curve selected - b"\xe0\x0f\x0F\x31\x2B\x0C\x0E\x08\x4E\xF1\x37\x07\x10\x03\x0E\x09\x00" # Set Gamma - b"\xe1\x0f\x00\x0E\x14\x03\x11\x07\x31\xC1\x48\x08\x0F\x0C\x31\x36\x0F" # Set Gamma + b"\xe0\x0f\x0f\x31\x2b\x0c\x0e\x08\x4e\xf1\x37\x07\x10\x03\x0e\x09\x00" # Set Gamma + b"\xe1\x0f\x00\x0e\x14\x03\x11\x07\x31\xc1\x48\x08\x0f\x0c\x31\x36\x0f" # Set Gamma b"\x11\x80\x78" # Exit Sleep then delay 0x78 (120ms) b"\x29\x80\x78" # Display on then delay 0x78 (120ms) ) @@ -133,19 +133,26 @@ def exists(filename): return False -_image_counter = 0 +class ImageCounter: + def __init__(self): + self.count = 0 + + def next_filename(self, extension="jpg"): + while True: + filename = f"/sd/img{self.count:04d}.{extension}" + if exists(filename): + print(f"File exists: {filename}", end="\r") + self.count += 1 + continue + print() + return filename + + +_image_counter = ImageCounter() def next_filename(extension="jpg"): - global _image_counter # pylint: disable=global-statement - while True: - filename = f"/sd/img{_image_counter:04d}.{extension}" - if exists(filename): - print(f"File exists: {filename}", end="\r") - _image_counter += 1 - continue - print() - return filename + return _image_counter.next_filename(extension) # Pre-cache the next image number @@ -219,9 +226,7 @@ def wait_record_pressed_update_display(first_frame, cap): # First frame -- display as-is display_bus.send(44, frame) else: - bitmaptools.alphablend( - onionskin, old_frame, frame, displayio.Colorspace.RGB565_SWAPPED - ) + bitmaptools.alphablend(onionskin, old_frame, frame, displayio.Colorspace.RGB565_SWAPPED) display_bus.send(44, onionskin) @@ -238,9 +243,7 @@ def take_stop_motion_gif(n_frames=10, replay_frame_time=0.3): # CircuitPython Versions <= 8.2.0 if hasattr(old_frame, "blit"): - old_frame.blit( - 0, 0, frame, x1=0, y1=0, x2=frame.width, y2=frame.height - ) + old_frame.blit(0, 0, frame, x1=0, y1=0, x2=frame.width, y2=frame.height) # CircuitPython Versions >= 9.0.0 else: diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..36332ff --- /dev/null +++ b/ruff.toml @@ -0,0 +1,105 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +target-version = "py38" +line-length = 100 + +[lint] +preview = true +select = ["I", "PL", "UP"] + +extend-select = [ + "D419", # empty-docstring + "E501", # line-too-long + "W291", # trailing-whitespace + "PLC0414", # useless-import-alias + "PLC2401", # non-ascii-name + "PLC2801", # unnecessary-dunder-call + "PLC3002", # unnecessary-direct-lambda-call + "E999", # syntax-error + "PLE0101", # return-in-init + "F706", # return-outside-function + "F704", # yield-outside-function + "PLE0116", # continue-in-finally + "PLE0117", # nonlocal-without-binding + "PLE0241", # duplicate-bases + "PLE0302", # unexpected-special-method-signature + "PLE0604", # invalid-all-object + "PLE0605", # invalid-all-format + "PLE0643", # potential-index-error + "PLE0704", # misplaced-bare-raise + "PLE1141", # dict-iter-missing-items + "PLE1142", # await-outside-async + "PLE1205", # logging-too-many-args + "PLE1206", # logging-too-few-args + "PLE1307", # bad-string-format-type + "PLE1310", # bad-str-strip-call + "PLE1507", # invalid-envvar-value + "PLE2502", # bidirectional-unicode + "PLE2510", # invalid-character-backspace + "PLE2512", # invalid-character-sub + "PLE2513", # invalid-character-esc + "PLE2514", # invalid-character-nul + "PLE2515", # invalid-character-zero-width-space + "PLR0124", # comparison-with-itself + "PLR0202", # no-classmethod-decorator + "PLR0203", # no-staticmethod-decorator + "UP004", # useless-object-inheritance + "PLR0206", # property-with-parameters + "PLR0904", # too-many-public-methods + "PLR0911", # too-many-return-statements + "PLR0912", # too-many-branches + "PLR0913", # too-many-arguments + "PLR0914", # too-many-locals + "PLR0915", # too-many-statements + "PLR0916", # too-many-boolean-expressions + "PLR1702", # too-many-nested-blocks + "PLR1704", # redefined-argument-from-local + "PLR1711", # useless-return + "C416", # unnecessary-comprehension + "PLR1733", # unnecessary-dict-index-lookup + "PLR1736", # unnecessary-list-index-lookup + + # ruff reports this rule is unstable + #"PLR6301", # no-self-use + + "PLW0108", # unnecessary-lambda + "PLW0120", # useless-else-on-loop + "PLW0127", # self-assigning-variable + "PLW0129", # assert-on-string-literal + "B033", # duplicate-value + "PLW0131", # named-expr-without-context + "PLW0245", # super-without-brackets + "PLW0406", # import-self + "PLW0602", # global-variable-not-assigned + "PLW0603", # global-statement + "PLW0604", # global-at-module-level + + # fails on the try: import typing used by libraries + #"F401", # unused-import + + "F841", # unused-variable + "E722", # bare-except + "PLW0711", # binary-op-exception + "PLW1501", # bad-open-mode + "PLW1508", # invalid-envvar-default + "PLW1509", # subprocess-popen-preexec-fn + "PLW2101", # useless-with-lock + "PLW3301", # nested-min-max +] + +ignore = [ + "PLR2004", # magic-value-comparison + "UP030", # format literals + "PLW1514", # unspecified-encoding + "PLR0913", # too-many-arguments + "PLR0915", # too-many-statements + "PLR0917", # too-many-positional-arguments + "PLR0904", # too-many-public-methods + "PLR0912", # too-many-branches + "PLR0916", # too-many-boolean-expressions +] + +[format] +line-ending = "lf" From 58c4c775ee0e486c017cce8959d5066b5f1f22f4 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 13 May 2025 15:54:26 +0000 Subject: [PATCH 22/29] remove pylint disables --- adafruit_ov5640/__init__.py | 18 ++++++++---------- examples/ov5640_directio_kaluga1_3_ili9341.py | 6 +++--- examples/ov5640_jpeg_kaluga1_3.py | 2 +- examples/ov5640_jpeg_kaluga1_3_boot.py | 2 +- examples/ov5640_sdcard_kaluga_1_3.py | 4 ++-- 5 files changed, 15 insertions(+), 17 deletions(-) diff --git a/adafruit_ov5640/__init__.py b/adafruit_ov5640/__init__.py index daca3b6..153e5b8 100644 --- a/adafruit_ov5640/__init__.py +++ b/adafruit_ov5640/__init__.py @@ -24,8 +24,6 @@ https://github.com/adafruit/circuitpython/releases """ -# pylint: disable=too-many-lines -# pylint: disable=too-many-public-methods # imports import time @@ -955,7 +953,7 @@ def __set__(self, obj: "OV5640", value: int) -> None: obj._write_register16(self.reg, reg_value) -class _SCCB16CameraBase: # pylint: disable=too-few-public-methods +class _SCCB16CameraBase: _finalize_firmware_load = ( 0x3022, 0x00, @@ -1029,7 +1027,7 @@ def _write_reg_bits(self, reg: int, mask: int, enable: bool) -> None: self._write_register(reg, val) -class OV5640(_SCCB16CameraBase): # pylint: disable=too-many-instance-attributes +class OV5640(_SCCB16CameraBase): """Control & Capture Images from an OV5640 Camera""" def __init__( @@ -1046,7 +1044,7 @@ def __init__( i2c_address: int = 0x3C, size: int = OV5640_SIZE_QQVGA, init_autofocus: bool = True, - ): # pylint: disable=too-many-arguments + ): """ Args: i2c_bus (busio.I2C): The I2C bus used to configure the OV5640 @@ -1169,7 +1167,7 @@ def autofocus_status(self): """Read the camera autofocus status register""" return self._read_register(_OV5640_CMD_FW_STATUS) - def _send_autofocus_command(self, command, msg): # pylint: disable=unused-argument + def _send_autofocus_command(self, command, msg): self._write_register(_OV5640_CMD_ACK, 0x01) # clear command ack self._write_register(_OV5640_CMD_MAIN, command) # send command for _ in range(1000): @@ -1260,7 +1258,7 @@ def colorspace(self, colorspace: int) -> None: self._colorspace = colorspace self._set_size_and_colorspace() - def _set_image_options(self) -> None: # pylint: disable=too-many-branches + def _set_image_options(self) -> None: reg20 = reg21 = reg4514 = reg4514_test = 0 if self.colorspace == OV5640_COLOR_JPEG: reg21 |= 0x20 @@ -1331,7 +1329,7 @@ def size(self) -> int: """Get or set the captured image size, one of the ``OV5640_SIZE_`` constants.""" return self._size - def _set_size_and_colorspace(self) -> None: # pylint: disable=too-many-locals + def _set_size_and_colorspace(self) -> None: size = self._size width, height, ratio = _resolution_info[size] self._w = width @@ -1385,7 +1383,7 @@ def _set_size_and_colorspace(self) -> None: # pylint: disable=too-many-locals self._set_colorspace() - def _set_pll( # pylint: disable=too-many-arguments + def _set_pll( self, bypass: bool, multiplier: int, @@ -1396,7 +1394,7 @@ def _set_pll( # pylint: disable=too-many-arguments pclk_manual: bool, pclk_div: int, ) -> None: - if ( # pylint: disable=too-many-boolean-expressions + if ( multiplier > 252 or multiplier < 4 or sys_div > 15 diff --git a/examples/ov5640_directio_kaluga1_3_ili9341.py b/examples/ov5640_directio_kaluga1_3_ili9341.py index 128be80..110abad 100644 --- a/examples/ov5640_directio_kaluga1_3_ili9341.py +++ b/examples/ov5640_directio_kaluga1_3_ili9341.py @@ -131,21 +131,21 @@ def contrast_modes(cam_obj): yield cam_obj.contrast = 0 - def white_balance_modes(cam_obj): # pylint: disable=unused-variable + def white_balance_modes(cam_obj): for i in ["AUTO", "SUNNY", "FLUORESCENT", "CLOUDY", "INCANDESCENT"]: print(f"White Balance {i}") cam_obj.white_balance = getattr(adafruit_ov5640, f"OV5640_WHITE_BALANCE_{i}") yield cam_obj.white_balance = adafruit_ov5640.OV5640_WHITE_BALANCE_AUTO - def exposure_value_modes(cam_obj): # pylint: disable=unused-variable + def exposure_value_modes(cam_obj): for i in range(-3, 4): print(f"EV {i}") cam_obj.exposure_value = i yield cam_obj.exposure_value = 0 - def nite_modes(cam_obj): # pylint: disable=unused-variable + def nite_modes(cam_obj): print("Night Mode On") cam_obj.night_mode = True print(cam_obj.night_mode) diff --git a/examples/ov5640_jpeg_kaluga1_3.py b/examples/ov5640_jpeg_kaluga1_3.py index da637a9..6a7c4c9 100644 --- a/examples/ov5640_jpeg_kaluga1_3.py +++ b/examples/ov5640_jpeg_kaluga1_3.py @@ -78,7 +78,7 @@ print("Wrote to CIRCUITPY/cam.jpg") print("Resetting so computer sees new content of CIRCUITPY") time.sleep(0.5) - microcontroller.reset() # pylint: disable=no-member + microcontroller.reset() except OSError as e: print(e) diff --git a/examples/ov5640_jpeg_kaluga1_3_boot.py b/examples/ov5640_jpeg_kaluga1_3_boot.py index 61dfd03..f2a7bad 100644 --- a/examples/ov5640_jpeg_kaluga1_3_boot.py +++ b/examples/ov5640_jpeg_kaluga1_3_boot.py @@ -17,7 +17,7 @@ V_RECORD = 2.41 a = analogio.AnalogIn(board.IO6) -a_voltage = a.value * a.reference_voltage / 65535 # pylint: disable=no-member +a_voltage = a.value * a.reference_voltage / 65535 print("measured voltage", a_voltage) if abs(a_voltage - V_MODE) < 0.05: # If mode IS pressed... print("storage writable by CircuitPython") diff --git a/examples/ov5640_sdcard_kaluga_1_3.py b/examples/ov5640_sdcard_kaluga_1_3.py index 4702b49..664d5b7 100644 --- a/examples/ov5640_sdcard_kaluga_1_3.py +++ b/examples/ov5640_sdcard_kaluga_1_3.py @@ -108,7 +108,7 @@ def open_next_image(): while True: pixel[0] = 0x0000FF pixel.write() - a_voltage = a.value * a.reference_voltage / 65535 # pylint: disable=no-member + a_voltage = a.value * a.reference_voltage / 65535 record_pressed = abs(a_voltage - V_RECORD) < 0.05 if record_pressed: pixel[0] = 0xFF0000 @@ -131,5 +131,5 @@ def open_next_image(): except OSError as e: print(e) while record_pressed: - a_voltage = a.value * a.reference_voltage / 65535 # pylint: disable=no-member + a_voltage = a.value * a.reference_voltage / 65535 record_pressed = abs(a_voltage - V_RECORD) < 0.05 From 36c1a5faaa22f9ffc76f33391353a6dfbeca7f6a Mon Sep 17 00:00:00 2001 From: Cooper Dalrymple Date: Thu, 15 May 2025 11:44:53 -0500 Subject: [PATCH 23/29] Update contrast docstring --- adafruit_ov5640/__init__.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_ov5640/__init__.py b/adafruit_ov5640/__init__.py index 153e5b8..8c060eb 100644 --- a/adafruit_ov5640/__init__.py +++ b/adafruit_ov5640/__init__.py @@ -1509,7 +1509,7 @@ def brightness(self, value: int) -> None: @property def contrast(self) -> int: - """Sensor contrast adjustment, from -4 to 4 inclusive""" + """Sensor contrast adjustment, from -3 to 3 inclusive""" contrast_abs = self._read_register(0x5587) >> 4 contrast_neg = self._read_register(0x5588) & 8 if contrast_neg: From 156ca1419f249e0488f2614e816d91bb1e2fa7c2 Mon Sep 17 00:00:00 2001 From: Cooper Dalrymple Date: Thu, 15 May 2025 11:58:42 -0500 Subject: [PATCH 24/29] Rewrite contrast property getter --- adafruit_ov5640/__init__.py | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/adafruit_ov5640/__init__.py b/adafruit_ov5640/__init__.py index 153e5b8..30919e9 100644 --- a/adafruit_ov5640/__init__.py +++ b/adafruit_ov5640/__init__.py @@ -1510,11 +1510,13 @@ def brightness(self, value: int) -> None: @property def contrast(self) -> int: """Sensor contrast adjustment, from -4 to 4 inclusive""" - contrast_abs = self._read_register(0x5587) >> 4 - contrast_neg = self._read_register(0x5588) & 8 - if contrast_neg: - return -contrast_abs - return contrast_abs + try: + value = _contrast_settings.index([self._read_register(0x5586), self._read_register(0x5585)]) + except ValueError: + value = 0 + if value > 3: + value -= len(_contrast_settings) + return value @contrast.setter def contrast(self, value: int) -> None: From 978fc683a2bdf6e1c3f1229a0a6d4f7829cdf369 Mon Sep 17 00:00:00 2001 From: Cooper Dalrymple Date: Thu, 15 May 2025 18:07:19 -0500 Subject: [PATCH 25/29] Fix ruff formatting --- adafruit_ov5640/__init__.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/adafruit_ov5640/__init__.py b/adafruit_ov5640/__init__.py index 30919e9..29543ca 100644 --- a/adafruit_ov5640/__init__.py +++ b/adafruit_ov5640/__init__.py @@ -1511,7 +1511,9 @@ def brightness(self, value: int) -> None: def contrast(self) -> int: """Sensor contrast adjustment, from -4 to 4 inclusive""" try: - value = _contrast_settings.index([self._read_register(0x5586), self._read_register(0x5585)]) + value = _contrast_settings.index( + [self._read_register(0x5586), self._read_register(0x5585)] + ) except ValueError: value = 0 if value > 3: From 51e8de4605dfcde9147d8060b70184455a1a7229 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Wed, 21 May 2025 14:11:54 -0500 Subject: [PATCH 26/29] initialize saturation and effect to default values. Fix ruff badge in readme --- README.rst | 6 +++--- adafruit_ov5640/__init__.py | 2 ++ 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index b9e5c4d..9ff6756 100644 --- a/README.rst +++ b/README.rst @@ -17,9 +17,9 @@ Introduction :alt: Build Status -.. image:: https://img.shields.io/badge/code%20style-black-000000.svg - :target: https://github.com/psf/black - :alt: Code Style: Black +.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json + :target: https://github.com/astral-sh/ruff + :alt: Code Style: Ruff CircuitPython driver for OV5640 Camera diff --git a/adafruit_ov5640/__init__.py b/adafruit_ov5640/__init__.py index 8c060eb..f93511e 100644 --- a/adafruit_ov5640/__init__.py +++ b/adafruit_ov5640/__init__.py @@ -1118,6 +1118,8 @@ def __init__( self._ev = 0 self._white_balance = 0 self.size = size + self._saturation = 0 + self._effect = OV5640_SPECIAL_EFFECT_NONE if init_autofocus: self.autofocus_init() From 611dd29df4be6610aa7bfccc76a91ee27323b167 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Thu, 29 May 2025 11:23:52 -0500 Subject: [PATCH 27/29] displayio api updates --- examples/ov5640_directio_kaluga1_3_ili9341.py | 6 ++++-- examples/ov5640_jpeg_kaluga1_3.py | 3 ++- examples/ov5640_sdcard_kaluga_1_3.py | 3 ++- examples/ov5640_stopmotion_kaluga1_3.py | 6 ++++-- 4 files changed, 12 insertions(+), 6 deletions(-) diff --git a/examples/ov5640_directio_kaluga1_3_ili9341.py b/examples/ov5640_directio_kaluga1_3_ili9341.py index 110abad..e997e7c 100644 --- a/examples/ov5640_directio_kaluga1_3_ili9341.py +++ b/examples/ov5640_directio_kaluga1_3_ili9341.py @@ -19,9 +19,11 @@ import struct import board +import busdisplay import busio import digitalio import displayio +import fourwire from adafruit_ticks import ticks_less, ticks_ms import adafruit_ov5640 @@ -36,7 +38,7 @@ state.switch_to_output(True) spi = busio.SPI(MOSI=board.LCD_MOSI, clock=board.LCD_CLK) -display_bus = displayio.FourWire( +display_bus = fourwire.FourWire( spi, command=board.LCD_D_C, chip_select=board.LCD_CS, @@ -69,7 +71,7 @@ b"\x29\x80\x78" # Display on then delay 0x78 (120ms) ) -display = displayio.Display(display_bus, _INIT_SEQUENCE, width=320, height=240) +display = busdisplay.BusDisplay(display_bus, _INIT_SEQUENCE, width=320, height=240) bus = busio.I2C(scl=board.CAMERA_SIOC, sda=board.CAMERA_SIOD) cam = adafruit_ov5640.OV5640( diff --git a/examples/ov5640_jpeg_kaluga1_3.py b/examples/ov5640_jpeg_kaluga1_3.py index 6a7c4c9..6ad28fd 100644 --- a/examples/ov5640_jpeg_kaluga1_3.py +++ b/examples/ov5640_jpeg_kaluga1_3.py @@ -21,6 +21,7 @@ import board import busio import displayio +import fourwire import microcontroller import adafruit_ov5640 @@ -28,7 +29,7 @@ # Release any resources currently in use for the displays displayio.release_displays() spi = busio.SPI(MOSI=board.LCD_MOSI, clock=board.LCD_CLK) -display_bus = displayio.FourWire( +display_bus = fourwire.FourWire( spi, command=board.LCD_D_C, chip_select=board.LCD_CS, diff --git a/examples/ov5640_sdcard_kaluga_1_3.py b/examples/ov5640_sdcard_kaluga_1_3.py index 664d5b7..55e79e0 100644 --- a/examples/ov5640_sdcard_kaluga_1_3.py +++ b/examples/ov5640_sdcard_kaluga_1_3.py @@ -28,6 +28,7 @@ import board import busio import displayio +import fourwire import neopixel import sdcardio import storage @@ -37,7 +38,7 @@ # Release any resources currently in use for the displays displayio.release_displays() spi = busio.SPI(MOSI=board.LCD_MOSI, clock=board.LCD_CLK) -display_bus = displayio.FourWire( +display_bus = fourwire.FourWire( spi, command=board.LCD_D_C, chip_select=board.LCD_CS, diff --git a/examples/ov5640_stopmotion_kaluga1_3.py b/examples/ov5640_stopmotion_kaluga1_3.py index 100f27d..77638f9 100644 --- a/examples/ov5640_stopmotion_kaluga1_3.py +++ b/examples/ov5640_stopmotion_kaluga1_3.py @@ -51,8 +51,10 @@ import analogio import bitmaptools import board +import busdisplay import busio import displayio +import fourwire import gifio import sdcardio import storage @@ -72,7 +74,7 @@ def record_pressed(): displayio.release_displays() spi = busio.SPI(MOSI=board.LCD_MOSI, clock=board.LCD_CLK) -display_bus = displayio.FourWire( +display_bus = fourwire.FourWire( spi, command=board.LCD_D_C, chip_select=board.LCD_CS, @@ -105,7 +107,7 @@ def record_pressed(): b"\x29\x80\x78" # Display on then delay 0x78 (120ms) ) -display = displayio.Display(display_bus, _INIT_SEQUENCE, width=320, height=240) +display = busdisplay.BusDisplay(display_bus, _INIT_SEQUENCE, width=320, height=240) sd_spi = busio.SPI(clock=board.IO18, MOSI=board.IO14, MISO=board.IO17) sd_cs = board.IO12 From f1d15dd10c8ad6d28eec6502f1bdb8886b4fdef1 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Wed, 4 Jun 2025 10:00:20 -0500 Subject: [PATCH 28/29] update rtd.yml file Signed-off-by: foamyguy --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 88bca9f..255dafd 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -12,7 +12,7 @@ sphinx: configuration: docs/conf.py build: - os: ubuntu-20.04 + os: ubuntu-lts-latest tools: python: "3" From b3d5d743c4f00ccfd1e8e24a2a2b00341f20dee4 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Fri, 10 Oct 2025 16:18:40 -0500 Subject: [PATCH 29/29] remove deprecated ruff rule, workaround RTD theme property inline issue. Signed-off-by: foamyguy --- docs/_static/custom.css | 8 ++++++++ docs/conf.py | 3 +++ ruff.toml | 1 - 3 files changed, 11 insertions(+), 1 deletion(-) create mode 100644 docs/_static/custom.css diff --git a/docs/_static/custom.css b/docs/_static/custom.css new file mode 100644 index 0000000..d60cf4b --- /dev/null +++ b/docs/_static/custom.css @@ -0,0 +1,8 @@ +/* SPDX-FileCopyrightText: 2025 Sam Blenny + * SPDX-License-Identifier: MIT + */ + +/* Monkey patch the rtd theme to prevent horizontal stacking of short items + * see https://github.com/readthedocs/sphinx_rtd_theme/issues/1301 + */ +.py.property{display: block !important;} diff --git a/docs/conf.py b/docs/conf.py index cbacf15..16fd9d7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -126,6 +126,9 @@ # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ["_static"] +# Include extra css to work around rtd theme glitches +html_css_files = ["custom.css"] + # The name of an image file (relative to this directory) to use as a favicon of # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. diff --git a/ruff.toml b/ruff.toml index 36332ff..9811947 100644 --- a/ruff.toml +++ b/ruff.toml @@ -17,7 +17,6 @@ extend-select = [ "PLC2401", # non-ascii-name "PLC2801", # unnecessary-dunder-call "PLC3002", # unnecessary-direct-lambda-call - "E999", # syntax-error "PLE0101", # return-in-init "F706", # return-outside-function "F704", # yield-outside-function