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 ca35544..041a337 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -10,66 +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: Archive bundles - uses: actions/upload-artifact@v2 - with: - name: bundles - path: ${{ github.workspace }}/bundles/ - - name: Build docs - working-directory: docs - run: sphinx-build -E -W -b html . _build/html - - name: Check For setup.py - id: need-pypi - run: | - echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) - - name: Build Python package - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - run: | - pip install --upgrade setuptools wheel twine readme_renderer testresources - python setup.py sdist - python setup.py bdist_wheel --universal - twine check dist/* - - 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 9647e71..db3d538 100644 --- a/.gitignore +++ b/.gitignore @@ -1,15 +1,48 @@ -# SPDX-FileCopyrightText: 2021 ladyada 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 -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 cfd1c41..0000000 --- a/.pylintrc +++ /dev/null @@ -1,436 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada 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..255dafd --- /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-lts-latest + 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 49dcab3..0000000 --- a/.readthedocs.yml +++ /dev/null @@ -1,7 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -python: - version: 3 -requirements_file: docs/requirements.txt diff --git a/README.rst b/README.rst index 1c7aa04..cddc190 100644 --- a/README.rst +++ b/README.rst @@ -3,10 +3,10 @@ Introduction ============ .. image:: https://readthedocs.org/projects/adafruit-circuitpython-vl6180x/badge/?version=latest - :target: https://circuitpython.readthedocs.io/projects/vl6180x/en/latest/ + :target: https://docs.circuitpython.org/projects/vl6180x/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 @@ -14,6 +14,10 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_VL6180X/actions/ :alt: Build Status +.. 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 module for the VL6180X distance sensor. See examples/vl6180x_simpletest.py for a demo of the usage. @@ -49,8 +53,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-vl6180x Usage Example @@ -61,7 +65,9 @@ See examples/vl6180x_simpletest.py for a demo of the usage. 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 ============ @@ -69,8 +75,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_vl6180x.py b/adafruit_vl6180x.py index 49aab78..d11623e 100644 --- a/adafruit_vl6180x.py +++ b/adafruit_vl6180x.py @@ -9,7 +9,7 @@ CircuitPython module for the VL6180X distance sensor. See examples/simpletest.py for a demo of the usage. -* Author(s): Tony DiCola +* Author(s): Tony DiCola, Jonas Schatz Implementation Notes -------------------- @@ -25,30 +25,49 @@ https://github.com/adafruit/circuitpython/releases * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice """ -from micropython import const + +import struct +import time from adafruit_bus_device import i2c_device +from micropython import const +try: + from typing import List, Optional -__version__ = "0.0.0-auto.0" -__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_VL6180X.git" + from busio import I2C +except ImportError: + pass -# Internal constants: -_VL6180X_DEFAULT_I2C_ADDR = const(0x29) +__version__ = "0.0.0+auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_VL6180X.git" + +# Registers _VL6180X_REG_IDENTIFICATION_MODEL_ID = const(0x000) + +_VL6180X_REG_SYSTEM_HISTORY_CTRL = const(0x012) _VL6180X_REG_SYSTEM_INTERRUPT_CONFIG = const(0x014) _VL6180X_REG_SYSTEM_INTERRUPT_CLEAR = const(0x015) _VL6180X_REG_SYSTEM_FRESH_OUT_OF_RESET = const(0x016) + _VL6180X_REG_SYSRANGE_START = const(0x018) +_VL6180X_REG_SYSRANGE_INTERMEASUREMENT_PERIOD = const(0x01B) +_VL6180X_REG_SYSRANGE_PART_TO_PART_RANGE_OFFSET = const(0x024) + _VL6180X_REG_SYSALS_START = const(0x038) _VL6180X_REG_SYSALS_ANALOGUE_GAIN = const(0x03F) _VL6180X_REG_SYSALS_INTEGRATION_PERIOD_HI = const(0x040) _VL6180X_REG_SYSALS_INTEGRATION_PERIOD_LO = const(0x041) -_VL6180X_REG_RESULT_ALS_VAL = const(0x050) -_VL6180X_REG_RESULT_RANGE_VAL = const(0x062) + _VL6180X_REG_RESULT_RANGE_STATUS = const(0x04D) _VL6180X_REG_RESULT_INTERRUPT_STATUS_GPIO = const(0x04F) +_VL6180X_REG_RESULT_ALS_VAL = const(0x050) +_VL6180X_REG_RESULT_HISTORY_BUFFER_0 = const(0x052) +_VL6180X_REG_RESULT_RANGE_VAL = const(0x062) + +# Internal constants: +_VL6180X_DEFAULT_I2C_ADDR = const(0x29) # User-facing constants: ALS_GAIN_1 = const(0x06) @@ -74,52 +93,157 @@ class VL6180X: - """Create an instance of the VL6180X distance sensor. You must pass in + """Create an instance of the VL6180X distance sensor. You must pass in the following parameters: - :param i2c: An instance of the I2C bus connected to the sensor. + :param ~I2C i2c: An instance of the I2C bus connected to the sensor. Optionally you can specify: - :param address: The I2C address of the sensor. If not specified the sensor's + :param int address: The I2C address of the sensor. If not specified the sensor's default value will be assumed. + :param int offset: The offset to be applied to measurements, in mm """ - def __init__(self, i2c, address=_VL6180X_DEFAULT_I2C_ADDR): + def __init__(self, i2c: I2C, address: int = _VL6180X_DEFAULT_I2C_ADDR, offset: int = 0) -> None: self._device = i2c_device.I2CDevice(i2c, address) if self._read_8(_VL6180X_REG_IDENTIFICATION_MODEL_ID) != 0xB4: raise RuntimeError("Could not find VL6180X, is it connected and powered?") self._load_settings() self._write_8(_VL6180X_REG_SYSTEM_FRESH_OUT_OF_RESET, 0x00) + self.offset = offset + + # Reset a sensor that crashed while in continuous mode + if self.continuous_mode_enabled: + self.stop_range_continuous() + time.sleep(0.1) + + # Activate history buffer for range measurement + self._write_8(_VL6180X_REG_SYSTEM_HISTORY_CTRL, 0x01) @property - def range(self): + def range(self) -> int: """Read the range of an object in front of sensor and return it in mm.""" - # wait for device to be ready for range measurement + if self.continuous_mode_enabled: + return self._read_range_continuous() + return self._read_range_single() + + @property + def range_from_history(self) -> Optional[int]: + """Read the latest range data from history + To do so, you don't have to wait for a complete measurement.""" + + if not self.range_history_enabled: + return None + + return self._read_8(_VL6180X_REG_RESULT_HISTORY_BUFFER_0) + + @property + def ranges_from_history(self) -> Optional[List[int]]: + """Read the last 16 range measurements from history""" + + if not self.range_history_enabled: + return None + + return [self._read_8(_VL6180X_REG_RESULT_HISTORY_BUFFER_0 + age) for age in range(16)] + + @property + def range_history_enabled(self) -> bool: + """Checks if history buffer stores range data""" + + history_ctrl: int = self._read_8(_VL6180X_REG_SYSTEM_HISTORY_CTRL) + + if history_ctrl & 0x0: + print("History buffering not enabled") + return False + + if (history_ctrl > 1) & 0x1: + print("History buffer stores ALS data, not range") + return False + + return True + + def start_range_continuous(self, period: int = 100) -> None: + """Start continuous range mode + + :param int period: Time delay between measurements, in milliseconds; the value you + will be floored to the nearest 10 milliseconds (setting to 157 ms sets it to 150 + ms). Range is 20 - 2550 ms. + """ + # Set range between measurements + if not 20 <= period <= 2550: + raise ValueError( + "Delay must be in 10 millisecond increments between 20 and 2550 milliseconds" + ) + + period_reg = (period // 10) - 1 + self._write_8(_VL6180X_REG_SYSRANGE_INTERMEASUREMENT_PERIOD, period_reg) + + # Start continuous range measurement + self._write_8(_VL6180X_REG_SYSRANGE_START, 0x03) + + def stop_range_continuous(self) -> None: + """Stop continuous range mode. It is advised to wait for about 0.3s + afterwards to avoid issues with the interrupt flags""" + if self.continuous_mode_enabled: + self._write_8(_VL6180X_REG_SYSRANGE_START, 0x01) + + @property + def continuous_mode_enabled(self) -> bool: + """Checks if continuous mode is enabled""" + return self._read_8(_VL6180X_REG_SYSRANGE_START) > 1 & 0x1 + + @property + def offset(self) -> int: + """Read and sets the manual offset for the sensor, in millimeters""" + return self._offset + + @offset.setter + def offset(self, offset: int) -> None: + self._write_8(_VL6180X_REG_SYSRANGE_PART_TO_PART_RANGE_OFFSET, struct.pack("b", offset)[0]) + self._offset = offset + + def _read_range_single(self) -> int: + """Read the range when in single-shot mode""" while not self._read_8(_VL6180X_REG_RESULT_RANGE_STATUS) & 0x01: pass - # Start a range measurement self._write_8(_VL6180X_REG_SYSRANGE_START, 0x01) + return self._read_range_continuous() + + def _read_range_continuous(self) -> int: + """Read the range when in continuous mode""" + # Poll until bit 2 is set while not self._read_8(_VL6180X_REG_RESULT_INTERRUPT_STATUS_GPIO) & 0x04: pass + # read range in mm range_ = self._read_8(_VL6180X_REG_RESULT_RANGE_VAL) + # clear interrupt self._write_8(_VL6180X_REG_SYSTEM_INTERRUPT_CLEAR, 0x07) + return range_ - def read_lux(self, gain): + def read_lux(self, gain: int) -> float: """Read the lux (light value) from the sensor and return it. Must specify the gain value to use for the lux reading: - - ALS_GAIN_1 = 1x - - ALS_GAIN_1_25 = 1.25x - - ALS_GAIN_1_67 = 1.67x - - ALS_GAIN_2_5 = 2.5x - - ALS_GAIN_5 = 5x - - ALS_GAIN_10 = 10x - - ALS_GAIN_20 = 20x - - ALS_GAIN_40 = 40x + + ================= ===== + Setting Value + ================= ===== + ``ALS_GAIN_1`` 1x + ``ALS_GAIN_1_25`` 1.25x + ``ALS_GAIN_1_67`` 1.67x + ``ALS_GAIN_2_5`` 2.5x + ``ALS_GAIN_5`` 5x + ``ALS_GAIN_10`` 10x + ``ALS_GAIN_20`` 20x + ``ALS_GAIN_40`` 40x + ================= ===== + + :param int gain: The gain value to use + """ reg = self._read_8(_VL6180X_REG_SYSTEM_INTERRUPT_CONFIG) reg &= ~0x38 @@ -134,9 +258,7 @@ def read_lux(self, gain): # start ALS self._write_8(_VL6180X_REG_SYSALS_START, 0x1) # Poll until "New Sample Ready threshold event" is set - while ( - (self._read_8(_VL6180X_REG_RESULT_INTERRUPT_STATUS_GPIO) >> 3) & 0x7 - ) != 4: + while ((self._read_8(_VL6180X_REG_RESULT_INTERRUPT_STATUS_GPIO) >> 3) & 0x7) != 4: pass # read lux! lux = self._read_16(_VL6180X_REG_RESULT_ALS_VAL) @@ -164,25 +286,30 @@ def read_lux(self, gain): return lux @property - def range_status(self): + def range_status(self) -> int: """Retrieve the status/error from a previous range read. This will return a constant value such as: - - ERROR_NONE - No error - - ERROR_SYSERR_1 - System error 1 (see datasheet) - - ERROR_SYSERR_5 - System error 5 (see datasheet) - - ERROR_ECEFAIL - ECE failure - - ERROR_NOCONVERGE - No convergence - - ERROR_RANGEIGNORE - Outside range ignored - - ERROR_SNR - Too much noise - - ERROR_RAWUFLOW - Raw value underflow - - ERROR_RAWOFLOW - Raw value overflow - - ERROR_RANGEUFLOW - Range underflow - - ERROR_RANGEOFLOW - Range overflow + ===================== ============================== + Error Description + ===================== ============================== + ``ERROR_NONE`` No error + ``ERROR_SYSERR_1`` System error 1 (see datasheet) + ``ERROR_SYSERR_5`` System error 5 (see datasheet) + ``ERROR_ECEFAIL`` ECE failure + ``ERROR_NOCONVERGE`` No convergence + ``ERROR_RANGEIGNORE`` Outside range ignored + ``ERROR_SNR`` Too much noise + ``ERROR_RAWUFLOW`` Raw value underflow + ``ERROR_RAWOFLOW`` Raw value overflow + ``ERROR_RANGEUFLOW`` Range underflow + ``ERROR_RANGEOFLOW`` Range overflow + ===================== ============================== + """ return self._read_8(_VL6180X_REG_RESULT_RANGE_STATUS) >> 4 - def _load_settings(self): + def _load_settings(self) -> None: # private settings from page 24 of app note self._write_8(0x0207, 0x01) self._write_8(0x0208, 0x01) @@ -238,12 +365,12 @@ def _load_settings(self): self._write_8(0x0014, 0x24) # Configures interrupt on 'New Sample # Ready threshold event' - def _write_8(self, address, data): + def _write_8(self, address: int, data: int) -> None: # Write 1 byte of data from the specified 16-bit register address. with self._device: self._device.write(bytes([(address >> 8) & 0xFF, address & 0xFF, data])) - def _write_16(self, address, data): + def _write_16(self, address: int, data: int) -> None: # Write a 16-bit big endian value to the specified 16-bit register # address. with self._device as i2c: @@ -258,7 +385,7 @@ def _write_16(self, address, data): ) ) - def _read_8(self, address): + def _read_8(self, address: int) -> int: # Read and return a byte from the specified 16-bit register address. with self._device as i2c: result = bytearray(1) @@ -266,7 +393,7 @@ def _read_8(self, address): i2c.readinto(result) return result[0] - def _read_16(self, address): + def _read_16(self, address: int) -> int: # Read and return a 16-bit unsigned big endian value read from the # specified 16-bit register address. with self._device as i2c: diff --git a/docs/api.rst b/docs/api.rst index 0bf26c6..1aa8eff 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,5 +1,8 @@ .. If you created a package, create one automodule per module in the package. +API Reference +############# + .. automodule:: adafruit_vl6180x :members: diff --git a/docs/conf.py b/docs/conf.py index 58e82b2..e415180 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,9 +1,8 @@ -# -*- coding: utf-8 -*- - # SPDX-FileCopyrightText: 2021 ladyada 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.viewcode", ] @@ -26,12 +26,12 @@ # autodoc_mock_imports = ["micropython", "adafruit_bus_device"] 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, ), - "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. @@ -44,7 +44,12 @@ # General information about the project. project = "Adafruit VL6180X Library" -copyright = "2017 Tony DiCola" +creation_year = "2017" +current_year = str(datetime.datetime.now().year) +year_duration = ( + current_year if current_year == creation_year else creation_year + " - " + current_year +) +copyright = year_duration + " Tony DiCola" author = "Tony DiCola" # The version info for the project you're documenting, acts as replacement for @@ -61,7 +66,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. @@ -92,19 +97,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 5856981..9311dfe 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -1,4 +1,4 @@ -Simple test +Simple Test ------------ Ensure your device works with this simple test. @@ -6,3 +6,52 @@ Ensure your device works with this simple test. .. literalinclude:: ../examples/vl6180x_simpletest.py :caption: examples/vl6180x_simpletest.py :linenos: + + +Calibration Test +----------------- + +Demo of calibrating the part to part range offset per Application Note 4545 for the VL6180X sensor. + +.. literalinclude:: ../examples/vl6180x_calibrationtest.py + :caption: examples/vl6180x_calibrationtest.py + :linenos: + + +Continuous Test +---------------- + +Demo of reading the range from the VL6180x distance sensor in continuous mode. + +.. literalinclude:: ../examples/vl6180x_continuoustest.py + :caption: examples/vl6180x_continuoustest.py + :linenos: + + +History Test +------------- + +Demo of reading the range from the history buffer of the VL6180x distance sensor. + +.. literalinclude:: ../examples/vl6180x_historytest.py + :caption: examples/vl6180x_historytest.py + :linenos: + + +Performance Test +----------------- + +Demo of reading the range from the VL6180x distance sensor in different access modes (single shot, continuous, history). + +.. literalinclude:: ../examples/vl6180x_performancetest.py + :caption: examples/vl6180x_performancetest.py + :linenos: + +DisplayIO Simpletest +--------------------- + +This is a simple test for boards with built-in display. + +.. literalinclude:: ../examples/vl6180x_displayio_simpletest.py + :caption: examples/vl6180x_displayio_simpletest.py + :linenos: diff --git a/docs/index.rst b/docs/index.rst index 8cf3d6b..76d766b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -31,8 +31,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/vl6180x_calibrationtest.py b/examples/vl6180x_calibrationtest.py new file mode 100644 index 0000000..3e8d68d --- /dev/null +++ b/examples/vl6180x_calibrationtest.py @@ -0,0 +1,34 @@ +# SPDX-FileCopyrightText: 2018 Tony DiCola for Adafruit Industries +# SPDX-License-Identifier: MIT + +# Demo of calibrating the part to part range offset per Application Note 4545 +# for the VL6180X sensor + +import time + +import board +import busio + +import adafruit_vl6180x + +# Create I2C bus. +i2c = busio.I2C(board.SCL, board.SDA) + +# Create sensor instance, with explicit offset of 0 to clear the system offset +sensor = adafruit_vl6180x.VL6180X(i2c, offset=0) + +# Place a target at 50mm away from VL6180X Collect a number of range measurements +# with the target in place and calculate mean of the range results. For a +# reliable measurement, take at least 10 measurements. +measurements = [] +for msmt in range(10): + range_mm = sensor.range + measurements.append(range_mm) + time.sleep(1.0) +average_msmt = sum(measurements) / 10 + +# Calculate the offset required: +calibration_offset = 50 - average_msmt + +# Apply offset +sensor.offset = calibration_offset diff --git a/examples/vl6180x_continuoustest.py b/examples/vl6180x_continuoustest.py new file mode 100644 index 0000000..5960bb0 --- /dev/null +++ b/examples/vl6180x_continuoustest.py @@ -0,0 +1,35 @@ +# SPDX-FileCopyrightText: 2018 Jonas Schatz +# SPDX-License-Identifier: MIT + +# Demo of reading the range from the VL6180x distance sensor in +# continuous mode + +import time + +import board +import busio + +import adafruit_vl6180x + +# Create I2C bus. +i2c = busio.I2C(board.SCL, board.SDA) + +# Create sensor instance. +sensor = adafruit_vl6180x.VL6180X(i2c) + +# Starting continuous mode +print("Starting continuous mode") +sensor.start_range_continuous(20) + +# Main loop prints the range and lux every 0.01 seconds +for _ in range(100): + # Read the range in millimeters and print it. + range_mm = sensor.range + print(f"Range: {range_mm}mm") + + # Delay for 10 ms + time.sleep(0.01) + +# Stop continuous mode. This is advised as the sensor +# wouldn't stop measuring after the program has ended +sensor.stop_range_continuous() diff --git a/examples/vl6180x_displayio_simpletest.py b/examples/vl6180x_displayio_simpletest.py new file mode 100644 index 0000000..342d33e --- /dev/null +++ b/examples/vl6180x_displayio_simpletest.py @@ -0,0 +1,50 @@ +# 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 + +import adafruit_vl6180x + +# Simple demo of the vl6180x distance sensor. +# 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 = adafruit_vl6180x.VL6180X(i2c) + +# Create two Labels to show the readings. If you have a very small +# display you may need to change to scale=1. +range_output_label = Label(FONT, text="", scale=2) +light_lux_output_label = Label(FONT, text="", scale=2) + +# place the labels in the middle of the screen with anchored positioning +range_output_label.anchor_point = (0, 0) +range_output_label.anchored_position = ( + 4, + board.DISPLAY.height // 2 - 40, +) +light_lux_output_label.anchor_point = (0, 0) +light_lux_output_label.anchored_position = (4, board.DISPLAY.height // 2) + + +# add the label to the main_group +main_group.append(range_output_label) +main_group.append(light_lux_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 label.text property to change the text on the display + range_output_label.text = f"Range:{sensor.range} mm" + light_lux_output_label.text = f"Lux:{sensor.read_lux(adafruit_vl6180x.ALS_GAIN_1)} lux" + # wait for a bit + time.sleep(1.0) diff --git a/examples/vl6180x_historytest.py b/examples/vl6180x_historytest.py new file mode 100644 index 0000000..2b1e430 --- /dev/null +++ b/examples/vl6180x_historytest.py @@ -0,0 +1,36 @@ +# SPDX-FileCopyrightText: 2022 Jonas Schatz +# SPDX-License-Identifier: MIT + +# Demo of reading the range from the history buffer of the VL6180x +# distance sensor + +import time + +import board +import busio + +import adafruit_vl6180x + +# Create I2C bus. +i2c = busio.I2C(board.SCL, board.SDA) + +# Create sensor instance. +sensor = adafruit_vl6180x.VL6180X(i2c) + +# Starting continuous mode +print("Starting continuous mode") +sensor.start_range_continuous() + +# Main loop prints the ranges every 0.01 seconds for about 5 seconds +# You should see changes 'ripple through' the history array +for _ in range(500): + # Read the last 16 ranges from the history buffer as a List[int] + ranges_mm = sensor.ranges_from_history + print(ranges_mm) + + # Delay for 10 ms so that the loop is not too fast + time.sleep(0.01) + +# Stop continuous mode. This is advised as the sensor +# wouldn't stop measuring after the program has ended +sensor.stop_range_continuous() diff --git a/examples/vl6180x_performancetest.py b/examples/vl6180x_performancetest.py new file mode 100644 index 0000000..770852b --- /dev/null +++ b/examples/vl6180x_performancetest.py @@ -0,0 +1,55 @@ +# SPDX-FileCopyrightText: 2022 Jonas Schatz +# SPDX-License-Identifier: MIT + +# Demo of reading the range from the VL6180x distance sensor in +# different access modes (single shot, continuous, history) + +import time + +import board +import busio + +import adafruit_vl6180x + +# Create I2C bus. +i2c = busio.I2C(board.SCL, board.SDA) + +# Create sensor instance. +sensor = adafruit_vl6180x.VL6180X(i2c) + +# Define the number of measurements +# n_measurements = 1000 will run for about 2 minutes +n_measurements: int = 100 + +# Single shot +print("Starting single-shot measurement...") +start = time.time() +for i in range(n_measurements): + range_mm = sensor.range +print(f"Performed {n_measurements} measurements in single-shot mode in {time.time() - start}s\n") + +# Sleep is required, otherwise the sensor might freeze when switching to +# continuous mode too quickly after the last single shot +time.sleep(2) + +# Continuous with no delay between measurements +print("Starting continuous measurement...") +sensor.start_range_continuous(20) +start = time.time() +for i in range(n_measurements): + range_mm = sensor.range +print(f"Performed {n_measurements} measurements in continuous mode in {time.time() - start}s\n") + +# Continuous, reading data from history. +# Note: This is fast, since you don't have to wait for the measurement to be +# finished. On the downside, you will read the same value multiple times +print("Starting continuous measurement with history enabled...") +start = time.time() +for i in range(n_measurements): + range_mm = sensor.range_from_history +print( + f"Performed {n_measurements} measurements in continuous mode, reading form history, in {time.time() - start}s\n" # noqa: E501 +) + +sensor.stop_range_continuous() +print("Finished") diff --git a/examples/vl6180x_simpletest.py b/examples/vl6180x_simpletest.py index cb02bea..a66af8d 100644 --- a/examples/vl6180x_simpletest.py +++ b/examples/vl6180x_simpletest.py @@ -11,18 +11,20 @@ import adafruit_vl6180x - # Create I2C bus. i2c = busio.I2C(board.SCL, board.SDA) # Create sensor instance. sensor = adafruit_vl6180x.VL6180X(i2c) +# You can add an offset to distance measurements here (e.g. calibration) +# Swapping for the following would add a +10 millimeter offset to measurements: +# sensor = adafruit_vl6180x.VL6180X(i2c, offset=10) # Main loop prints the range and lux every second: while True: # Read the range in millimeters and print it. range_mm = sensor.range - print("Range: {0}mm".format(range_mm)) + print(f"Range: {range_mm}mm") # Read the light, note this requires specifying a gain value: # - adafruit_vl6180x.ALS_GAIN_1 = 1x # - adafruit_vl6180x.ALS_GAIN_1_25 = 1.25x @@ -33,6 +35,6 @@ # - adafruit_vl6180x.ALS_GAIN_20 = 20x # - adafruit_vl6180x.ALS_GAIN_40 = 40x light_lux = sensor.read_lux(adafruit_vl6180x.ALS_GAIN_1) - print("Light (1x gain): {0}lux".format(light_lux)) + print(f"Light (1x gain): {light_lux}lux") # Delay for a second. time.sleep(1.0) 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 new file mode 100644 index 0000000..1b7a583 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,48 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +[build-system] +requires = [ + "setuptools", + "wheel", + "setuptools-scm", +] + +[project] +name = "adafruit-circuitpython-vl6180x" +description = "CircuitPython library for VL6180X time of flight distance sensor." +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_VL6180X"} +keywords = [ + "adafruit", + "vl6180x", + "time", + "flight", + "distance", + "sensorbreakout", + "hardware", + "micropython", + "circuitpython", +] +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_vl6180x"] + +[tool.setuptools.dynamic] +dependencies = {file = ["requirements.txt"]} +optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} diff --git a/requirements.txt b/requirements.txt index f675e3b..a45c547 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries # # SPDX-License-Identifier: Unlicense diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..1b887b1 --- /dev/null +++ b/ruff.toml @@ -0,0 +1,107 @@ +# 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 + "PLR6301", # could-be-static no-self-use + "PLC0415", # import outside toplevel +] + +[format] +line-ending = "lf" diff --git a/setup.py b/setup.py deleted file mode 100644 index 7c90051..0000000 --- a/setup.py +++ /dev/null @@ -1,57 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada 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 -""" - -# Always prefer setuptools over distutils -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-vl6180x", - use_scm_version=True, - setup_requires=["setuptools_scm"], - description="CircuitPython library for VL6180X time of flight distance sensor.", - long_description=long_description, - long_description_content_type="text/x-rst", - # The project's main homepage. - url="https://github.com/adafruit/Adafruit_CircuitPython_VL6180X", - # Author details - author="Adafruit Industries", - author_email="circuitpython@adafruit.com", - install_requires=["Adafruit-Blinka", "adafruit-circuitpython-busdevice"], - # 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 vl6180x time flight distance sensor" - "breakout hardware micropython circuitpython", - # You can just specify the packages manually here if your project is - # simple. Or you can use find_packages(). - py_modules=["adafruit_vl6180x"], -)