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/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md index 71ef8f8..8de294e 100644 --- a/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md +++ b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md @@ -4,7 +4,7 @@ Thank you for contributing! Before you submit a pull request, please read the following. -Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://circuitpython.readthedocs.io/en/latest/docs/design_guide.html +Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://docs.circuitpython.org/en/latest/docs/design_guide.html If your changes are to documentation, please verify that the documentation builds locally by following the steps found here: https://adafru.it/build-docs diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 331b9e7..041a337 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -10,50 +10,5 @@ jobs: test: runs-on: ubuntu-latest steps: - - name: Dump GitHub context - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - run: echo "$GITHUB_CONTEXT" - - name: Translate Repo Name For Build Tools filename_prefix - id: repo-name - run: | - echo ::set-output name=repo-name::$( - echo ${{ github.repository }} | - awk -F '\/' '{ print tolower($2) }' | - tr '_' '-' - ) - - name: Set up Python 3.7 - uses: actions/setup-python@v1 - with: - python-version: 3.7 - - name: Versions - run: | - python3 --version - - name: Checkout Current Repo - uses: actions/checkout@v1 - with: - submodules: true - - name: Checkout tools repo - uses: actions/checkout@v2 - with: - repository: adafruit/actions-ci-circuitpython-libs - path: actions-ci - - name: Install dependencies - # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.) - run: | - source actions-ci/install.sh - - name: Pip install Sphinx, pre-commit - run: | - pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit - - name: Library version - run: git describe --dirty --always --tags - - name: Pre-commit hooks - run: | - pre-commit run --all-files - - name: Build assets - run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - - name: Build docs - working-directory: docs - run: sphinx-build -E -W -b html . _build/html - - name: Setup problem matchers - uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 + - name: Run Build CI workflow + uses: adafruit/workflows-circuitpython-libs/build@main diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index 6d0015a..0000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,85 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -name: Release Actions - -on: - release: - types: [published] - -jobs: - upload-release-assets: - runs-on: ubuntu-latest - steps: - - name: Dump GitHub context - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - run: echo "$GITHUB_CONTEXT" - - name: Translate Repo Name For Build Tools filename_prefix - id: repo-name - run: | - echo ::set-output name=repo-name::$( - echo ${{ github.repository }} | - awk -F '\/' '{ print tolower($2) }' | - tr '_' '-' - ) - - name: Set up Python 3.6 - uses: actions/setup-python@v1 - with: - python-version: 3.6 - - name: Versions - run: | - python3 --version - - name: Checkout Current Repo - uses: actions/checkout@v1 - with: - submodules: true - - name: Checkout tools repo - uses: actions/checkout@v2 - with: - repository: adafruit/actions-ci-circuitpython-libs - path: actions-ci - - name: Install deps - run: | - source actions-ci/install.sh - - name: Build assets - run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - - name: Upload Release Assets - # the 'official' actions version does not yet support dynamically - # supplying asset names to upload. @csexton's version chosen based on - # discussion in the issue below, as its the simplest to implement and - # allows for selecting files with a pattern. - # https://github.com/actions/upload-release-asset/issues/4 - #uses: actions/upload-release-asset@v1.0.1 - uses: csexton/release-asset-action@master - with: - pattern: "bundles/*" - github-token: ${{ secrets.GITHUB_TOKEN }} - - upload-pypi: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v1 - - name: Check For setup.py - id: need-pypi - run: | - echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) - - name: Set up Python - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - uses: actions/setup-python@v1 - with: - python-version: '3.x' - - name: Install dependencies - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - run: | - python -m pip install --upgrade pip - pip install setuptools wheel twine - - name: Build and publish - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - env: - TWINE_USERNAME: ${{ secrets.pypi_username }} - TWINE_PASSWORD: ${{ secrets.pypi_password }} - run: | - python setup.py sdist - twine upload dist/* diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml new file mode 100644 index 0000000..9acec60 --- /dev/null +++ b/.github/workflows/release_gh.yml @@ -0,0 +1,19 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: GitHub Release Actions + +on: + release: + types: [published] + +jobs: + upload-release-assets: + runs-on: ubuntu-latest + steps: + - name: Run GitHub Release CI workflow + uses: adafruit/workflows-circuitpython-libs/release-gh@main + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + upload-url: ${{ github.event.release.upload_url }} diff --git a/.github/workflows/release_pypi.yml b/.github/workflows/release_pypi.yml new file mode 100644 index 0000000..65775b7 --- /dev/null +++ b/.github/workflows/release_pypi.yml @@ -0,0 +1,19 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: PyPI Release Actions + +on: + release: + types: [published] + +jobs: + upload-release-assets: + runs-on: ubuntu-latest + steps: + - name: Run PyPI Release CI workflow + uses: adafruit/workflows-circuitpython-libs/release-pypi@main + with: + pypi-username: ${{ secrets.pypi_username }} + pypi-password: ${{ secrets.pypi_password }} diff --git a/.gitignore b/.gitignore index 2c6ddfd..db3d538 100644 --- a/.gitignore +++ b/.gitignore @@ -1,18 +1,48 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Kattni Rembor, written for Adafruit Industries # -# SPDX-License-Identifier: Unlicense +# SPDX-License-Identifier: MIT +# Do not include files and directories created by your personal work environment, such as the IDE +# you use, except for those already listed here. Pull requests including changes to this file will +# not be accepted. + +# This .gitignore file contains rules for files generated by working with CircuitPython libraries, +# including building Sphinx, testing with pip, and creating a virual environment, as well as the +# MacOS and IDE-specific files generated by using MacOS in general, or the PyCharm or VSCode IDEs. + +# If you find that there are files being generated on your machine that should not be included in +# your git commit, you should create a .gitignore_global file on your computer to include the +# files created by your personal setup. To do so, follow the two steps below. + +# First, create a file called .gitignore_global somewhere convenient for you, and add rules for +# the files you want to exclude from git commits. + +# Second, configure Git to use the exclude file for all Git repositories by running the +# following via commandline, replacing "path/to/your/" with the actual path to your newly created +# .gitignore_global file: +# git config --global core.excludesfile path/to/your/.gitignore_global + +# CircuitPython-specific files *.mpy -.idea + +# Python-specific files __pycache__ -_build *.pyc + +# Sphinx build-specific files +_build + +# This file results from running `pip -e install .` in a local repository +*.egg-info + +# Virtual environment-specific files .env -.python-version -build*/ -bundles +.venv + +# MacOS-specific files *.DS_Store -.eggs -dist -**/*.egg-info + +# IDE-specific files +.idea .vscode +*~ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 1b9fadc..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: 20.8b1 + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.5.0 hooks: - - id: black -- repo: https://github.com/fsfe/reuse-tool - rev: v0.12.1 + - id: check-yaml + - id: end-of-file-fixer + - id: trailing-whitespace + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.3.4 hooks: - - id: reuse -- repo: https://github.com/pre-commit/pre-commit-hooks - rev: v2.3.0 + - id: ruff-format + - id: ruff + args: ["--fix"] + - repo: https://github.com/fsfe/reuse-tool + rev: v3.0.1 hooks: - - id: check-yaml - - id: end-of-file-fixer - - id: trailing-whitespace -- repo: https://github.com/pycqa/pylint - rev: v2.11.1 - 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: reuse diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index bd3976d..0000000 --- a/.pylintrc +++ /dev/null @@ -1,436 +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 blacklist. They should be base names, not -# paths. -ignore=CVS - -# Add files or directories matching the regex patterns to the blacklist. 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= - -# 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,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call -disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation,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 - -# List of optional constructs for which whitespace checking is disabled. `dict- -# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. -# `trailing-comma` allows a space between comma and closing bracket: (a, ). -# `empty-line` allows space-only lines. -no-space-check=trailing-comma,dict-separator - -# 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=4 - - -[BASIC] - -# Naming hint for argument names -argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct argument names -argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Naming hint for attribute names -attr-name-hint=(([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 - -# Naming hint for class attribute names -class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Regular expression matching correct class attribute names -class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Naming hint for class names -# class-name-hint=[A-Z_][a-zA-Z0-9]+$ -class-name-hint=[A-Z_][a-zA-Z0-9_]+$ - -# Regular expression matching correct class names -# class-rgx=[A-Z_][a-zA-Z0-9]+$ -class-rgx=[A-Z_][a-zA-Z0-9_]+$ - -# Naming hint for constant names -const-name-hint=(([A-Z_][A-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 - -# Naming hint for function names -function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# 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 - -# Naming hint for inline iteration names -inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ - -# Regular expression matching correct inline iteration names -inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ - -# Naming hint for method names -method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct method names -method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Naming hint for module names -module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-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 - -# Naming hint for variable names -variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# 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=Exception diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..88bca9f --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,22 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +sphinx: + configuration: docs/conf.py + +build: + os: ubuntu-20.04 + tools: + python: "3" + +python: + install: + - requirements: docs/requirements.txt + - requirements: requirements.txt diff --git a/.readthedocs.yml b/.readthedocs.yml deleted file mode 100644 index 338427a..0000000 --- a/.readthedocs.yml +++ /dev/null @@ -1,7 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -python: - version: 3 -requirements_file: docs/requirements.txt diff --git a/README.rst b/README.rst index 315066e..9aed05e 100644 --- a/README.rst +++ b/README.rst @@ -2,10 +2,10 @@ Introduction ============ .. image:: https://readthedocs.org/projects/adafruit-circuitpython-as7341/badge/?version=latest - :target: https://circuitpython.readthedocs.io/projects/as7341/en/latest/ + :target: https://docs.circuitpython.org/projects/as7341/en/latest/ :alt: Documentation Status -.. image:: https://img.shields.io/discord/327254708534116352.svg +.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg :target: https://adafru.it/discord :alt: Discord @@ -13,9 +13,9 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_AS7341/actions :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 library for use with the Adafruit AS7341 breakout. **NOTE**: Due to the size of this library, it may not work on M0 (ex: Trinket M0) and other @@ -55,8 +55,8 @@ To install in a virtual environment in your current project: .. code-block:: shell mkdir project-name && cd project-name - python3 -m venv .env - source .env/bin/activate + python3 -m venv .venv + source .venv/bin/activate pip3 install adafruit-circuitpython-as7341 Usage Example @@ -95,7 +95,9 @@ Usage Example Documentation ============= -API documentation for this library can be found on `Read the Docs `_. +API documentation for this library can be found on `Read the Docs `_. + +For information on building library documentation, please check out `this guide `_. Contributing ============ @@ -103,8 +105,3 @@ Contributing Contributions are welcome! Please read our `Code of Conduct `_ before contributing to help this project stay welcoming. - -Documentation -============= - -For information on building library documentation, please check out `this guide `_. diff --git a/adafruit_as7341.py b/adafruit_as7341.py index 28cc57b..9b4e489 100644 --- a/adafruit_as7341.py +++ b/adafruit_as7341.py @@ -32,80 +32,92 @@ """ -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_AS7341.git" -from time import sleep, monotonic -from micropython import const -from adafruit_bus_device import i2c_device +from time import monotonic, sleep -from adafruit_register.i2c_struct import UnaryStruct, Struct # , ROUnaryStruct +from adafruit_bus_device import i2c_device from adafruit_register.i2c_bit import RWBit from adafruit_register.i2c_bits import ROBits, RWBits +from adafruit_register.i2c_struct import Struct, UnaryStruct # , ROUnaryStruct +from micropython import const + +try: + from typing import Any, Callable, Optional, Tuple, TypeVar + + # Only needed for typing + import busio -_AS7341_DEVICE_ID = const(0b001001) # Correct content of WHO_AM_I register -_AS7341_I2CADDR_DEFAULT = const(0x39) # AS7341 default i2c address -_AS7341_CHIP_ID = const(0x09) # AS7341 default device id from WHOAMI -_AS7341_WHOAMI = const(0x92) # Chip ID register -_AS7341_CONFIG = const(0x70) # Enables LED control and sets light sensing mode -_AS7341_GPIO = const(0x73) # Connects photo diode to GPIO or INT pins -_AS7341_LED = const(0x74) # LED Register; Enables and sets current limit -_AS7341_ENABLE = const( + TCallable = TypeVar("TCallable", bound=Callable[..., Any]) + +except ImportError: + pass + +# Correct content of WHO_AM_I register +_AS7341_DEVICE_ID: int = const(0b001001) +_AS7341_I2CADDR_DEFAULT: int = const(0x39) # AS7341 default i2c address +_AS7341_CHIP_ID: int = const(0x09) # AS7341 default device id from WHOAMI +_AS7341_WHOAMI: int = const(0x92) # Chip ID register +# Enables LED control and sets light sensing mode +_AS7341_CONFIG: int = const(0x70) +_AS7341_GPIO: int = const(0x73) # Connects photo diode to GPIO or INT pins +_AS7341_LED: int = const(0x74) # LED Register; Enables and sets current limit +_AS7341_ENABLE: int = const( 0x80 -) # Main enable register. Controls SMUX, Flicker Detection,Spectral and Power -_AS7341_ATIME = const(0x81) # Sets ADC integration step count -_AS7341_SP_LOW_TH_L = const(0x84) # Spectral measurement Low Threshold low byte -_AS7341_SP_LOW_TH_H = const(0x85) # 0 Spectral measurement Low Threshold high byte -_AS7341_SP_HIGH_TH_L = const(0x86) # Spectral measurement High Threshold low byte -_AS7341_SP_HIGH_TH_H = const(0x87) # Spectral measurement High Threshold low byte -_AS7341_STATUS = const( +) # Main enable register. Controls SMUX, Flicker Detection,Spectral and +# Power +_AS7341_ATIME: int = const(0x81) # Sets ADC integration step count +# Spectral measurement Low Threshold low byte +_AS7341_SP_LOW_TH_L: int = const(0x84) +# 0 Spectral measurement Low Threshold high byte +_AS7341_SP_LOW_TH_H: int = const(0x85) +# Spectral measurement High Threshold low byte +_AS7341_SP_HIGH_TH_L: int = const(0x86) +# Spectral measurement High Threshold low byte +_AS7341_SP_HIGH_TH_H: int = const(0x87) +_AS7341_STATUS: int = const( 0x93 ) # Interrupt status registers. Indicates the occourance of an interrupt -_AS7341_ASTATUS = const( +_AS7341_ASTATUS: int = const( 0x94 ) # Spectral Saturation and Gain status. Reading from here latches the data -_AS7341_CH0_DATA_L = const(0x95) # ADC Channel 0 Data -_AS7341_CH0_DATA_H = const(0x96) # ADC Channel 0 Data -_AS7341_CH1_DATA_L = const(0x97) # ADC Channel 1 Data -_AS7341_CH1_DATA_H = const(0x98) # ADC Channel 1 Data -_AS7341_CH2_DATA_L = const(0x99) # ADC Channel 2 Data -_AS7341_CH2_DATA_H = const(0x9A) # ADC Channel 2 Data -_AS7341_CH3_DATA_L = const(0x9B) # ADC Channel 3 Data -_AS7341_CH3_DATA_H = const(0x9C) # ADC Channel 3 Data -_AS7341_CH4_DATA_L = const(0x9D) # ADC Channel 4 Data -_AS7341_CH4_DATA_H = const(0x9E) # ADC Channel 4 Data -_AS7341_CH5_DATA_L = const(0x9F) # ADC Channel 5 Data -_AS7341_CH5_DATA_H = const(0xA0) # ADC Channel 5 Data -_AS7341_STATUS2 = const(0xA3) # Measurement status flags; saturation, validity -_AS7341_STATUS3 = const(0xA4) # Spectral interrupt source, high or low threshold -_AS7341_CFG0 = const( - 0xA9 -) # Sets Low power mode, Register bank, and Trigger lengthening -_AS7341_CFG1 = const(0xAA) # Controls ADC Gain -_AS7341_CFG6 = const(0xAF) # Used to configure Smux -_AS7341_CFG9 = const(0xB2) # flicker detect and SMUX command system ints -_AS7341_CFG12 = const(0xB5) # ADC channel for interrupts, persistence and auto-gain -_AS7341_PERS = const( - 0xBD -) # number of measurements outside thresholds to trigger an interrupt -_AS7341_GPIO2 = const( - 0xBE -) # GPIO Settings and status: polarity, direction, sets output, reads -_AS7341_ASTEP_L = const(0xCA) # Integration step size ow byte -_AS7341_ASTEP_H = const(0xCB) # Integration step size high byte -_AS7341_FD_TIME1 = const(0xD8) # Flicker detection integration time low byte -_AS7341_FD_TIME2 = const(0xDA) # Flicker detection gain and high nibble -_AS7341_FD_STATUS = const( +_AS7341_CH0_DATA_L: int = const(0x95) # ADC Channel 0 Data +_AS7341_CH0_DATA_H: int = const(0x96) # ADC Channel 0 Data +_AS7341_CH1_DATA_L: int = const(0x97) # ADC Channel 1 Data +_AS7341_CH1_DATA_H: int = const(0x98) # ADC Channel 1 Data +_AS7341_CH2_DATA_L: int = const(0x99) # ADC Channel 2 Data +_AS7341_CH2_DATA_H: int = const(0x9A) # ADC Channel 2 Data +_AS7341_CH3_DATA_L: int = const(0x9B) # ADC Channel 3 Data +_AS7341_CH3_DATA_H: int = const(0x9C) # ADC Channel 3 Data +_AS7341_CH4_DATA_L: int = const(0x9D) # ADC Channel 4 Data +_AS7341_CH4_DATA_H: int = const(0x9E) # ADC Channel 4 Data +_AS7341_CH5_DATA_L: int = const(0x9F) # ADC Channel 5 Data +_AS7341_CH5_DATA_H: int = const(0xA0) # ADC Channel 5 Data +_AS7341_STATUS2: int = const(0xA3) # Measurement status flags; saturation, validity +_AS7341_STATUS3: int = const(0xA4) # Spectral interrupt source, high or low threshold +_AS7341_CFG0: int = const(0xA9) # Sets Low power mode, Register bank, and Trigger lengthening +_AS7341_CFG1: int = const(0xAA) # Controls ADC Gain +_AS7341_CFG6: int = const(0xAF) # Used to configure Smux +_AS7341_CFG9: int = const(0xB2) # flicker detect and SMUX command system ints +_AS7341_CFG12: int = const(0xB5) # ADC channel for interrupts, persistence and auto-gain +_AS7341_PERS = const(0xBD) # number of measurements outside thresholds to trigger an interrupt +_AS7341_GPIO2 = const(0xBE) # GPIO Settings and status: polarity, direction, sets output, reads +_AS7341_ASTEP_L: int = const(0xCA) # Integration step size ow byte +_AS7341_ASTEP_H: int = const(0xCB) # Integration step size high byte +_AS7341_FD_TIME1: int = const(0xD8) # Flicker detection integration time low byte +_AS7341_FD_TIME2: int = const(0xDA) # Flicker detection gain and high nibble +_AS7341_FD_STATUS: int = const( 0xDB ) # Flicker detection status; measurement valid, saturation, flicker -_AS7341_INTENAB = const(0xF9) # Enables individual interrupt types -_AS7341_CONTROL = const(0xFA) # Auto-zero, fifo clear, clear SAI active -_AS7341_FD_CFG0 = const(0xD7) # Enables FIFO for flicker detection +_AS7341_INTENAB: int = const(0xF9) # Enables individual interrupt types +_AS7341_CONTROL: int = const(0xFA) # Auto-zero, fifo clear, clear SAI active +_AS7341_FD_CFG0: int = const(0xD7) # Enables FIFO for flicker detection -def _low_bank(func): +def _low_bank(func: Any) -> Any: # pylint:disable=protected-access - def _decorator(self, *args, **kwargs): + def _decorator(self, *args, **kwargs) -> Any: self._low_bank_active = True retval = func(self, *args, **kwargs) self._low_bank_active = False @@ -118,7 +130,10 @@ class CV: """struct helper""" @classmethod - def add_values(cls, value_tuples): + def add_values( + cls, + value_tuples: Tuple[str, int, int, Optional[float]], + ) -> None: """Add CV values to the class""" cls.string = {} cls.lsb = {} @@ -130,7 +145,7 @@ def add_values(cls, value_tuples): cls.lsb[value] = lsb @classmethod - def is_valid(cls, value): + def is_valid(cls, value: str) -> bool: """Validate that a given value is a member""" return value in cls.string @@ -138,16 +153,42 @@ def is_valid(cls, value): # class Flicker(CV): # """Options for ``flicker_detection_type``""" -# pass # pylint: disable=unnecessary-pass +# pass # Flicker.add_values((("FLICKER_100HZ", 0, 100, None), ("FLICKER_1000HZ", 1, 1000, None))) class Gain(CV): - """Options for ``accelerometer_range``""" + """Options for ``accelerometer_range`` + + +-------------------------------+-------------------------+ + | Setting | Gain Value | + +===============================+=========================+ + | :py:const:`Gain.GAIN_0_5X` | 0.5 | + +-------------------------------+-------------------------+ + | :py:const:`Gain.GAIN_1X` | 1 | + +-------------------------------+-------------------------+ + | :py:const:`Gain.GAIN_2X` | 2 | + +-------------------------------+-------------------------+ + | :py:const:`Gain.GAIN_4X` | 4 | + +-------------------------------+-------------------------+ + | :py:const:`Gain.GAIN_8X` | 8 | + +-------------------------------+-------------------------+ + | :py:const:`Gain.GAIN_16X` | 16 | + +-------------------------------+-------------------------+ + | :py:const:`Gain.GAIN_32X` | 32 | + +-------------------------------+-------------------------+ + | :py:const:`Gain.GAIN_64X` | 64 | + +-------------------------------+-------------------------+ + | :py:const:`Gain.GAIN_128X` | 128 | + +-------------------------------+-------------------------+ + | :py:const:`Gain.GAIN_256X` | 256 | + +-------------------------------+-------------------------+ + | :py:const:`Gain.GAIN_512X` | 512 | + +-------------------------------+-------------------------+ - pass # pylint: disable=unnecessary-pass + """ Gain.add_values( @@ -170,8 +211,6 @@ class Gain(CV): class SMUX_OUT(CV): """Options for ``smux_out``""" - pass # pylint: disable=unnecessary-pass - SMUX_OUT.add_values( ( @@ -189,8 +228,6 @@ class SMUX_OUT(CV): class SMUX_IN(CV): """Options for ``smux_in``""" - pass # pylint: disable=unnecessary-pass - SMUX_IN.add_values( ( @@ -246,58 +283,65 @@ class AS7341: # pylint:disable=too-many-instance-attributes, no-member .. code-block:: python - channel_415nm = channel_415nm - channel_445nm = channel_445nm - channel_480nm = channel_480nm - channel_515nm = channel_515nm - channel_555nm = channel_555nm - channel_590nm = channel_590nm - channel_630nm = channel_630nm - channel_680nm = channel_680nm + channel_415nm = sensor.channel_415nm + channel_445nm = sensor.channel_445nm + channel_480nm = sensor.channel_480nm + channel_515nm = sensor.channel_515nm + channel_555nm = sensor.channel_555nm + channel_590nm = sensor.channel_590nm + channel_630nm = sensor.channel_630nm + channel_680nm = sensor.channel_680nm """ - _device_id = ROBits(6, _AS7341_WHOAMI, 2) + _device_id: ROBits = ROBits(6, _AS7341_WHOAMI, 2) - _smux_enable_bit = RWBit(_AS7341_ENABLE, 4) - _led_control_enable_bit = RWBit(_AS7341_CONFIG, 3) - _color_meas_enabled = RWBit(_AS7341_ENABLE, 1) - _power_enabled = RWBit(_AS7341_ENABLE, 0) + _smux_enable_bit: RWBit = RWBit(_AS7341_ENABLE, 4) + _led_control_enable_bit: RWBit = RWBit(_AS7341_CONFIG, 3) + _color_meas_enabled: RWBit = RWBit(_AS7341_ENABLE, 1) + _power_enabled: RWBit = RWBit(_AS7341_ENABLE, 0) - _low_bank_active = RWBit(_AS7341_CFG0, 4) - _smux_command = RWBits(2, _AS7341_CFG6, 3) - _fd_status = UnaryStruct(_AS7341_FD_STATUS, " None: self.i2c_device = i2c_device.I2CDevice(i2c_bus, address) - if not self._device_id in [_AS7341_DEVICE_ID]: + if self._device_id not in {_AS7341_DEVICE_ID}: raise RuntimeError("Failed to find an AS7341 sensor - check your wiring!") self.initialize() self._buffer = bytearray(2) @@ -305,7 +349,7 @@ def __init__(self, i2c_bus, address=_AS7341_I2CADDR_DEFAULT): self._high_channels_configured = False self._flicker_detection_1k_configured = False - def initialize(self): + def initialize(self) -> None: """Configure the sensors with the default settings""" self._power_enabled = True @@ -315,7 +359,7 @@ def initialize(self): self.gain = Gain.GAIN_128X # pylint:disable=no-member @property - def all_channels(self): + def all_channels(self) -> Tuple[int, ...]: """The current readings for all six ADC channels""" self._configure_f1_f4() @@ -329,66 +373,66 @@ def all_channels(self): return reads @property - def channel_415nm(self): + def channel_415nm(self) -> int: """The current reading for the 415nm band""" self._configure_f1_f4() return self._channel_0_data @property - def channel_445nm(self): + def channel_445nm(self) -> int: """The current reading for the 445nm band""" self._configure_f1_f4() return self._channel_1_data @property - def channel_480nm(self): + def channel_480nm(self) -> int: """The current reading for the 480nm band""" self._configure_f1_f4() return self._channel_2_data @property - def channel_515nm(self): + def channel_515nm(self) -> int: """The current reading for the 515nm band""" self._configure_f1_f4() return self._channel_3_data @property - def channel_555nm(self): + def channel_555nm(self) -> int: """The current reading for the 555nm band""" self._configure_f5_f8() return self._channel_0_data @property - def channel_590nm(self): + def channel_590nm(self) -> int: """The current reading for the 590nm band""" self._configure_f5_f8() return self._channel_1_data @property - def channel_630nm(self): + def channel_630nm(self) -> int: """The current reading for the 630nm band""" self._configure_f5_f8() return self._channel_2_data @property - def channel_680nm(self): + def channel_680nm(self) -> int: """The current reading for the 680nm band""" self._configure_f5_f8() return self._channel_3_data @property - def channel_clear(self): + def channel_clear(self) -> int: """The current reading for the clear sensor""" - self._configure_f5_f8() + _ = self._all_channels return self._channel_4_data @property - def channel_nir(self): + def channel_nir(self) -> int: """The current reading for the NIR (near-IR) sensor""" - self._configure_f5_f8() + _ = self._all_channels return self._channel_5_data - def _wait_for_data(self, timeout=1.0): + def _wait_for_data(self, timeout: float = 1.0) -> None: """Wait for sensor data to be ready""" start = monotonic() while not self._data_ready_bit: @@ -396,18 +440,18 @@ def _wait_for_data(self, timeout=1.0): raise RuntimeError("Timeout occurred waiting for sensor data") sleep(0.001) - def _write_register(self, addr, data): - + def _write_register(self, addr: int, data: int) -> None: self._buffer[0] = addr self._buffer[1] = data with self.i2c_device as i2c: i2c.write(self._buffer) - def _configure_f1_f4(self): + def _configure_f1_f4(self) -> None: """Configure the sensor to read from elements F1-F4, Clear, and NIR""" # disable SP_EN bit while making config changes if self._low_channels_configured: + _ = self._all_channels return self._high_channels_configured = False self._flicker_detection_1k_configured = False @@ -427,10 +471,11 @@ def _configure_f1_f4(self): self._low_channels_configured = True self._wait_for_data() - def _configure_f5_f8(self): + def _configure_f5_f8(self) -> None: """Configure the sensor to read from elements F5-F8, Clear, and NIR""" # disable SP_EN bit while making config changes if self._high_channels_configured: + _ = self._all_channels return self._low_channels_configured = False @@ -452,12 +497,10 @@ def _configure_f5_f8(self): self._wait_for_data() @property - def flicker_detected(self): + def flicker_detected(self) -> Optional[int]: """The flicker frequency detected in Hertz""" if not self._flicker_detection_1k_configured: - AttributeError( - "Flicker detection must be enabled to access `flicker_detected`" - ) + raise AttributeError("Flicker detection must be enabled to access `flicker_detected`") flicker_status = self._fd_status if flicker_status == 45: @@ -468,20 +511,20 @@ def flicker_detected(self): # if we haven't returned yet either there was an error or an unknown frequency was detected @property - def flicker_detection_enabled(self): + def flicker_detection_enabled(self) -> bool: """The flicker detection status of the sensor. True if the sensor is configured\ to detect flickers. Currently only 1000Hz and 1200Hz flicker detection is supported """ return self._flicker_detection_1k_configured @flicker_detection_enabled.setter - def flicker_detection_enabled(self, flicker_enable): + def flicker_detection_enabled(self, flicker_enable: bool) -> None: if flicker_enable: self._configure_1k_flicker_detection() else: self._configure_f1_f4() # sane default - def _f1f4_clear_nir(self): + def _f1f4_clear_nir(self) -> None: """Configure SMUX for sensors F1-F4, Clear and NIR""" self._set_smux(SMUX_IN.NC_F3L, SMUX_OUT.DISABLED, SMUX_OUT.ADC2) self._set_smux(SMUX_IN.F1L_NC, SMUX_OUT.ADC0, SMUX_OUT.DISABLED) @@ -504,7 +547,7 @@ def _f1f4_clear_nir(self): self._set_smux(SMUX_IN.NC_DARK, SMUX_OUT.DISABLED, SMUX_OUT.DISABLED) self._set_smux(SMUX_IN.NIR_F, SMUX_OUT.ADC5, SMUX_OUT.DISABLED) - def _f5f8_clear_nir(self): + def _f5f8_clear_nir(self) -> None: # SMUX Config for F5,F6,F7,F8,NIR,Clear self._set_smux(SMUX_IN.NC_F3L, SMUX_OUT.DISABLED, SMUX_OUT.DISABLED) self._set_smux(SMUX_IN.F1L_NC, SMUX_OUT.DISABLED, SMUX_OUT.DISABLED) @@ -528,7 +571,7 @@ def _f5f8_clear_nir(self): self._set_smux(SMUX_IN.NIR_F, SMUX_OUT.ADC5, SMUX_OUT.DISABLED) # TODO: Convert as much of this as possible to properties or named attributes - def _configure_1k_flicker_detection(self): + def _configure_1k_flicker_detection(self) -> None: self._low_channels_configured = False self._high_channels_configured = False @@ -603,7 +646,7 @@ def _configure_1k_flicker_detection(self): self._flicker_detection_1k_configured = True - def _smux_template(self): + def _smux_template(self) -> None: # SMUX_OUT.DISABLED # SMUX_OUT.ADC0 # SMUX_OUT.ADC1 @@ -632,7 +675,7 @@ def _smux_template(self): self._set_smux(SMUX_IN.NC_DARK, SMUX_OUT.DISABLED, SMUX_OUT.DISABLED) self._set_smux(SMUX_IN.NIR_F, SMUX_OUT.DISABLED, SMUX_OUT.DISABLED) - def _set_smux(self, smux_addr, smux_out1, smux_out2): + def _set_smux(self, smux_addr: int, smux_out1: int, smux_out2: int) -> None: """Connect a pair of sensors to an ADC channel""" low_nibble = smux_out1 high_nibble = smux_out2 << 4 @@ -640,22 +683,22 @@ def _set_smux(self, smux_addr, smux_out1, smux_out2): self._write_register(smux_addr, smux_byte) @property - def gain(self): + def gain(self) -> int: """The ADC gain multiplier. Must be a valid :meth:`adafruit_as7341.Gain`""" return self._gain @gain.setter - def gain(self, gain_value): + def gain(self, gain_value: str) -> None: if not Gain.is_valid(gain_value): raise AttributeError("`gain` must be a valid `adafruit_as7341.Gain`") self._gain = gain_value @property - def _smux_enabled(self): + def _smux_enabled(self) -> bool: return self._smux_enable_bit @_smux_enabled.setter - def _smux_enabled(self, enable_smux): + def _smux_enabled(self, enable_smux: bool): self._low_bank_active = False self._smux_enable_bit = enable_smux while self._smux_enable_bit is True: @@ -663,7 +706,7 @@ def _smux_enabled(self, enable_smux): @property @_low_bank - def led_current(self): + def led_current(self) -> int: """The maximum allowed current through the attached LED in milliamps. Odd numbered values will be rounded down to the next lowest even number due to the internal configuration restrictions""" @@ -672,27 +715,27 @@ def led_current(self): @led_current.setter @_low_bank - def led_current(self, led_curent): - new_current = int((min(258, max(4, led_curent)) - 4) / 2) + def led_current(self, led_current: int) -> None: + new_current = int((min(258, max(4, led_current)) - 4) / 2) self._led_current_bits = new_current @property @_low_bank - def led(self): + def led(self) -> bool: """The attached LED. Set to True to turn on, False to turn off""" return self._led_enabled @led.setter @_low_bank - def led(self, led_on): + def led(self, led_on: bool) -> None: self._led_enabled = led_on @property @_low_bank - def _led_control_enabled(self): + def _led_control_enabled(self) -> bool: return self._led_control_enable_bit @_led_control_enabled.setter @_low_bank - def _led_control_enabled(self, enabled): + def _led_control_enabled(self, enabled: bool) -> None: self._led_control_enable_bit = enabled diff --git a/docs/api.rst b/docs/api.rst index da202c1..e3ef55f 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,6 +4,9 @@ .. 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_as7341 :members: - :exclude-members: CV, Gain, SMUX_IN, SMUX_OUT + :exclude-members: CV, SMUX_IN, SMUX_OUT diff --git a/docs/conf.py b/docs/conf.py index f5b290d..61aead2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,9 +1,8 @@ -# -*- coding: utf-8 -*- - # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries # # SPDX-License-Identifier: MIT +import datetime import os import sys @@ -16,6 +15,7 @@ # ones. extensions = [ "sphinx.ext.autodoc", + "sphinxcontrib.jquery", "sphinx.ext.intersphinx", "sphinx.ext.napoleon", "sphinx.ext.todo", @@ -29,16 +29,16 @@ intersphinx_mapping = { - "python": ("https://docs.python.org/3.4", None), + "python": ("https://docs.python.org/3", None), "BusDevice": ( - "https://circuitpython.readthedocs.io/projects/busdevice/en/latest/", + "https://docs.circuitpython.org/projects/busdevice/en/latest/", None, ), "Register": ( - "https://circuitpython.readthedocs.io/projects/register/en/latest/", + "https://docs.circuitpython.org/projects/register/en/latest/", None, ), - "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None), + "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None), } # Add any paths that contain templates here, relative to this directory. @@ -51,7 +51,12 @@ # General information about the project. project = "Adafruit AS7341 Library" -copyright = "2020 Bryan Siepert" +creation_year = "2020" +current_year = str(datetime.datetime.now().year) +year_duration = ( + current_year if current_year == creation_year else creation_year + " - " + current_year +) +copyright = year_duration + " Bryan Siepert" author = "Bryan Siepert" # The version info for the project you're documenting, acts as replacement for @@ -68,7 +73,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -106,19 +111,9 @@ # 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" # 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, diff --git a/docs/examples.rst b/docs/examples.rst index 3129057..8fe8a59 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -33,3 +33,12 @@ Example in how to get all the channel readings at the same time .. literalinclude:: ../examples/as7341_batched_readings.py :caption: examples/as7341_batched_readings.py :linenos: + +DisplayIO Simpletest +--------------------- + +This is a simple test for boards with built-in display. + +.. literalinclude:: ../examples/as3741_displayio_simpletest.py + :caption: examples/as3741_displayio_simpletest.py + :linenos: diff --git a/docs/index.rst b/docs/index.rst index 7a174ee..c922948 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -33,8 +33,9 @@ Table of Contents .. toctree:: :caption: Other Links - Download - CircuitPython Reference Documentation + Download from GitHub + Download Library Bundle + CircuitPython Reference Documentation CircuitPython Support Forum Discord Chat Adafruit Learning System diff --git a/docs/requirements.txt b/docs/requirements.txt index 88e6733..979f568 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,4 +2,6 @@ # # SPDX-License-Identifier: Unlicense -sphinx>=4.0.0 +sphinx +sphinxcontrib-jquery +sphinx-rtd-theme diff --git a/examples/as3741_displayio_simpletest.py b/examples/as3741_displayio_simpletest.py new file mode 100644 index 0000000..122d2ad --- /dev/null +++ b/examples/as3741_displayio_simpletest.py @@ -0,0 +1,49 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# SPDX-FileCopyrightText: 2024 Jose D. Montoya +# +# SPDX-License-Identifier: MIT + +import time + +import board +from adafruit_display_text.bitmap_label import Label +from displayio import Group +from terminalio import FONT + +from adafruit_as7341 import AS7341 + +# Simple demo of using the built-in display. +# create a main_group to hold anything we want to show on the display. +main_group = Group() +# Initialize I2C bus and sensor. +i2c = board.I2C() # uses board.SCL and board.SDA +sensor = AS7341(i2c) +sensor.flicker_detection_enabled = True + +# Create Label(s) to show the readings. If you have a very small +# display you may need to change to scale=1. +display_output_label = Label(FONT, text="", scale=2) + +# place the label(s) in the middle of the screen with anchored positioning +display_output_label.anchor_point = (0, 0) +display_output_label.anchored_position = ( + 4, + board.DISPLAY.height // 2 - 60, +) + +# add the label(s) to the main_group +main_group.append(display_output_label) + +# set the main_group as the root_group of the built-in DISPLAY +board.DISPLAY.root_group = main_group + +# begin main loop +while True: + # update the text of the label(s) to show the sensor readings + flicker_detected = sensor.flicker_detected + if flicker_detected: + display_output_label.text = f"Detected a {flicker_detected} Hz flicker" + else: + display_output_label.text = "No flicker detected" + # wait for a bit + time.sleep(0.5) diff --git a/examples/as7341_batched_readings.py b/examples/as7341_batched_readings.py index c39c756..1c87cfb 100644 --- a/examples/as7341_batched_readings.py +++ b/examples/as7341_batched_readings.py @@ -1,10 +1,13 @@ # SPDX-FileCopyrightText: 2020 Bryan Siepert, written for Adafruit Industries # SPDX-License-Identifier: MIT from time import sleep + import board + from adafruit_as7341 import AS7341 i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller sensor = AS7341(i2c) diff --git a/examples/as7341_flicker_detection.py b/examples/as7341_flicker_detection.py index 5a9d1a8..458f27f 100644 --- a/examples/as7341_flicker_detection.py +++ b/examples/as7341_flicker_detection.py @@ -1,15 +1,17 @@ # SPDX-FileCopyrightText: 2020 Bryan Siepert, written for Adafruit Industries # SPDX-License-Identifier: MIT from time import sleep + import board + from adafruit_as7341 import AS7341 i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller sensor = AS7341(i2c) sensor.flicker_detection_enabled = True while True: - flicker_detected = sensor.flicker_detected if flicker_detected: print("Detected a %d Hz flicker" % flicker_detected) diff --git a/examples/as7341_led_test.py b/examples/as7341_led_test.py index 4e09a08..27ea766 100644 --- a/examples/as7341_led_test.py +++ b/examples/as7341_led_test.py @@ -2,10 +2,13 @@ # # SPDX-License-Identifier: MIT from time import sleep + import board + import adafruit_as7341 i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller sensor = adafruit_as7341.AS7341(i2c) print("out of init!") diff --git a/examples/as7341_simpletest.py b/examples/as7341_simpletest.py index 24847a3..a3d7c9a 100644 --- a/examples/as7341_simpletest.py +++ b/examples/as7341_simpletest.py @@ -1,10 +1,13 @@ # SPDX-FileCopyrightText: 2020 Bryan Siepert, written for Adafruit Industries # SPDX-License-Identifier: MIT from time import sleep + import board + from adafruit_as7341 import AS7341 i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller sensor = AS7341(i2c) @@ -14,7 +17,6 @@ def bar_graph(read_value): while True: - print("F1 - 415nm/Violet %s" % bar_graph(sensor.channel_415nm)) print("F2 - 445nm//Indigo %s" % bar_graph(sensor.channel_445nm)) print("F3 - 480nm//Blue %s" % bar_graph(sensor.channel_480nm)) diff --git a/optional_requirements.txt b/optional_requirements.txt new file mode 100644 index 0000000..d4e27c4 --- /dev/null +++ b/optional_requirements.txt @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense diff --git a/pyproject.toml b/pyproject.toml index f3c35ae..dc50e48 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,49 @@ -# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò +# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries # -# SPDX-License-Identifier: Unlicense +# SPDX-License-Identifier: MIT -[tool.black] -target-version = ['py35'] +[build-system] +requires = [ + "setuptools", + "wheel", + "setuptools-scm", +] + +[project] +name = "adafruit-circuitpython-as7341" +description = "CircuitPython library for use with the Adafruit AS7341 breakout" +version = "0.0.0+auto.0" +readme = "README.rst" +authors = [ + {name = "Adafruit Industries", email = "circuitpython@adafruit.com"} +] +urls = {Homepage = "https://github.com/adafruit/Adafruit_CircuitPython_AS7341"} +keywords = [ + "adafruit", + "blinka", + "circuitpython", + "micropython", + "as7341", + "Spectral", + "sensor", + "multi-channel", + "mux", + "calibration", +] +license = {text = "MIT"} +classifiers = [ + "Intended Audience :: Developers", + "Topic :: Software Development :: Libraries", + "Topic :: Software Development :: Embedded Systems", + "Topic :: System :: Hardware", + "License :: OSI Approved :: MIT License", + "Programming Language :: Python :: 3", +] +dynamic = ["dependencies", "optional-dependencies"] + +[tool.setuptools] +py-modules = ["adafruit_as7341"] + +[tool.setuptools.dynamic] +dependencies = {file = ["requirements.txt"]} +optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} diff --git a/requirements.txt b/requirements.txt index cc92861..995c612 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,8 +1,7 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# SPDX-FileCopyrightText: Copyright (c) 2020 Bryan Siepert for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries # -# SPDX-License-Identifier: MIT +# SPDX-License-Identifier: Unlicense -Adafruit-Blinka -adafruit-circuitpython-busdevice +Adafruit-Blinka>=7.0.0 adafruit-circuitpython-register +adafruit-circuitpython-busdevice 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" diff --git a/setup.py b/setup.py deleted file mode 100644 index d6888c4..0000000 --- a/setup.py +++ /dev/null @@ -1,63 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# SPDX-FileCopyrightText: Copyright (c) 2020 Bryan Siepert for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -"""A setuptools based setup module. - -See: -https://packaging.python.org/en/latest/distributing.html -https://github.com/pypa/sampleproject -""" - -from setuptools import setup, find_packages - -# To use a consistent encoding -from codecs import open -from os import path - -here = path.abspath(path.dirname(__file__)) - -# Get the long description from the README file -with open(path.join(here, "README.rst"), encoding="utf-8") as f: - long_description = f.read() - -setup( - name="adafruit-circuitpython-as7341", - use_scm_version=True, - setup_requires=["setuptools_scm"], - description="CircuitPython library for use with the Adafruit AS7341 breakout", - long_description=long_description, - long_description_content_type="text/x-rst", - # The project's main homepage. - url="https://github.com/adafruit/Adafruit_CircuitPython_AS7341", - # Author details - author="Adafruit Industries", - author_email="circuitpython@adafruit.com", - install_requires=[ - "Adafruit-Blinka", - "adafruit-circuitpython-busdevice", - "adafruit-circuitpython-register", - ], - # Choose your license - license="MIT", - # See https://pypi.python.org/pypi?%3Aaction=list_classifiers - classifiers=[ - "Development Status :: 3 - Alpha", - "Intended Audience :: Developers", - "Topic :: Software Development :: Libraries", - "Topic :: System :: Hardware", - "License :: OSI Approved :: MIT License", - "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.4", - "Programming Language :: Python :: 3.5", - ], - # What does your project relate to? - keywords="adafruit blinka circuitpython micropython as7341 Spectral sensor multi-channel " - "mux calibration", - # You can just specify the packages manually here if your project is - # simple. Or you can use find_packages(). - # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER, - # CHANGE `py_modules=['...']` TO `packages=['...']` - py_modules=["adafruit_as7341"], -)