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..153e5b8 100644 --- a/adafruit_ov5640/__init__.py +++ b/adafruit_ov5640/__init__.py @@ -24,19 +24,19 @@ https://github.com/adafruit/circuitpython/releases """ -# pylint: disable=too-many-lines -# 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 +927,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,16 +946,14 @@ 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 obj._write_register16(self.reg, reg_value) -class _SCCB16CameraBase: # pylint: disable=too-few-public-methods +class _SCCB16CameraBase: _finalize_firmware_load = ( 0x3022, 0x00, @@ -1023,7 +1019,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: @@ -1031,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__( @@ -1048,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 @@ -1146,9 +1142,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 +1156,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) @@ -1175,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): @@ -1202,9 +1194,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) @@ -1268,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 @@ -1339,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 @@ -1393,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, @@ -1404,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 @@ -1467,9 +1457,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 +1483,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 +1504,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 +1519,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..110abad 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) ) @@ -130,23 +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}" - ) + 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_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..6a7c4c9 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 @@ -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_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..664d5b7 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 @@ -101,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 @@ -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 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"