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 5fb597b..db3d538 100644 --- a/.gitignore +++ b/.gitignore @@ -1,16 +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 751501a..b99dd8d 100644 --- a/README.rst +++ b/README.rst @@ -2,10 +2,10 @@ Introduction ============ .. image:: https://readthedocs.org/projects/adafruit-circuitpython-dsp310/badge/?version=latest - :target: https://circuitpython.readthedocs.io/projects/dps310/en/latest/ + :target: https://docs.circuitpython.org/projects/dps310/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,6 +13,10 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_DPS310/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 + Library for the DPS310 Precision Barometric Pressure Sensor @@ -49,10 +53,33 @@ 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-dps310 + +Installing to a connected CircuitPython Device +============================================== +Some devices, eg. the QT-PY, are very limited in memory. The DPS310 library contains +two variants - basic and advanced - which give different levels of functionality. + +Installing the DPS310 library could have the following outcomes: + + * It installs successfully and your code runs successfully. Woo-hoo! Continue with + your amazing project. + * It installs successfully and your code fails to run with a memory allocation + error. Try one of the following: + + * If your ``code.py`` is large, especially if it has lots of comments, you + can shrink it into a ``.mpy`` file instead. See the Adafruit + `Learn Guide `_ + on shrinking your code. + * Only use the basic DPS310 implementation, and remove the following file: + ``/lib/adafruit_dps310/advanced.mpy`` where is the + mounted location of your device. Make sure that your code only uses the basic + implementation. + + Usage Example ============= @@ -60,11 +87,11 @@ Usage Example import time import board - import adafruit_dps310 + from adafruit_dps310.basic import DPS310 i2c = board.I2C() # uses board.SCL and board.SDA - dps310 = adafruit_dps310.DPS310(i2c) + dps310 = DPS310(i2c) while True: print("Temperature = %.2f *C"%dps310.temperature) @@ -72,28 +99,22 @@ Usage Example print("") time.sleep(1.0) -Caveat: by default the library initializes the IC with constant temperature and pressure measurements at 64Hz with 64 samples. It is not possible to change the IC's mode, temperature_oversample_count or pressure_oversample_count on-the-fly so resetting the IC and operation parameteres is required. For instance, to set the mode to continuous pressure measurement at 1Hz with 2 samples: - -.. code-block:: python3 - - dps310.reset() - dps310.pressure_oversample_count = adafruit_dps310.SampleCount.COUNT_2 - dps310.pressure_rate = adafruit_dps310.Rate.RATE_1_HZ - dps310.mode = adafruit_dps310.Mode.CONT_PRESSURE - dps310.wait_pressure_ready() - - Known Issues ============ -Library extensive features might not be compatible with memory limited boards. Library might not -load in SAMD21 boards and others with 32KB of RAM or less. +Library extensive features might not be compatible with memory limited boards. For these kind of +boards you need to use the ``adafruit_dps310/basic.mpy``, the file needs to be in the ``mpy`` +format in order to fit in memory. +For boards with more memory available you could use the code present +in ``adafruit_dps310/advanced.py``. For usage refer to ``dps310_simpletest_advanced.py`` 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 ============ @@ -101,8 +122,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_dps310/__init__.py b/adafruit_dps310/__init__.py new file mode 100644 index 0000000..653502f --- /dev/null +++ b/adafruit_dps310/__init__.py @@ -0,0 +1,14 @@ +# SPDX-FileCopyrightText: 2020 Bryan Siepert for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +""" +`adafruit_dps310` +================================================================================ + +Library for the DPS310 Precision Barometric Pressure Sensor + +* Author(s): Bryan Siepert, Jose David M. +""" + +from adafruit_dps310.advanced import DPS310_Advanced as DPS310 diff --git a/adafruit_dps310.py b/adafruit_dps310/advanced.py similarity index 54% rename from adafruit_dps310.py rename to adafruit_dps310/advanced.py index 3151faa..b3e7910 100644 --- a/adafruit_dps310.py +++ b/adafruit_dps310/advanced.py @@ -3,12 +3,13 @@ # SPDX-License-Identifier: MIT """ -`adafruit_dps310` +`adafruit_dps310.advanced` ================================================================================ -Library for the DPS310 Precision Barometric Pressure Sensor +Library for the DPS310 Precision Barometric Pressure Sensor. This is the advanced +version. Includes some features not present in `adafruit_dps310.basic` -* Author(s): Bryan Siepert +* Author(s): Bryan Siepert, Jose David M. Implementation Notes -------------------- @@ -31,38 +32,27 @@ """ -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DPS310.git" -# Common imports; remove if unused or pylint will complain -import math from time import sleep -from adafruit_bus_device import i2c_device -from adafruit_register.i2c_struct import UnaryStruct, ROUnaryStruct -from adafruit_register.i2c_bit import RWBit, ROBit -from adafruit_register.i2c_bits import RWBits, ROBits -_DPS310_DEFAULT_ADDRESS = 0x77 # DPS310 default i2c address -_DPS310_DEVICE_ID = 0x10 # DPS310 device identifier +from adafruit_register.i2c_bits import RWBits +from micropython import const -_DPS310_PRSB2 = 0x00 # Highest byte of pressure data -_DPS310_TMPB2 = 0x03 # Highest byte of temperature data -_DPS310_PRSCFG = 0x06 # Pressure configuration -_DPS310_TMPCFG = 0x07 # Temperature configuration -_DPS310_MEASCFG = 0x08 # Sensor configuration -_DPS310_CFGREG = 0x09 # Interrupt/FIFO configuration -_DPS310_RESET = 0x0C # Soft reset -_DPS310_PRODREVID = 0x0D # Register that contains the part ID -_DPS310_TMPCOEFSRCE = 0x28 # Temperature calibration src +from adafruit_dps310.basic import DPS310 -# pylint: disable=no-member,unnecessary-pass +try: + from typing import Iterable, Optional, Tuple, Union +except ImportError: + pass class CV: """struct helper""" @classmethod - def add_values(cls, value_tuples): + def add_values(cls, value_tuples: Iterable[Tuple[str, int, Union[str, int], Optional[float]]]): """Add CV values to the class""" cls.string = {} cls.lsb = {} @@ -74,7 +64,7 @@ def add_values(cls, value_tuples): cls.lsb[value] = lsb @classmethod - def is_valid(cls, value): + def is_valid(cls, value: int) -> bool: """Validate that a given value is a member""" return value in cls.string @@ -105,7 +95,7 @@ class Mode(CV): """ - pass # pylint: disable=unnecessary-pass + pass Mode.add_values( @@ -158,30 +148,44 @@ class SampleCount(CV): ("COUNT_128", 7, 128, None), ) ) -# pylint: enable=unnecessary-pass -class DPS310: - # pylint: disable=too-many-instance-attributes + +_DPS310_DEFAULT_ADDRESS = const(0x77) # DPS310 default i2c address +# _DPS310_DEVICE_ID = const(0x10) # DPS310 device identifier + +# _DPS310_PRSB2 = const(0x00) # Highest byte of pressure data +# _DPS310_TMPB2 = const(0x03) # Highest byte of temperature data +_DPS310_PRSCFG = const(0x06) # Pressure configuration +_DPS310_TMPCFG = const(0x07) # Temperature configuration +# _DPS310_MEASCFG = const(0x08) # Sensor configuration +# _DPS310_CFGREG = const(0x09) # Interrupt/FIFO configuration +# _DPS310_RESET = const(0x0C) # Soft reset +# _DPS310_PRODREVID = const(0x0D) # Register that contains the part ID +# _DPS310_TMPCOEFSRCE = const(0x28) # Temperature calibration src + + +class DPS310_Advanced(DPS310): """Library for the DPS310 Precision Barometric Pressure Sensor. + This class contains some of other configurable features :param ~busio.I2C i2c_bus: The I2C bus the DPS310 is connected to. :param int address: The I2C device address. Defaults to :const:`0x77` **Quickstart: Importing and using the DPS310** - Here is an example of using the :class:`DPS310` class. + Here is an example of using the :class:`DPS310_Advanced` class. First you will need to import the libraries to use the sensor .. code-block:: python import board - import adafruit_dps310 + from adafruit_dps310.dps310_advanced import DPS310_Advanced as DPS310 Once this is done you can define your `board.I2C` object and define your sensor object .. code-block:: python i2c = board.I2C() # uses board.SCL and board.SDA - dps310 = adafruit_dps310.DPS310(i2c) + dps310 = DPS310(i2c) Now you have access to the :attr:`temperature` and :attr:`pressure` attributes. @@ -191,69 +195,12 @@ class DPS310: pressure = dps310.pressure """ - # Register definitions - _device_id = ROUnaryStruct(_DPS310_PRODREVID, ">B") - _reset_register = UnaryStruct(_DPS310_RESET, ">B") - _mode_bits = RWBits(3, _DPS310_MEASCFG, 0) + # Register definitions _pressure_ratebits = RWBits(3, _DPS310_PRSCFG, 4) - _pressure_osbits = RWBits(4, _DPS310_PRSCFG, 0) - _temp_ratebits = RWBits(3, _DPS310_TMPCFG, 4) - _temp_osbits = RWBits(4, _DPS310_TMPCFG, 0) - - _temp_measurement_src_bit = RWBit(_DPS310_TMPCFG, 7) - - _pressure_shiftbit = RWBit(_DPS310_CFGREG, 2) - _temp_shiftbit = RWBit(_DPS310_CFGREG, 3) - - _coefficients_ready = RWBit(_DPS310_MEASCFG, 7) - _sensor_ready = RWBit(_DPS310_MEASCFG, 6) - _temp_ready = RWBit(_DPS310_MEASCFG, 5) - _pressure_ready = RWBit(_DPS310_MEASCFG, 4) - - _raw_pressure = ROBits(24, _DPS310_PRSB2, 0, 3, lsb_first=False) - _raw_temperature = ROBits(24, _DPS310_TMPB2, 0, 3, lsb_first=False) - - _calib_coeff_temp_src_bit = ROBit(_DPS310_TMPCOEFSRCE, 7) - - _reg0e = RWBits(8, 0x0E, 0) - _reg0f = RWBits(8, 0x0F, 0) - _reg62 = RWBits(8, 0x62, 0) - - def __init__(self, i2c_bus, address=_DPS310_DEFAULT_ADDRESS): - self.i2c_device = i2c_device.I2CDevice(i2c_bus, address) - - if self._device_id != _DPS310_DEVICE_ID: - raise RuntimeError("Failed to find DPS310 - check your wiring!") - self._pressure_scale = None - self._temp_scale = None - self._c0 = None - self._c1 = None - self._c00 = None - self._c00 = None - self._c10 = None - self._c10 = None - self._c01 = None - self._c11 = None - self._c20 = None - self._c21 = None - self._c30 = None - self._oversample_scalefactor = ( - 524288, - 1572864, - 3670016, - 7864320, - 253952, - 516096, - 1040384, - 2088960, - ) - self.sea_level_pressure = 1013.25 - """Pressure in hectoPascals at sea level. Used to calibrate :attr:`altitude`.""" - self.initialize() - - def initialize(self): + + def initialize(self) -> None: """Initialize the sensor to continuous measurement""" self.reset() @@ -268,75 +215,12 @@ def initialize(self): self.wait_temperature_ready() self.wait_pressure_ready() - # (https://github.com/Infineon/DPS310-Pressure-Sensor#temperature-measurement-issue) - # similar to DpsClass::correctTemp(void) from infineon's c++ library - def _correct_temp(self): - """Correct temperature readings on ICs with a fuse bit problem""" - self._reg0e = 0xA5 - self._reg0f = 0x96 - self._reg62 = 0x02 - self._reg0e = 0 - self._reg0f = 0 - - # perform a temperature measurement - # the most recent temperature will be saved internally - # and used for compensation when calculating pressure - _unused = self._raw_temperature - - def reset(self): - """Reset the sensor""" - self._reset_register = 0x89 - # wait for hardware reset to finish - sleep(0.010) - while not self._sensor_ready: - sleep(0.001) - self._correct_temp() - self._read_calibration() - # make sure we're using the temperature source used for calibration - self._temp_measurement_src_bit = self._calib_coeff_temp_src_bit - - @property - def pressure(self): - """Returns the current pressure reading in hPA""" - - temp_reading = self._raw_temperature - raw_temperature = self._twos_complement(temp_reading, 24) - pressure_reading = self._raw_pressure - raw_pressure = self._twos_complement(pressure_reading, 24) - _scaled_rawtemp = raw_temperature / self._temp_scale - - _temperature = _scaled_rawtemp * self._c1 + self._c0 / 2.0 - - p_red = raw_pressure / self._pressure_scale - - pres_calc = ( - self._c00 - + p_red * (self._c10 + p_red * (self._c20 + p_red * self._c30)) - + _scaled_rawtemp * (self._c01 + p_red * (self._c11 + p_red * self._c21)) - ) - - final_pressure = pres_calc / 100 - return final_pressure - @property - def altitude(self): - """The altitude based on the sea level pressure (:attr:`sea_level_pressure`) - - which you must enter ahead of time)""" - return 44330 * (1.0 - math.pow(self.pressure / self.sea_level_pressure, 0.1903)) - - @property - def temperature(self): - """The current temperature reading in degrees Celsius""" - _scaled_rawtemp = self._raw_temperature / self._temp_scale - _temperature = _scaled_rawtemp * self._c1 + self._c0 / 2.0 - return _temperature - - @property - def temperature_ready(self): + def temperature_ready(self) -> bool: """Returns true if there is a temperature reading ready""" return self._temp_ready - def wait_temperature_ready(self): + def wait_temperature_ready(self) -> None: """Wait until a temperature measurement is available. To avoid waiting indefinitely this function raises an @@ -344,7 +228,7 @@ def wait_temperature_ready(self): ie. ``Mode.ONE_TEMPERATURE``, ``Mode.CONT_TEMP`` or ``Mode.CONT_PRESTEMP``. See the `Mode` documentation for details. """ - if self._mode_bits in (Mode.IDLE, Mode.ONE_PRESSURE, Mode.CONT_PRESSURE): + if self._mode_bits in {Mode.IDLE, Mode.ONE_PRESSURE, Mode.CONT_PRESSURE}: raise RuntimeError( "Sensor mode is set to idle or pressure measurement,\ can't wait for a temperature measurement" @@ -353,11 +237,11 @@ def wait_temperature_ready(self): sleep(0.001) @property - def pressure_ready(self): + def pressure_ready(self) -> bool: """Returns true if pressure readings are ready""" return self._pressure_ready - def wait_pressure_ready(self): + def wait_pressure_ready(self) -> None: """Wait until a pressure measurement is available To avoid waiting indefinitely this function raises an @@ -365,7 +249,7 @@ def wait_pressure_ready(self): ie. ``Mode.ONE_PRESSURE``, ``Mode.CONT_PRESSURE`` or ``Mode.CONT_PRESTEMP`` See the `Mode` documentation for details. """ - if self._mode_bits in (Mode.IDLE, Mode.ONE_TEMPERATURE, Mode.CONT_TEMP): + if self._mode_bits in {Mode.IDLE, Mode.ONE_TEMPERATURE, Mode.CONT_TEMP}: raise RuntimeError( "Sensor mode is set to idle or temperature measurement,\ can't wait for a pressure measurement" @@ -374,35 +258,35 @@ def wait_pressure_ready(self): sleep(0.001) @property - def mode(self): + def mode(self) -> int: """The measurement mode. Must be a `Mode`. See the `Mode` documentation for details""" return self._mode_bits @mode.setter - def mode(self, value): + def mode(self, value: int) -> None: if not Mode.is_valid(value): raise AttributeError("mode must be an `Mode`") self._mode_bits = value @property - def pressure_rate(self): + def pressure_rate(self) -> int: """Configure the pressure measurement rate. Must be a `Rate`""" return self._pressure_ratebits @pressure_rate.setter - def pressure_rate(self, value): + def pressure_rate(self, value: int) -> None: if not Rate.is_valid(value): raise AttributeError("pressure_rate must be a Rate") self._pressure_ratebits = value @property - def pressure_oversample_count(self): + def pressure_oversample_count(self) -> int: """The number of samples taken per pressure measurement. Must be a ``SampleCount``""" return self._pressure_osbits @pressure_oversample_count.setter - def pressure_oversample_count(self, value): + def pressure_oversample_count(self, value: int) -> None: if not SampleCount.is_valid(value): raise AttributeError("pressure_oversample_count must be a SampleCount") @@ -411,67 +295,26 @@ def pressure_oversample_count(self, value): self._pressure_scale = self._oversample_scalefactor[value] @property - def temperature_rate(self): + def temperature_rate(self) -> int: """Configure the temperature measurement rate. Must be a `Rate`""" return self._temp_ratebits @temperature_rate.setter - def temperature_rate(self, value): + def temperature_rate(self, value: int) -> None: if not Rate.is_valid(value): raise AttributeError("temperature_rate must be a Rate") self._temp_ratebits = value @property - def temperature_oversample_count(self): + def temperature_oversample_count(self) -> int: """The number of samples taken per temperature measurement. Must be a ``SampleCount``""" return self._temp_osbits @temperature_oversample_count.setter - def temperature_oversample_count(self, value): + def temperature_oversample_count(self, value: int) -> None: if not SampleCount.is_valid(value): raise AttributeError("temperature_oversample_count must be a SampleCount") self._temp_osbits = value self._temp_scale = self._oversample_scalefactor[value] self._temp_shiftbit = value > SampleCount.COUNT_8 - - @staticmethod - def _twos_complement(val, bits): - if val & (1 << (bits - 1)): - val -= 1 << bits - - return val - - def _read_calibration(self): - - while not self._coefficients_ready: - sleep(0.001) - - buffer = bytearray(19) - coeffs = [None] * 18 - for offset in range(18): - buffer = bytearray(2) - buffer[0] = 0x10 + offset - - with self.i2c_device as i2c: - - i2c.write_then_readinto(buffer, buffer, out_end=1, in_start=1) - - coeffs[offset] = buffer[1] - - self._c0 = (coeffs[0] << 4) | ((coeffs[1] >> 4) & 0x0F) - self._c0 = self._twos_complement(self._c0, 12) - - self._c1 = self._twos_complement(((coeffs[1] & 0x0F) << 8) | coeffs[2], 12) - - self._c00 = (coeffs[3] << 12) | (coeffs[4] << 4) | ((coeffs[5] >> 4) & 0x0F) - self._c00 = self._twos_complement(self._c00, 20) - - self._c10 = ((coeffs[5] & 0x0F) << 16) | (coeffs[6] << 8) | coeffs[7] - self._c10 = self._twos_complement(self._c10, 20) - - self._c01 = self._twos_complement((coeffs[8] << 8) | coeffs[9], 16) - self._c11 = self._twos_complement((coeffs[10] << 8) | coeffs[11], 16) - self._c20 = self._twos_complement((coeffs[12] << 8) | coeffs[13], 16) - self._c21 = self._twos_complement((coeffs[14] << 8) | coeffs[15], 16) - self._c30 = self._twos_complement((coeffs[16] << 8) | coeffs[17], 16) diff --git a/adafruit_dps310/basic.py b/adafruit_dps310/basic.py new file mode 100644 index 0000000..c6a6693 --- /dev/null +++ b/adafruit_dps310/basic.py @@ -0,0 +1,306 @@ +# SPDX-FileCopyrightText: 2020 Bryan Siepert for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +""" +`adafruit_dps310.basic` +================================================================================ + +Library for the DPS310 Precision Barometric Pressure Sensor + +* Author(s): Bryan Siepert, Jose David M. + +Implementation Notes +-------------------- + +**Hardware:** + +* `Adafruit DPS310 Precision Barometric Pressure / Altitude Sensor + `_ (Product ID: 4494) + +**Software and Dependencies:** + +* Adafruit CircuitPython firmware for the supported boards: + https://circuitpython.org/downloads + +* Adafruit's Bus Device library: + https://github.com/adafruit/Adafruit_CircuitPython_BusDevice + +* Adafruit's Register library: + https://github.com/adafruit/Adafruit_CircuitPython_Register + +""" + +__version__ = "0.0.0+auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DPS310.git" + +# Common imports; remove if unused or pylint will complain +import math +from time import sleep + +from adafruit_bus_device import i2c_device +from adafruit_register.i2c_bit import ROBit, RWBit +from adafruit_register.i2c_bits import ROBits, RWBits +from adafruit_register.i2c_struct import ROUnaryStruct, UnaryStruct +from micropython import const + +try: + import typing + + from busio import I2C +except ImportError: + pass + +_DPS310_DEFAULT_ADDRESS = const(0x77) # DPS310 default i2c address +_DPS310_DEVICE_ID = const(0x10) # DPS310 device identifier + +_DPS310_PRSB2 = const(0x00) # Highest byte of pressure data +_DPS310_TMPB2 = const(0x03) # Highest byte of temperature data +_DPS310_PRSCFG = const(0x06) # Pressure configuration +_DPS310_TMPCFG = const(0x07) # Temperature configuration +_DPS310_MEASCFG = const(0x08) # Sensor configuration +_DPS310_CFGREG = const(0x09) # Interrupt/FIFO configuration +_DPS310_RESET = const(0x0C) # Soft reset +_DPS310_PRODREVID = const(0x0D) # Register that contains the part ID +_DPS310_TMPCOEFSRCE = const(0x28) # Temperature calibration src + + +class DPS310: + """Library for the DPS310 Precision Barometric Pressure Sensor. + Depending on your board memory availability you could use DPS310_Advanced. + + :param ~busio.I2C i2c_bus: The I2C bus the DPS310 is connected to. + :param int address: The I2C device address. Defaults to :const:`0x77` + + **Quickstart: Importing and using the DPS310** + + Here is an example of using the :class:`DPS310` class. + First you will need to import the libraries to use the sensor + + .. code-block:: python + + import board + from adafruit_dps310.basic import DPS310 + + Once this is done you can define your `board.I2C` object and define your sensor object + + .. code-block:: python + + i2c = board.I2C() # uses board.SCL and board.SDA + dps310 = DPS310(i2c) + + Now you have access to the :attr:`temperature` and :attr:`pressure` attributes. + + .. code-block:: python + + temperature = dps310.temperature + pressure = dps310.pressure + + """ + + # Register definitions + _device_id = ROUnaryStruct(_DPS310_PRODREVID, ">B") + _reset_register = UnaryStruct(_DPS310_RESET, ">B") + _mode_bits = RWBits(3, _DPS310_MEASCFG, 0) + + _pressure_osbits = RWBits(4, _DPS310_PRSCFG, 0) + + _temp_osbits = RWBits(4, _DPS310_TMPCFG, 0) + + _temp_measurement_src_bit = RWBit(_DPS310_TMPCFG, 7) + + _pressure_shiftbit = RWBit(_DPS310_CFGREG, 2) + _temp_shiftbit = RWBit(_DPS310_CFGREG, 3) + + _coefficients_ready = RWBit(_DPS310_MEASCFG, 7) + _sensor_ready = RWBit(_DPS310_MEASCFG, 6) + _temp_ready = RWBit(_DPS310_MEASCFG, 5) + _pressure_ready = RWBit(_DPS310_MEASCFG, 4) + + _raw_pressure = ROBits(24, _DPS310_PRSB2, 0, 3, lsb_first=False) + _raw_temperature = ROBits(24, _DPS310_TMPB2, 0, 3, lsb_first=False) + + _calib_coeff_temp_src_bit = ROBit(_DPS310_TMPCOEFSRCE, 7) + + _reg0e = RWBits(8, 0x0E, 0) + _reg0f = RWBits(8, 0x0F, 0) + _reg62 = RWBits(8, 0x62, 0) + + def __init__(self, i2c_bus: I2C, address: int = _DPS310_DEFAULT_ADDRESS) -> None: + self.i2c_device = i2c_device.I2CDevice(i2c_bus, address) + + if self._device_id != _DPS310_DEVICE_ID: + raise RuntimeError("Failed to find DPS310 - check your wiring!") + self._pressure_scale = None + self._temp_scale = None + self._c0 = None + self._c1 = None + self._c00 = None + self._c00 = None + self._c10 = None + self._c10 = None + self._c01 = None + self._c11 = None + self._c20 = None + self._c21 = None + self._c30 = None + self._oversample_scalefactor = ( + 524288, + 1572864, + 3670016, + 7864320, + 253952, + 516096, + 1040384, + 2088960, + ) + self._sea_level_pressure = 1013.25 + + self.initialize() + + def initialize(self) -> None: + """Initialize the sensor to continuous measurement""" + + self.reset() + + self._pressure_osbits = 6 + self._pressure_shiftbit = True + self._pressure_scale = self._oversample_scalefactor[6] + + self._temp_osbits = 6 + self._temp_scale = self._oversample_scalefactor[6] + self._temp_shiftbit = True + + self._mode_bits = 7 + + # wait until we have at least one good measurement + self.wait_temperature_ready() + self.wait_pressure_ready() + + # (https://github.com/Infineon/DPS310-Pressure-Sensor#temperature-measurement-issue) + # similar to DpsClass::correctTemp(void) from infineon's c++ library + def _correct_temp(self) -> None: + """Correct temperature readings on ICs with a fuse bit problem""" + self._reg0e = 0xA5 + self._reg0f = 0x96 + self._reg62 = 0x02 + self._reg0e = 0 + self._reg0f = 0 + + # perform a temperature measurement + # the most recent temperature will be saved internally + # and used for compensation when calculating pressure + _unused = self._raw_temperature + + def reset(self) -> None: + """Reset the sensor""" + self._reset_register = 0x89 + # wait for hardware reset to finish + sleep(0.010) + while not self._sensor_ready: + sleep(0.001) + self._correct_temp() + self._read_calibration() + # make sure we're using the temperature source used for calibration + self._temp_measurement_src_bit = self._calib_coeff_temp_src_bit + + @property + def pressure(self) -> float: + """Returns the current pressure reading in hectoPascals (hPa)""" + + temp_reading = self._raw_temperature + raw_temperature = self._twos_complement(temp_reading, 24) + + pressure_reading = self._raw_pressure + raw_pressure = self._twos_complement(pressure_reading, 24) + + scaled_rawtemp = raw_temperature / self._temp_scale + scaled_rawpres = raw_pressure / self._pressure_scale + + pres_calc = ( + self._c00 + + scaled_rawpres + * (self._c10 + scaled_rawpres * (self._c20 + scaled_rawpres * self._c30)) + + scaled_rawtemp + * (self._c01 + scaled_rawpres * (self._c11 + scaled_rawpres * self._c21)) + ) + + final_pressure = pres_calc / 100 + return final_pressure + + @property + def altitude(self) -> float: + """The altitude in meters based on the sea level pressure + (:attr:`sea_level_pressure`) - which you must enter + ahead of time + """ + return 44330 * (1.0 - math.pow(self.pressure / self._sea_level_pressure, 0.1903)) + + @property + def temperature(self) -> float: + """The current temperature reading in degrees Celsius""" + _scaled_rawtemp = self._raw_temperature / self._temp_scale + _temperature = _scaled_rawtemp * self._c1 + self._c0 / 2.0 + return _temperature + + @property + def sea_level_pressure(self) -> float: + """The local sea level pressure in hectoPascals (aka millibars). This is used + for calculation of :attr:`altitude`. Values are typically in the range + 980 - 1030.""" + return self._sea_level_pressure + + @sea_level_pressure.setter + def sea_level_pressure(self, value: float) -> None: + self._sea_level_pressure = value + + def wait_temperature_ready(self) -> None: + """Wait until a temperature measurement is available.""" + + while self._temp_ready is False: + sleep(0.001) + + def wait_pressure_ready(self) -> None: + """Wait until a pressure measurement is available""" + + while self._pressure_ready is False: + sleep(0.001) + + @staticmethod + def _twos_complement(val: int, bits: int) -> int: + if val & (1 << (bits - 1)): + val -= 1 << bits + + return val + + def _read_calibration(self) -> None: + while not self._coefficients_ready: + sleep(0.001) + + buffer = bytearray(19) + coeffs = [None] * 18 + for offset in range(18): + buffer = bytearray(2) + buffer[0] = 0x10 + offset + + with self.i2c_device as i2c: + i2c.write_then_readinto(buffer, buffer, out_end=1, in_start=1) + + coeffs[offset] = buffer[1] + + self._c0 = (coeffs[0] << 4) | ((coeffs[1] >> 4) & 0x0F) + self._c0 = self._twos_complement(self._c0, 12) + + self._c1 = self._twos_complement(((coeffs[1] & 0x0F) << 8) | coeffs[2], 12) + + self._c00 = (coeffs[3] << 12) | (coeffs[4] << 4) | ((coeffs[5] >> 4) & 0x0F) + self._c00 = self._twos_complement(self._c00, 20) + + self._c10 = ((coeffs[5] & 0x0F) << 16) | (coeffs[6] << 8) | coeffs[7] + self._c10 = self._twos_complement(self._c10, 20) + + self._c01 = self._twos_complement((coeffs[8] << 8) | coeffs[9], 16) + self._c11 = self._twos_complement((coeffs[10] << 8) | coeffs[11], 16) + self._c20 = self._twos_complement((coeffs[12] << 8) | coeffs[13], 16) + self._c21 = self._twos_complement((coeffs[14] << 8) | coeffs[15], 16) + self._c30 = self._twos_complement((coeffs[16] << 8) | coeffs[17], 16) diff --git a/docs/api.rst b/docs/api.rst index c41be33..297f7d0 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,6 +4,15 @@ .. 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_dps310 :members: + +.. automodule:: adafruit_dps310.basic + :members: + +.. automodule:: adafruit_dps310.advanced + :members: :exclude-members: CV, SampleCount diff --git a/docs/conf.py b/docs/conf.py index feb5500..68e7b3d 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.napoleon", "sphinx.ext.todo", @@ -25,20 +25,24 @@ # Uncomment the below if you use native CircuitPython modules such as # digitalio, micropython and busio. List the modules you use. Without it, the # autodoc module docs will fail to generate with a warning. -autodoc_mock_imports = ["adafruit_register", "adafruit_bus_device"] +autodoc_mock_imports = [ + "adafruit_register", + "adafruit_bus_device", + "micropython", +] 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 +55,12 @@ # General information about the project. project = "Adafruit DPS310 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 +77,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. @@ -100,19 +109,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 f38db7e..2fe988a 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -1,12 +1,23 @@ Simple test ------------ -Ensure your device works with this simple test. +Ensure your device works with this simple test. For low memory capacity boards .. literalinclude:: ../examples/dps310_simpletest.py :caption: examples/dps310_simpletest.py :linenos: +Simple test advanced +------------------------ + +This is a more advance example that shows the full feature library to use with boards +where memory allows to use it + +.. literalinclude:: ../examples/dps310_simpletest_advanced.py + :caption: examples/dps310_simpletest_advanced.py + :linenos: + + Lower Power Weather Station --------------------------- @@ -16,3 +27,12 @@ sampling counts and mode optimized for low power .. literalinclude:: ../examples/dps310_low_power_weather_station.py :caption: examples/dps310_low_power_weather_station.py :linenos: + +DisplayIO Simpletest +--------------------- + +This is a simple test for boards with built-in display. + +.. literalinclude:: ../examples/dps310_displayio_simpletest.py + :caption: examples/dps310_displayio_simpletest.py + :linenos: diff --git a/docs/index.rst b/docs/index.rst index 3b48c21..63c6604 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/dps310_displayio_simpletest.py b/examples/dps310_displayio_simpletest.py new file mode 100644 index 0000000..9e3bb37 --- /dev/null +++ b/examples/dps310_displayio_simpletest.py @@ -0,0 +1,46 @@ +# 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_dps310.basic import DPS310 + +# 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 +dps310 = DPS310(i2c) + +# 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 + display_output_label.text = ( + f"Temperature:{dps310.temperature:.2f} C\nPressure:{dps310.pressure:.2f} hPa" + ) + # wait for a bit + time.sleep(0.5) diff --git a/examples/dps310_low_power_weather_station.py b/examples/dps310_low_power_weather_station.py index 53b75e2..15a461b 100644 --- a/examples/dps310_low_power_weather_station.py +++ b/examples/dps310_low_power_weather_station.py @@ -3,29 +3,27 @@ """ Configure the sensor for continuous measurement with rates, -sampling counts and mode optmized for low power, as recommended +sampling counts and mode optimized for low power, as recommended in Infineon's datasheet: https://www.infineon.com/dgdl/Infineon-DPS310-DS-v01_00-EN.pdf """ -# (disable pylint warnings for adafruit_dps310.{SampleCount,Rate,Mode}.* -# as they are generated dynamically) -# pylint: disable=no-member - import time + import board -import adafruit_dps310 -i2c = board.I2C() # uses board.SCL and board.SDA +from adafruit_dps310 import advanced -dps310 = adafruit_dps310.DPS310(i2c) +i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller +dps310 = advanced.DPS310_Advanced(i2c) dps310.reset() -dps310.pressure_oversample_count = adafruit_dps310.SampleCount.COUNT_2 -dps310.pressure_rate = adafruit_dps310.Rate.RATE_1_HZ -dps310.temperature_oversample_count = adafruit_dps310.SampleCount.COUNT_16 -dps310.temperature_rate = adafruit_dps310.Rate.RATE_1_HZ -dps310.mode = adafruit_dps310.Mode.CONT_PRESTEMP +dps310.pressure_oversample_count = advanced.SampleCount.COUNT_2 +dps310.pressure_rate = advanced.Rate.RATE_1_HZ +dps310.temperature_oversample_count = advanced.SampleCount.COUNT_16 +dps310.temperature_rate = advanced.Rate.RATE_1_HZ +dps310.mode = advanced.Mode.CONT_PRESTEMP dps310.wait_temperature_ready() dps310.wait_pressure_ready() diff --git a/examples/dps310_simpletest.py b/examples/dps310_simpletest.py index 9245b70..1fa634f 100644 --- a/examples/dps310_simpletest.py +++ b/examples/dps310_simpletest.py @@ -2,11 +2,14 @@ # SPDX-License-Identifier: MIT import time + import board -import adafruit_dps310 + +from adafruit_dps310.basic import DPS310 i2c = board.I2C() # uses board.SCL and board.SDA -dps310 = adafruit_dps310.DPS310(i2c) +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller +dps310 = DPS310(i2c) while True: print("Temperature = %.2f *C" % dps310.temperature) diff --git a/examples/dps310_simpletest_advanced.py b/examples/dps310_simpletest_advanced.py new file mode 100644 index 0000000..a30574e --- /dev/null +++ b/examples/dps310_simpletest_advanced.py @@ -0,0 +1,18 @@ +# SPDX-FileCopyrightText: 2021 Jose David M. +# SPDX-License-Identifier: MIT + +import time + +import board + +from adafruit_dps310.advanced import DPS310_Advanced as DPS310 + +i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller +dps310 = DPS310(i2c) + +while True: + print("Temperature = %.2f *C" % dps310.temperature) + print("Pressure = %.2f hPa" % dps310.pressure) + print("") + 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..35e7ef6 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,49 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +[build-system] +requires = [ + "setuptools", + "wheel", + "setuptools-scm", +] + +[project] +name = "adafruit-circuitpython-dps310" +description = "Library for the DPS310 Precision Barometric Pressure 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_DPS310"} +keywords = [ + "adafruit", + "blinka", + "circuitpython", + "micropython", + "dps310", + "pressure", + "sensor", + "barometric", + "altimeter", + "altitude", +] +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] +packages = ["adafruit_dps310"] + +[tool.setuptools.dynamic] +dependencies = {file = ["requirements.txt"]} +optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} diff --git a/requirements.txt b/requirements.txt index f162505..fcef575 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,7 +1,7 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries # # SPDX-License-Identifier: Unlicense Adafruit-Blinka -adafruit-circuitpython-busdevice 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 da2cdeb..0000000 --- a/setup.py +++ /dev/null @@ -1,62 +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 -""" - -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-dps310", - use_scm_version=True, - setup_requires=["setuptools_scm"], - description="Library for the DPS310 Precision Barometric Pressure Sensor", - long_description=long_description, - long_description_content_type="text/x-rst", - # The project's main homepage. - url="https://github.com/adafruit/Adafruit_CircuitPython_DPS310", - # 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 dps310 pressure sensor barometric " - "altimeter altitude", - # 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_dps310"], -) pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy