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 new file mode 100644 index 0000000..8de294e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md @@ -0,0 +1,13 @@ +# SPDX-FileCopyrightText: 2021 Adafruit Industries +# +# SPDX-License-Identifier: MIT + +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://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 + +Before submitting the pull request, make sure you've run Pylint and Black locally on your code. You can do this manually or using pre-commit. Instructions are available here: https://adafru.it/check-your-code + +Please remove all of this text before submitting. Include an explanation or list of changes included in your PR, as well as, if applicable, a link to any related issues. diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..041a337 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,14 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: Build CI + +on: [pull_request, push] + +jobs: + test: + runs-on: ubuntu-latest + steps: + - name: Run Build CI workflow + uses: adafruit/workflows-circuitpython-libs/build@main diff --git a/.github/workflows/failure-help-text.yml b/.github/workflows/failure-help-text.yml new file mode 100644 index 0000000..0b1194f --- /dev/null +++ b/.github/workflows/failure-help-text.yml @@ -0,0 +1,19 @@ +# SPDX-FileCopyrightText: 2021 Scott Shawcroft for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: Failure help text + +on: + workflow_run: + workflows: ["Build CI"] + types: + - completed + +jobs: + post-help: + runs-on: ubuntu-latest + if: ${{ github.event.workflow_run.conclusion == 'failure' && github.event.workflow_run.event == 'pull_request' }} + steps: + - name: Post comment to help + uses: adafruit/circuitpython-action-library-ci-failed@v1 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 55f127b..db3d538 100644 --- a/.gitignore +++ b/.gitignore @@ -1,12 +1,48 @@ +# SPDX-FileCopyrightText: 2022 Kattni Rembor, written for Adafruit Industries +# +# 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 -build* -bundles +.venv + +# MacOS-specific files *.DS_Store -.eggs -dist -**/*.egg-info \ No newline at end of file + +# IDE-specific files +.idea +.vscode +*~ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..ff19dde --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,21 @@ +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.5.0 + hooks: + - 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: ruff-format + - id: ruff + args: ["--fix"] + - repo: https://github.com/fsfe/reuse-tool + rev: v3.0.1 + hooks: + - id: reuse diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index 039eaec..0000000 --- a/.pylintrc +++ /dev/null @@ -1,433 +0,0 @@ -[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 -jobs=2 - -# 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 - -# 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=no - -# 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 f4243ad..0000000 --- a/.readthedocs.yml +++ /dev/null @@ -1,3 +0,0 @@ -python: - version: 3 -requirements_file: requirements.txt diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 3a49d3d..0000000 --- a/.travis.yml +++ /dev/null @@ -1,33 +0,0 @@ -dist: trusty -sudo: false -language: python -python: -- '3.6' -cache: - pip: true -deploy: -- provider: releases - api_key: "$GITHUB_TOKEN" - file_glob: true - file: "$TRAVIS_BUILD_DIR/bundles/*" - skip_cleanup: true - overwrite: true - on: - tags: true -- provider: pypi - user: adafruit-travis - on: - tags: true - password: - secure: m2YkBNLO2NFz4ZKpQNW/+m5Wc1/W2aP24BOu9TpoJlE0pUPtag0GUFzOb2roHDbUzLl7y0anHaVVcsVztZyS0b64KiNzZ2iWdN39S5X0nsq0aQAKcKI6TTNl//IPIn23LgrzjQF05k8YKKuY3QnSz9oo3inswVOEeQbZwkPtaVHiJgL9uCqdivy82xyjrnoxgfy1V587tvQwpiJ0Tc10seyyuBjzw33Zb5hgJGsWeS8fuqTl/8nnUGDXCnNPPyyHkxYLjDrbH9x87Hp+eR8URctwrjIn39o4uuF3pgmnmEA1u5fpKyCGuVAsLSlSvmYPzkf0fLD3YDpws4KEm2dr9bBX+x0SlZMpRKr+snW+nzMtK0ltZKOBBS9g1suohOo5qjexNl70ykLU7OchKWCmAWclRlP3GWnpX2gcKGk+fzvv5OqKFI8+6UMcOHLOLzsPkl/9hMisci+VijBIUs7rZckAy2terRayqqwOEq15j3YLCTzlLP1vIfPc8S6ukH1A6+rEoNvGMqmCIAQntbQSwzjgL+4xAlfc5SDBQG9+dKANHCH4zJlKnXfbLxn3SMchtPr8jz6JE/UtOTc7+/9as8bOxfre3ElCPzDZv6M3k5CQHr+hANAepQR8Om86aRry7a7vYym/ESoJdqBURpmq6/+/I2bxnj/1MqlGRahPx1U= -install: -- pip install -r requirements.txt -- pip install circuitpython-build-tools Sphinx sphinx-rtd-theme -- pip install --force-reinstall pylint==1.9.2 -script: -- pylint adafruit_mlx90393.py -- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace - examples/*.py) -- circuitpython-build-bundles --filename_prefix adafruit_circuitpython_mlx90393 --library_location - . -- cd docs && sphinx-build -E -W -b html . _build/html && cd .. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 8ee6e44..8a55c07 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,3 +1,9 @@ + + # Adafruit Community Code of Conduct ## Our Pledge @@ -34,6 +40,8 @@ Examples of unacceptable behavior by participants include: * Excessive or unwelcome helping; answering outside the scope of the question asked * Trolling, insulting/derogatory comments, and personal or political attacks +* Promoting or spreading disinformation, lies, or conspiracy theories against + a person, group, organisation, project, or community * Public or private harassment * Publishing others' private information, such as a physical or electronic address, without explicit permission @@ -41,7 +49,7 @@ Examples of unacceptable behavior by participants include: The goal of the standards and moderation guidelines outlined here is to build and maintain a respectful community. We ask that you don’t just aim to be -"technically unimpeachable", but rather try to be your best self. +"technically unimpeachable", but rather try to be your best self. We value many things beyond technical expertise, including collaboration and supporting others within our community. Providing a positive experience for @@ -72,10 +80,10 @@ You may report in the following ways: In any situation, you may send an email to . On the Adafruit Discord, you may send an open message from any channel -to all Community Helpers by tagging @community helpers. You may also send an -open message from any channel, or a direct message to @kattni#1507, -@tannewt#4653, @Dan Halbert#1614, @cater#2442, @sommersoft#0222, or -@Andon#8175. +to all Community Moderators by tagging @community moderators. You may +also send an open message from any channel, or a direct message to +@kattni#1507, @tannewt#4653, @Dan Halbert#1614, @cater#2442, +@sommersoft#0222, @Mr. Certainly#0472 or @Andon#8175. Email and direct message reports will be kept confidential. diff --git a/LICENSES/CC-BY-4.0.txt b/LICENSES/CC-BY-4.0.txt new file mode 100644 index 0000000..3f92dfc --- /dev/null +++ b/LICENSES/CC-BY-4.0.txt @@ -0,0 +1,324 @@ +Creative Commons Attribution 4.0 International Creative Commons Corporation +("Creative Commons") is not a law firm and does not provide legal services +or legal advice. Distribution of Creative Commons public licenses does not +create a lawyer-client or other relationship. Creative Commons makes its licenses +and related information available on an "as-is" basis. Creative Commons gives +no warranties regarding its licenses, any material licensed under their terms +and conditions, or any related information. Creative Commons disclaims all +liability for damages resulting from their use to the fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and conditions +that creators and other rights holders may use to share original works of +authorship and other material subject to copyright and certain other rights +specified in the public license below. The following considerations are for +informational purposes only, are not exhaustive, and do not form part of our +licenses. + +Considerations for licensors: Our public licenses are intended for use by +those authorized to give the public permission to use material in ways otherwise +restricted by copyright and certain other rights. Our licenses are irrevocable. +Licensors should read and understand the terms and conditions of the license +they choose before applying it. Licensors should also secure all rights necessary +before applying our licenses so that the public can reuse the material as +expected. Licensors should clearly mark any material not subject to the license. +This includes other CC-licensed material, or material used under an exception +or limitation to copyright. More considerations for licensors : wiki.creativecommons.org/Considerations_for_licensors + +Considerations for the public: By using one of our public licenses, a licensor +grants the public permission to use the licensed material under specified +terms and conditions. If the licensor's permission is not necessary for any +reason–for example, because of any applicable exception or limitation to copyright–then +that use is not regulated by the license. Our licenses grant only permissions +under copyright and certain other rights that a licensor has authority to +grant. Use of the licensed material may still be restricted for other reasons, +including because others have copyright or other rights in the material. A +licensor may make special requests, such as asking that all changes be marked +or described. Although not required by our licenses, you are encouraged to +respect those requests where reasonable. More considerations for the public +: wiki.creativecommons.org/Considerations_for_licensees Creative Commons Attribution +4.0 International Public License + +By exercising the Licensed Rights (defined below), You accept and agree to +be bound by the terms and conditions of this Creative Commons Attribution +4.0 International Public License ("Public License"). To the extent this Public +License may be interpreted as a contract, You are granted the Licensed Rights +in consideration of Your acceptance of these terms and conditions, and the +Licensor grants You such rights in consideration of benefits the Licensor +receives from making the Licensed Material available under these terms and +conditions. + +Section 1 – Definitions. + +a. Adapted Material means material subject to Copyright and Similar Rights +that is derived from or based upon the Licensed Material and in which the +Licensed Material is translated, altered, arranged, transformed, or otherwise +modified in a manner requiring permission under the Copyright and Similar +Rights held by the Licensor. For purposes of this Public License, where the +Licensed Material is a musical work, performance, or sound recording, Adapted +Material is always produced where the Licensed Material is synched in timed +relation with a moving image. + +b. Adapter's License means the license You apply to Your Copyright and Similar +Rights in Your contributions to Adapted Material in accordance with the terms +and conditions of this Public License. + +c. Copyright and Similar Rights means copyright and/or similar rights closely +related to copyright including, without limitation, performance, broadcast, +sound recording, and Sui Generis Database Rights, without regard to how the +rights are labeled or categorized. For purposes of this Public License, the +rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. + +d. Effective Technological Measures means those measures that, in the absence +of proper authority, may not be circumvented under laws fulfilling obligations +under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, +and/or similar international agreements. + +e. Exceptions and Limitations means fair use, fair dealing, and/or any other +exception or limitation to Copyright and Similar Rights that applies to Your +use of the Licensed Material. + +f. Licensed Material means the artistic or literary work, database, or other +material to which the Licensor applied this Public License. + +g. Licensed Rights means the rights granted to You subject to the terms and +conditions of this Public License, which are limited to all Copyright and +Similar Rights that apply to Your use of the Licensed Material and that the +Licensor has authority to license. + +h. Licensor means the individual(s) or entity(ies) granting rights under this +Public License. + +i. Share means to provide material to the public by any means or process that +requires permission under the Licensed Rights, such as reproduction, public +display, public performance, distribution, dissemination, communication, or +importation, and to make material available to the public including in ways +that members of the public may access the material from a place and at a time +individually chosen by them. + +j. Sui Generis Database Rights means rights other than copyright resulting +from Directive 96/9/EC of the European Parliament and of the Council of 11 +March 1996 on the legal protection of databases, as amended and/or succeeded, +as well as other essentially equivalent rights anywhere in the world. + +k. You means the individual or entity exercising the Licensed Rights under +this Public License. Your has a corresponding meaning. + +Section 2 – Scope. + + a. License grant. + +1. Subject to the terms and conditions of this Public License, the Licensor +hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, +irrevocable license to exercise the Licensed Rights in the Licensed Material +to: + + A. reproduce and Share the Licensed Material, in whole or in part; and + + B. produce, reproduce, and Share Adapted Material. + +2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions +and Limitations apply to Your use, this Public License does not apply, and +You do not need to comply with its terms and conditions. + + 3. Term. The term of this Public License is specified in Section 6(a). + +4. Media and formats; technical modifications allowed. The Licensor authorizes +You to exercise the Licensed Rights in all media and formats whether now known +or hereafter created, and to make technical modifications necessary to do +so. The Licensor waives and/or agrees not to assert any right or authority +to forbid You from making technical modifications necessary to exercise the +Licensed Rights, including technical modifications necessary to circumvent +Effective Technological Measures. For purposes of this Public License, simply +making modifications authorized by this Section 2(a)(4) never produces Adapted +Material. + + 5. Downstream recipients. + +A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed +Material automatically receives an offer from the Licensor to exercise the +Licensed Rights under the terms and conditions of this Public License. + +B. No downstream restrictions. You may not offer or impose any additional +or different terms or conditions on, or apply any Effective Technological +Measures to, the Licensed Material if doing so restricts exercise of the Licensed +Rights by any recipient of the Licensed Material. + +6. No endorsement. Nothing in this Public License constitutes or may be construed +as permission to assert or imply that You are, or that Your use of the Licensed +Material is, connected with, or sponsored, endorsed, or granted official status +by, the Licensor or others designated to receive attribution as provided in +Section 3(a)(1)(A)(i). + + b. Other rights. + +1. Moral rights, such as the right of integrity, are not licensed under this +Public License, nor are publicity, privacy, and/or other similar personality +rights; however, to the extent possible, the Licensor waives and/or agrees +not to assert any such rights held by the Licensor to the limited extent necessary +to allow You to exercise the Licensed Rights, but not otherwise. + +2. Patent and trademark rights are not licensed under this Public License. + +3. To the extent possible, the Licensor waives any right to collect royalties +from You for the exercise of the Licensed Rights, whether directly or through +a collecting society under any voluntary or waivable statutory or compulsory +licensing scheme. In all other cases the Licensor expressly reserves any right +to collect such royalties. + +Section 3 – License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the following +conditions. + + a. Attribution. + +1. If You Share the Licensed Material (including in modified form), You must: + +A. retain the following if it is supplied by the Licensor with the Licensed +Material: + +i. identification of the creator(s) of the Licensed Material and any others +designated to receive attribution, in any reasonable manner requested by the +Licensor (including by pseudonym if designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of warranties; + +v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; + +B. indicate if You modified the Licensed Material and retain an indication +of any previous modifications; and + +C. indicate the Licensed Material is licensed under this Public License, and +include the text of, or the URI or hyperlink to, this Public License. + +2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner +based on the medium, means, and context in which You Share the Licensed Material. +For example, it may be reasonable to satisfy the conditions by providing a +URI or hyperlink to a resource that includes the required information. + +3. If requested by the Licensor, You must remove any of the information required +by Section 3(a)(1)(A) to the extent reasonably practicable. + +4. If You Share Adapted Material You produce, the Adapter's License You apply +must not prevent recipients of the Adapted Material from complying with this +Public License. + +Section 4 – Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that apply to +Your use of the Licensed Material: + +a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, +reuse, reproduce, and Share all or a substantial portion of the contents of +the database; + +b. if You include all or a substantial portion of the database contents in +a database in which You have Sui Generis Database Rights, then the database +in which You have Sui Generis Database Rights (but not its individual contents) +is Adapted Material; and + +c. You must comply with the conditions in Section 3(a) if You Share all or +a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not replace +Your obligations under this Public License where the Licensed Rights include +other Copyright and Similar Rights. + +Section 5 – Disclaimer of Warranties and Limitation of Liability. + +a. Unless otherwise separately undertaken by the Licensor, to the extent possible, +the Licensor offers the Licensed Material as-is and as-available, and makes +no representations or warranties of any kind concerning the Licensed Material, +whether express, implied, statutory, or other. This includes, without limitation, +warranties of title, merchantability, fitness for a particular purpose, non-infringement, +absence of latent or other defects, accuracy, or the presence or absence of +errors, whether or not known or discoverable. Where disclaimers of warranties +are not allowed in full or in part, this disclaimer may not apply to You. + +b. To the extent possible, in no event will the Licensor be liable to You +on any legal theory (including, without limitation, negligence) or otherwise +for any direct, special, indirect, incidental, consequential, punitive, exemplary, +or other losses, costs, expenses, or damages arising out of this Public License +or use of the Licensed Material, even if the Licensor has been advised of +the possibility of such losses, costs, expenses, or damages. Where a limitation +of liability is not allowed in full or in part, this limitation may not apply +to You. + +c. The disclaimer of warranties and limitation of liability provided above +shall be interpreted in a manner that, to the extent possible, most closely +approximates an absolute disclaimer and waiver of all liability. + +Section 6 – Term and Termination. + +a. This Public License applies for the term of the Copyright and Similar Rights +licensed here. However, if You fail to comply with this Public License, then +Your rights under this Public License terminate automatically. + +b. Where Your right to use the Licensed Material has terminated under Section +6(a), it reinstates: + +1. automatically as of the date the violation is cured, provided it is cured +within 30 days of Your discovery of the violation; or + + 2. upon express reinstatement by the Licensor. + +c. For the avoidance of doubt, this Section 6(b) does not affect any right +the Licensor may have to seek remedies for Your violations of this Public +License. + +d. For the avoidance of doubt, the Licensor may also offer the Licensed Material +under separate terms or conditions or stop distributing the Licensed Material +at any time; however, doing so will not terminate this Public License. + + e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. + +Section 7 – Other Terms and Conditions. + +a. The Licensor shall not be bound by any additional or different terms or +conditions communicated by You unless expressly agreed. + +b. Any arrangements, understandings, or agreements regarding the Licensed +Material not stated herein are separate from and independent of the terms +and conditions of this Public License. + +Section 8 – Interpretation. + +a. For the avoidance of doubt, this Public License does not, and shall not +be interpreted to, reduce, limit, restrict, or impose conditions on any use +of the Licensed Material that could lawfully be made without permission under +this Public License. + +b. To the extent possible, if any provision of this Public License is deemed +unenforceable, it shall be automatically reformed to the minimum extent necessary +to make it enforceable. If the provision cannot be reformed, it shall be severed +from this Public License without affecting the enforceability of the remaining +terms and conditions. + +c. No term or condition of this Public License will be waived and no failure +to comply consented to unless expressly agreed to by the Licensor. + +d. Nothing in this Public License constitutes or may be interpreted as a limitation +upon, or waiver of, any privileges and immunities that apply to the Licensor +or You, including from the legal processes of any jurisdiction or authority. + +Creative Commons is not a party to its public licenses. Notwithstanding, Creative +Commons may elect to apply one of its public licenses to material it publishes +and in those instances will be considered the "Licensor." The text of the +Creative Commons public licenses is dedicated to the public domain under the +CC0 Public Domain Dedication. Except for the limited purpose of indicating +that material is shared under a Creative Commons public license or as otherwise +permitted by the Creative Commons policies published at creativecommons.org/policies, +Creative Commons does not authorize the use of the trademark "Creative Commons" +or any other trademark or logo of Creative Commons without its prior written +consent including, without limitation, in connection with any unauthorized +modifications to any of its public licenses or any other arrangements, understandings, +or agreements concerning use of licensed material. For the avoidance of doubt, +this paragraph does not form part of the public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/LICENSES/MIT.txt b/LICENSES/MIT.txt new file mode 100644 index 0000000..204b93d --- /dev/null +++ b/LICENSES/MIT.txt @@ -0,0 +1,19 @@ +MIT License Copyright (c) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is furnished +to do so, subject to the following conditions: + +The above copyright notice and this permission notice (including the next +paragraph) shall be included in all copies or substantial portions of the +Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS +OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF +OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/LICENSES/Unlicense.txt b/LICENSES/Unlicense.txt new file mode 100644 index 0000000..24a8f90 --- /dev/null +++ b/LICENSES/Unlicense.txt @@ -0,0 +1,20 @@ +This is free and unencumbered software released into the public domain. + +Anyone is free to copy, modify, publish, use, compile, sell, or distribute +this software, either in source code form or as a compiled binary, for any +purpose, commercial or non-commercial, and by any means. + +In jurisdictions that recognize copyright laws, the author or authors of this +software dedicate any and all copyright interest in the software to the public +domain. We make this dedication for the benefit of the public at large and +to the detriment of our heirs and successors. We intend this dedication to +be an overt act of relinquishment in perpetuity of all present and future +rights to this software under copyright law. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS +BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH +THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. For more information, +please refer to diff --git a/README.rst b/README.rst index 5c577c6..076f234 100644 --- a/README.rst +++ b/README.rst @@ -2,17 +2,21 @@ Introduction ============ .. image:: https://readthedocs.org/projects/adafruit-circuitpython-mlx90393/badge/?version=latest - :target: https://circuitpython.readthedocs.io/projects/mlx90393/en/latest/ + :target: https://docs.circuitpython.org/projects/mlx90393/en/latest/ :alt: Documentation Status -.. image:: https://img.shields.io/discord/327254708534116352.svg - :target: https://discord.gg/nBQh6qu +.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg + :target: https://adafru.it/discord :alt: Discord -.. image:: https://travis-ci.org/adafruit/Adafruit_CircuitPython_MLX90393.svg?branch=master - :target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_MLX90393 +.. image:: https://github.com/adafruit/Adafruit_CircuitPython_MLX90393/workflows/Build%20CI/badge.svg + :target: https://github.com/adafruit/Adafruit_CircuitPython_MLX90393/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 + Adafruit CircuitPython driver for the MLX90393 3-axis magnetometer. Dependencies @@ -47,8 +51,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-mlx90939 Usage Example @@ -57,16 +61,14 @@ Usage Example .. code-block:: python3 import time - import busio import board - import adafruit_mlx90393 - I2C_BUS = busio.I2C(board.SCL, board.SDA) - SENSOR = adafruit_mlx90393.MLX90393(I2C_BUS, gain=adafruit_mlx90393.GAIN_1X) + i2c = board.I2C() # uses board.SCL and board.SDA + SENSOR = adafruit_mlx90393.MLX90393(i2c, gain=adafruit_mlx90393.GAIN_1X) while True: - MX, MY, MZ = SENSOR.read_data(delay=1.0, raw=False) + MX, MY, MZ = SENSOR.magnetic print("[{}]".format(time.monotonic())) print("X: {} uT".format(MX)) print("Y: {} uT".format(MY)) @@ -74,60 +76,18 @@ Usage Example # Display the status field if an error occured, etc. if SENSOR.last_status > adafruit_mlx90393.STATUS_OK: SENSOR.display_status() + time.sleep(1.0) + +Documentation +============= + +API documentation for this library can be found on `Read the Docs `_. + +For information on building library documentation, please check out `this guide `_. Contributing ============ Contributions are welcome! Please read our `Code of Conduct -`_ +`_ before contributing to help this project stay welcoming. - -Building locally -================ - -Zip release files ------------------ - -To build this library locally you'll need to install the -`circuitpython-build-tools `_ package. - -.. code-block:: shell - - python3 -m venv .env - source .env/bin/activate - pip install circuitpython-build-tools - -Once installed, make sure you are in the virtual environment: - -.. code-block:: shell - - source .env/bin/activate - -Then run the build: - -.. code-block:: shell - - circuitpython-build-bundles --filename_prefix adafruit_circuitpython_mlx90393 --library_location . - -Sphinx documentation ------------------------ - -Sphinx is used to build the documentation based on rST files and comments in the code. First, -install dependencies (feel free to reuse the virtual environment from above): - -.. code-block:: shell - - python3 -m venv .env - source .env/bin/activate - pip install Sphinx sphinx-rtd-theme - -Now, once you have the virtual environment activated: - -.. code-block:: shell - - cd docs - sphinx-build -E -W -b html . _build/html - -This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to -view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to -locally verify it will pass. diff --git a/README.rst.license b/README.rst.license new file mode 100644 index 0000000..11cd75d --- /dev/null +++ b/README.rst.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries + +SPDX-License-Identifier: MIT diff --git a/adafruit_mlx90393.py b/adafruit_mlx90393.py index eec2f59..f0587b4 100755 --- a/adafruit_mlx90393.py +++ b/adafruit_mlx90393.py @@ -1,24 +1,7 @@ -# The MIT License (MIT) +# SPDX-FileCopyrightText: 2018 Kevin Townsend for Adafruit Industries # -# Copyright (c) 2018 Kevin Townsend for Adafruit Industries -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in -# all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -# THE SOFTWARE. +# SPDX-License-Identifier: MIT + """ `adafruit_mlx90393` ==================================================== @@ -38,44 +21,55 @@ **Software and Dependencies:** * Adafruit CircuitPython firmware for the supported boards: - https://github.com/adafruit/circuitpython/releases - + 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 """ +import struct import time -try: - import struct -except ImportError: - import ustruct as struct from adafruit_bus_device.i2c_device import I2CDevice from micropython import const -__version__ = "0.0.0-auto.0" -__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_MLX90393.git" +try: + from typing import Tuple -_CMD_SB = const(0b00010000) # Start burst mode -_CMD_SW = const(0b00100000) # Start wakeup on change mode -_CMD_SM = const(0b00110000) # Start single-measurement mode -_CMD_RM = const(0b01000000) # Read measurement -_CMD_RR = const(0b01010000) # Read register -_CMD_WR = const(0b01100000) # Write register -_CMD_EX = const(0b10000000) # Exit mode -_CMD_HR = const(0b11010000) # Memory recall -_CMD_HS = const(0b11100000) # Memory store -_CMD_RT = const(0b11110000) # Reset -_CMD_NOP = const(0x00) # NOP + from busio import I2C + from circuitpython_typing import ReadableBuffer +except ImportError: + pass -_CMD_AXIS_ALL = const(0xE) # X+Y+Z axis bits for commands +__version__ = "0.0.0+auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_MLX90393.git" + +_CMD_SB = const(0b00010000) # Start burst mode +_CMD_SW = const(0b00100000) # Start wakeup on change mode +_CMD_SM = const(0b00110000) # Start single-measurement mode +_CMD_RM = const(0b01000000) # Read measurement +_CMD_RR = const(0b01010000) # Read register +_CMD_WR = const(0b01100000) # Write register +_CMD_EX = const(0b10000000) # Exit mode +_CMD_HR = const(0b11010000) # Memory recall +_CMD_HS = const(0b11100000) # Memory store +_CMD_RT = const(0b11110000) # Reset +_CMD_NOP = const(0x00) # NOP + +_CMD_AXIS_ALL = const(0xE) # X+Y+Z axis bits for commands +_CMD_TEMP = const(0x01) # Temperature bit for commands _CMD_REG_CONF1 = const(0x00) # Gain -_CMD_REG_CONF2 = const(0x01) # Burst, comm mode +_CMD_REG_CONF2 = const(0x01) # Burst, comm mode, temperature compensation _CMD_REG_CONF3 = const(0x02) # Oversampling, Filter, Resolution _CMD_REG_CONF4 = const(0x03) # Sensitivity drift +_CMD_REG_CONF5 = const(0x04) # X-axis Offset Correction +_CMD_REG_CONF6 = const(0x05) # Y-axis Offset Correction +_CMD_REG_CONF7 = const(0x06) # Z-axis Offset Correction +# Gain settings GAIN_5X = 0x0 GAIN_4X = 0x1 GAIN_3X = 0x2 @@ -86,13 +80,31 @@ GAIN_1X = 0x7 _GAIN_SHIFT = const(4) -_RES_2_15 = const(0) # +/- 2^15 -_RES_2_15B = const(1) # +/- 2^15 -_RES_22000 = const(2) # +/- 22000 -_RES_11000 = const(3) # +/- 11000 -_RES_SHIFT = const(5) - -_HALLCONF = const(0x0C) # Hall plate spinning rate adjust. +# Resolution settings +RESOLUTION_16 = 0x0 +RESOLUTION_17 = 0x1 +RESOLUTION_18 = 0x2 +RESOLUTION_19 = 0x3 + +# Filter settings +FILTER_0 = 0x0 +FILTER_1 = 0x1 +FILTER_2 = 0x2 +FILTER_3 = 0x3 +FILTER_4 = 0x4 +FILTER_5 = 0x5 +FILTER_6 = 0x6 +FILTER_7 = 0x7 + +# Oversampling settings +OSR_0 = 0x0 +OSR_1 = 0x1 +OSR_2 = 0x2 +OSR_3 = 0x3 + +# Hall plate spinning rate adjustment +# Must be 0x0C (default) or 0x00 +_HALLCONF = const(0x0C) STATUS_OK = 0x3 @@ -101,119 +113,358 @@ # coefficient below. Note that the z axis has a different coefficient # than the x and y axis. _LSB_LOOKUP = ( - # 5x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z) - ((0.805, 1.468), (1.610, 2.936), (3.220, 5.872), (6.440, 11.744)), - # 4x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z) - ((0.644, 1.174), (1.288, 2.349), (2.576, 4.698), (5.152, 9.395)), - # 3x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z) - ((0.483, 0.881), (0.966, 1.762), (1.932, 3.523), (3.864, 7.046)), - # 2.5x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z) - ((0.403, 0.734), (0.805, 1.468), (1.610, 2.936), (3.220, 5.872)), - # 2x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z) - ((0.322, 0.587), (0.644, 1.174), (1.288, 2.349), (2.576, 4.698)), - # 1.667x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z) - ((0.268, 0.489), (0.537, 0.979), (1.073, 1.957), (2.147, 3.915)), - # 1.333x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z) - ((0.215, 0.391), (0.429, 0.783), (0.859, 1.566), (1.717, 3.132)), - # 1x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z) - ((0.161, 0.294), (0.322, 0.587), (0.644, 1.174), (1.288, 2.349)) + # HALLCONF = 0x0C (default) + ( + # 5x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z) + ((0.751, 1.210), (1.502, 2.420), (3.004, 4.840), (6.009, 9.680)), + # 4x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z) + ((0.601, 0.968), (1.202, 1.936), (2.403, 3.872), (4.840, 7.744)), + # 3x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z) + ((0.451, 0.726), (0.901, 1.452), (1.803, 2.904), (3.605, 5.808)), + # 2.5x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z) + ((0.376, 0.605), (0.751, 1.210), (1.502, 2.420), (3.004, 4.840)), + # 2x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z) + ((0.300, 0.484), (0.601, 0.968), (1.202, 1.936), (2.403, 3.872)), + # 1.667x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z) + ((0.250, 0.403), (0.501, 0.807), (1.001, 1.613), (2.003, 3.227)), + # 1.333x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z) + ((0.200, 0.323), (0.401, 0.645), (0.801, 1.291), (1.602, 2.581)), + # 1x gain: res0(xy)(z), res1(xy)(z), res2(xy)(z), res3(xy)(z) + ((0.150, 0.242), (0.300, 0.484), (0.601, 0.968), (1.202, 1.936)), + ), + # HALLCONF = 0x00 + ( + # GAIN_SEL = 0, 5x gain + ((0.787, 1.267), (1.573, 2.534), (3.146, 5.068), (6.292, 10.137)), + # GAIN_SEL = 1, 4x gain + ((0.629, 1.014), (1.258, 2.027), (2.517, 4.055), (5.034, 8.109)), + # GAIN_SEL = 2, 3x gain + ((0.472, 0.760), (0.944, 1.521), (1.888, 3.041), (3.775, 6.082)), + # GAIN_SEL = 3, 2.5x gain + ((0.393, 0.634), (0.787, 1.267), (1.573, 2.534), (3.146, 5.068)), + # GAIN_SEL = 4, 2x gain + ((0.315, 0.507), (0.629, 1.014), (1.258, 2.027), (2.517, 4.055)), + # GAIN_SEL = 5, 1.667x gain + ((0.262, 0.422), (0.524, 0.845), (1.049, 1.689), (2.097, 3.379)), + # GAIN_SEL = 6, 1.333x gain + ((0.210, 0.338), (0.419, 0.676), (0.839, 1.352), (1.678, 2.703)), + # GAIN_SEL = 7, 1x gain + ((0.157, 0.253), (0.315, 0.507), (0.629, 1.014), (1.258, 2.027)), + ), +) + +# Lookup table for conversion times for different filter and +# oversampling settings. Values taken from datasheet. +_TCONV_LOOKUP = ( + # OSR = 0 1 2 3 + (1.27, 1.84, 3.00, 5.30), # DIG_FILT = 0 + (1.46, 2.23, 3.76, 6.84), # DIG_FILT = 1 + (1.84, 3.00, 5.30, 9.91), # DIG_FILT = 2 + (2.61, 4.53, 8.37, 16.05), # DIG_FILT = 3 + (4.15, 7.60, 14.52, 28.34), # DIG_FILT = 4 + (7.22, 13.75, 26.80, 52.92), # DIG_FILT = 5 + (13.36, 26.04, 51.38, 102.07), # DIG_FILT = 6 + (25.65, 50.61, 100.53, 200.37), # DIF_FILT = 7 ) class MLX90393: """ Driver for the MLX90393 magnetometer. - :param i2c_bus: The `busio.I2C` object to use. This is the only - required parameter. - :param int address: (optional) The I2C address of the device. - :param int gain: (optional) The gain level to apply. - :param bool debug: (optional) Enable debug output. + + :param i2c_bus: The I2C bus the device is connected to + :param int address: The I2C device address. Defaults to :const:`0x0C` + :param int gain: The gain level to apply. Defaults to :const:`GAIN_1X` + :param int resolution: The resolution level to use. Defaults to :const:`RESOLUTION_16` + :param int filt: The filter to use. Defaults to :const:`FILTER_7` + :param int oversampling: The oversampleing setting to use. Defaults to :const:`OSR_3` + :param bool debug: Enable debug output. Defaults to `False` + + + **Quickstart: Importing and using the device** + + Here is an example of using the :class:`MLX90393` class. + First you will need to import the libraries to use the sensor + + .. code-block:: python + + import board + import adafruit_mlx90393 + + 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 + SENSOR = adafruit_mlx90393.MLX90393(i2c) + + Now you have access to the :attr:`magnetic` attribute + + .. code-block:: python + + MX, MY, MZ = SENSOR.magnetic + """ - def __init__(self, i2c_bus, address=0x0C, gain=GAIN_1X, debug=False): + def __init__( + self, + i2c_bus: I2C, + address: int = 0x0C, + gain: int = GAIN_1X, + resolution: int = RESOLUTION_16, + filt: int = FILTER_7, + oversampling: int = OSR_3, + temperature_compensation: bool = False, + offset: int = 0, + debug: bool = False, + ) -> None: self.i2c_device = I2CDevice(i2c_bus, address) self._debug = debug self._status_last = 0 - self._res_current = _RES_2_15 + self._res_x = self._res_y = self._res_z = resolution + self._filter = filt + self._osr = oversampling self._gain_current = gain + self._temperature_compensation = temperature_compensation + # Typical value according the application note + self._tref = 0xB668 + self._off_x = self._off_y = self._off_z = offset # Put the device in a known state to start self.reset() + # Set resolution to the supplied level + self.resolution_x = self._res_x + self.resolution_y = self._res_y + self.resolution_z = self._res_z + + # Set filter to the supplied level + self.filter = self._filter + + # Set oversampling to the supplied level + self.oversampling = self._osr + # Set gain to the supplied level self.gain = self._gain_current + self.temperature_compensation = self._temperature_compensation - def _transceive(self, payload, rxlen=0): + # Set offsets to supplied level + self.offset_x = self._off_x + self.offset_y = self._off_y + self.offset_z = self._off_z + + def _transceive(self, payload: ReadableBuffer, rxlen: int = 0) -> bytearray: """ Writes the specified 'payload' to the sensor Returns the results of the write attempt. - :param bytearray payload: The byte array to write to the sensor - :param rxlen: (optional) The numbers of bytes to read back (default=0) - """ - # Write 'value' to the specified register - with self.i2c_device as i2c: - i2c.write(payload) + :param ReadableBuffer payload: The byte array to write to the sensor + :param int rxlen: numbers of bytes to read back. Defaults to :const:`0` + + """ # Read the response (+1 to account for the mandatory status byte!) - data = bytearray(rxlen+1) - while True: - # While busy, the sensor doesn't respond to reads. - try: - with self.i2c_device as i2c: - i2c.readinto(data) - # Make sure we have something in the response - if data[0]: - break - except OSError: - pass + data = bytearray(rxlen + 1) + + if len(payload) == 1: + # Transceive with repeated start + with self.i2c_device as i2c: + i2c.write_then_readinto(payload, data) + else: + # Write 'value' to the specified register + # TODO: Check this. It's weird that the write is accepted but the read is naked. + with self.i2c_device as i2c: + i2c.write(payload) + + while True: + try: + i2c.readinto(data) + if data[0]: + break + except OSError: + pass + # Track status byte - _status_last = data[0] + self._status_last = data[0] # Unpack data (status byte, big-endian 16-bit register value) if self._debug: - print("\t[{}]".format(time.monotonic())) + print(f"\t[{time.monotonic()}]") print("\t Writing :", [hex(b) for b in payload]) print("\tResponse :", [hex(b) for b in data]) print("\t Status :", hex(data[0])) return data @property - def last_status(self): + def last_status(self) -> int: """ - Returns the last status byte received from the sensor. + The last status byte received from the sensor. """ return self._status_last @property - def gain(self): + def gain(self) -> int: """ - Gets the current gain setting for the device. + The gain setting for the device. """ return self._gain_current @gain.setter - def gain(self, value): - """ - Sets the gain for the device. - """ + def gain(self, value: int) -> None: if value > GAIN_1X or value < GAIN_5X: raise ValueError("Invalid GAIN setting") if self._debug: - print("\tSetting gain: {}".format(value)) + print(f"\tSetting gain: {value}") self._gain_current = value - self._transceive(bytes([0x60, - 0x00, - self._gain_current << _GAIN_SHIFT | _HALLCONF, - 0x00])) + self._transceive( + bytes( + [ + _CMD_WR, + 0x00, + self._gain_current << _GAIN_SHIFT | _HALLCONF, + (_CMD_REG_CONF1 & 0x3F) << 2, + ] + ) + ) + + @property + def resolution_x(self) -> int: + """The X axis resolution.""" + return self._res_x + + @resolution_x.setter + def resolution_x(self, resolution: int) -> None: + self._set_resolution(0, resolution) + self._res_x = resolution + + @property + def resolution_y(self) -> int: + """The Y axis resolution.""" + return self._res_y + + @resolution_y.setter + def resolution_y(self, resolution: int) -> None: + self._set_resolution(1, resolution) + self._res_y = resolution + + @property + def resolution_z(self) -> int: + """The Z axis resolution.""" + return self._res_z + + @resolution_z.setter + def resolution_z(self, resolution: int) -> None: + self._set_resolution(2, resolution) + self._res_z = resolution + + def _set_resolution(self, axis: int, resolution: int) -> None: + if resolution not in { + RESOLUTION_16, + RESOLUTION_17, + RESOLUTION_18, + RESOLUTION_19, + }: + raise ValueError("Incorrect resolution setting.") + shift = (5, 7, 9)[axis] + mask = (0xFF9F, 0xFE7F, 0xF9FF)[axis] + reg = self.read_reg(_CMD_REG_CONF3) + reg &= mask + reg |= (resolution & 0x3) << shift + self.write_reg(_CMD_REG_CONF3, reg) + + @property + def filter(self) -> int: + """The filter level.""" + return self._filter + + @filter.setter + def filter(self, level: int) -> None: + if level not in range(8): + raise ValueError("Incorrect filter level.") + reg = self.read_reg(_CMD_REG_CONF3) + reg &= 0xFFE3 + reg |= (level & 0x7) << 2 + self.write_reg(_CMD_REG_CONF3, reg) + self._filter = level + + @property + def oversampling(self) -> int: + """The oversampling level.""" + return self._osr + + @oversampling.setter + def oversampling(self, level: int) -> None: + if level not in range(4): + raise ValueError("Incorrect oversampling level.") + reg = self.read_reg(_CMD_REG_CONF3) + reg &= 0xFFFC + reg |= level & 0x3 + self.write_reg(_CMD_REG_CONF3, reg) + self._osr = level + + @property + def temperature_compensation(self) -> bool: + """The temperature compensation setting""" + return self._temperature_compensation + + @temperature_compensation.setter + def temperature_compensation(self, temperature_compensation: bool) -> None: + reg = self.read_reg(_CMD_REG_CONF2) + t_cmp_bit = 10 + reg &= ~(1 << t_cmp_bit) + reg |= temperature_compensation << t_cmp_bit + self.write_reg(_CMD_REG_CONF2, reg) + self._temperature_compensation = temperature_compensation - def display_status(self): + @property + def offset_x(self) -> int: + """The X axis offset.""" + return self._off_x + + @offset_x.setter + def offset_x(self, offset: int) -> None: + self._set_offset(0, offset) + self._off_x = offset + + @property + def offset_y(self) -> int: + """The Y axis offset.""" + return self._off_y + + @offset_y.setter + def offset_y(self, offset: int) -> None: + self._set_offset(1, offset) + self._off_y = offset + + @property + def offset_z(self) -> int: + """The Z axis offset.""" + return self._off_z + + @offset_z.setter + def offset_z(self, offset: int) -> None: + self._set_offset(2, offset) + self._off_z = offset + + def _set_offset(self, axis: int, offset: int) -> None: + if offset < 0x0000 or offset > 0xFFFF: + raise ValueError("Incorrect offset setting.") + if axis == 0: + self.write_reg(_CMD_REG_CONF5, offset) + elif axis == 1: + self.write_reg(_CMD_REG_CONF6, offset) + elif axis == 2: + self.write_reg(_CMD_REG_CONF7, offset) + else: + raise ValueError("Incorrect axis setting.") + + def display_status(self) -> None: """ - Prints out the content of the last status byte in a human-readble + Prints out the content of the last status byte in a human-readable format. """ avail = 0 if self._status_last & 0b11 > 0: avail = 2 * (self._status_last & 0b11) + 2 - print("STATUS register = 0x{0:02X}".format(self._status_last)) + print(f"STATUS register = 0x{self._status_last:02X}") print("BURST Mode :", (self._status_last & (1 << 7)) > 0) print("WOC Mode :", (self._status_last & (1 << 6)) > 0) print("SM Mode :", (self._status_last & (1 << 5)) > 0) @@ -222,35 +473,170 @@ def display_status(self): print("Reset status :", (self._status_last & (1 << 2)) > 0) print("Response bytes available :", avail) - def reset(self): + def read_reg(self, reg: int) -> int: + """ + Gets the current value of the specified register. + + :param int reg: The register to read + """ + # Read register + payload = bytes([_CMD_RR, reg << 2]) + data = bytearray(3) + with self.i2c_device as i2c: + i2c.write_then_readinto(payload, data) + + # Unpack data (status byte, big-endian 16-bit register value) + self._status_last, val = struct.unpack(">BH", data) + if self._debug: + print(f"\t[{time.monotonic()}]") + print("\t Writing :", [hex(b) for b in payload]) + print("\tResponse :", [hex(b) for b in data]) + print("\t Status :", hex(data[0])) + return val + + def write_reg(self, reg: int, value: int) -> None: + """ + Writes the 16-bit value to the supplied register. + + :param int reg: The register to write to + :param int value: The value to write to the register + """ + self._transceive( + bytes( + [ + _CMD_WR, + value >> 8, # high byte + value & 0xFF, # low byte + reg << 2, # the register + ] + ) + ) + + def reset(self) -> None: """ Performs a software reset of the sensor. """ + self._transceive(bytes([_CMD_EX])) if self._debug: print("Resetting sensor") - time.sleep(2) - _status_last = self._transceive(bytes([_CMD_RT])) - return _status_last + time.sleep(0.002) + self._transceive(bytes([_CMD_RT])) + + # Read the temperature reference from register 0x24 + self._tref = self.read_reg(0x24) + if self._debug: + print(f"Tref = {hex(self._tref)}") - def read_data(self, delay=0.0, raw=False): + # burn a read post reset + try: + self.magnetic + except OSError: + pass + return self._status_last + + @property + def read_data(self) -> Tuple[int, int, int]: """ Reads a single X/Y/Z sample from the magnetometer. """ + + resolutions = {self.resolution_x, self.resolution_y, self.resolution_z} + valid_tcomp_resolutions = {RESOLUTION_16, RESOLUTION_17} + if self._temperature_compensation and not resolutions.issubset(valid_tcomp_resolutions): + resolutions_output = f"""Current Resolutions: +\tresolution_x: {self.resolution_x} +\tresolution_y: {self.resolution_y} +\tresolution_z: {self.resolution_z}""" + + raise ValueError( + "All resolutions must be RESOLUTION_16 or RESOLUTION_17" + f" if temperature compensation is enabled.\n {resolutions_output}" + ) + + # Set conversion delay based on filter and oversampling + delay = _TCONV_LOOKUP[self._filter][self._osr] / 1000 # per datasheet + delay *= 1.1 # plus a little + # Set the device to single measurement mode self._transceive(bytes([_CMD_SM | _CMD_AXIS_ALL])) - # Wait a bit + + # Insert a delay since we aren't using INTs for DRDY time.sleep(delay) - # Read 6 bytes back from 0x4E + + # Read the 'XYZ' data data = self._transceive(bytes([_CMD_RM | _CMD_AXIS_ALL]), 6) - # Parse the data (status byte, 3 * signed 16-bit integers) - self._status_last, m_x, m_y, m_z = struct.unpack(">Bhhh", data) - if raw: - # Return the raw int values if requested - return m_x, m_y, m_z + # Unpack status and raw int values + self._status_last = data[0] + m_x = self._unpack_axis_data(self._res_x, data[1:3]) + m_y = self._unpack_axis_data(self._res_y, data[3:5]) + m_z = self._unpack_axis_data(self._res_z, data[5:7]) - # Convert the units to uT based on gain and resolution - m_x *= _LSB_LOOKUP[self._gain_current][self._res_current][0] - m_y *= _LSB_LOOKUP[self._gain_current][self._res_current][0] - m_z *= _LSB_LOOKUP[self._gain_current][self._res_current][1] + # Return the raw int values if requested return m_x, m_y, m_z + + def _unpack_axis_data(self, resolution: int, data: ReadableBuffer) -> int: + # see datasheet + if resolution == RESOLUTION_19: + (value,) = struct.unpack(">H", data) + value -= 0x4000 + elif resolution == RESOLUTION_18: + (value,) = struct.unpack(">H", data) + value -= 0x8000 + elif self.temperature_compensation: + (value,) = struct.unpack(">H", data) + value -= 0x8000 + else: + value = struct.unpack(">h", data)[0] + return value + + @property + def magnetic(self) -> Tuple[float, float, float]: + """ + The processed magnetometer sensor values. + A 3-tuple of X, Y, Z axis values in microteslas that are signed floats. + """ + x, y, z = self.read_data + + # Check for valid HALLCONF value and set _LSB_LOOKUP index + if _HALLCONF == 0x0C: + hallconf_index = 0 + elif _HALLCONF == 0x00: + hallconf_index = 1 + else: + raise ValueError("Incorrect HALLCONF value, must be '0x0C' or '0x00'.") + + # Convert the raw integer values to uT based on gain and resolution + x *= _LSB_LOOKUP[hallconf_index][self._gain_current][self._res_x][0] + y *= _LSB_LOOKUP[hallconf_index][self._gain_current][self._res_y][0] + z *= _LSB_LOOKUP[hallconf_index][self._gain_current][self._res_z][1] + + return x, y, z + + @property + def temperature(self) -> float: + """ + Reads a single temperature sample from the magnetometer. + Temperature value in Celsius + """ + # Value taken from maximum time of temperature conversion on the datasheet section 12. + # maximum time for temperature conversion = 1603 us + delay = 0.1 + + # Set the device to single measurement mode + self._transceive(bytes([_CMD_SM | _CMD_TEMP])) + + time.sleep(delay) + + # Read the 'temp' data + data = self._transceive(bytes([_CMD_RM | _CMD_TEMP]), 2) + + # Unpack status and raw int values + self._status_last = data[0] + + # from https://www.melexis.com/-/media/files/documents/ + # application-notes/mlx90393-temperature-compensation-application-note-melexis.pdf + tvalue = struct.unpack(">H", data[1:3])[0] + # See previous link for conversion formula + + return 35 + ((tvalue - self._tref) / 45.2) diff --git a/docs/_static/favicon.ico.license b/docs/_static/favicon.ico.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/favicon.ico.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/api.rst b/docs/api.rst index 380a279..e00d06e 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,5 +4,8 @@ .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py) .. use this format as the module name: "adafruit_foo.foo" +API Reference +############# + .. automodule:: adafruit_mlx90393 :members: diff --git a/docs/api.rst.license b/docs/api.rst.license new file mode 100644 index 0000000..9aae48d --- /dev/null +++ b/docs/api.rst.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT diff --git a/docs/conf.py b/docs/conf.py index 4901bf1..372090f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,8 +1,12 @@ -# -*- coding: utf-8 -*- +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT +import datetime import os import sys -sys.path.insert(0, os.path.abspath('..')) + +sys.path.insert(0, os.path.abspath("..")) # -- General configuration ------------------------------------------------ @@ -10,10 +14,11 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.intersphinx', - 'sphinx.ext.napoleon', - 'sphinx.ext.todo', + "sphinx.ext.autodoc", + "sphinxcontrib.jquery", + "sphinx.ext.intersphinx", + "sphinx.ext.napoleon", + "sphinx.ext.todo", ] # TODO: Please Read! @@ -23,41 +28,57 @@ # autodoc_mock_imports = ["digitalio", "busio"] -intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/busdevice/en/latest/', None),'Register': ('https://circuitpython.readthedocs.io/projects/register/en/latest/', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)} +intersphinx_mapping = { + "python": ("https://docs.python.org/3", None), + "BusDevice": ( + "https://docs.circuitpython.org/projects/busdevice/en/latest/", + None, + ), + "Register": ( + "https://docs.circuitpython.org/projects/register/en/latest/", + None, + ), + "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None), +} # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] -source_suffix = '.rst' +source_suffix = ".rst" # The master toctree document. -master_doc = 'index' +master_doc = "index" # General information about the project. -project = u'Adafruit_CircuitPython_MLX90393 Library' -copyright = u'2018 Kevin Townsend' -author = u'Kevin Townsend' +project = "Adafruit MLX90393 Library" +creation_year = "2018" +current_year = str(datetime.datetime.now().year) +year_duration = ( + current_year if current_year == creation_year else creation_year + " - " + current_year +) +copyright = year_duration + " Kevin Townsend" +author = "Kevin Townsend" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = u'1.0' +version = "1.0" # The full version, including alpha/beta/rc tags. -release = u'1.0' +release = "1.0" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # # 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. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.env', 'CODE_OF_CONDUCT.md'] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".env", "CODE_OF_CONDUCT.md"] # The reST default role (used for this markup: `text`) to use for all # documents. @@ -69,7 +90,7 @@ add_function_parentheses = True # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = "sphinx" # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False @@ -84,59 +105,52 @@ # 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, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = ["_static"] # The name of an image file (relative to this directory) to use as a favicon of # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. # -html_favicon = '_static/favicon.ico' +html_favicon = "_static/favicon.ico" # Output file base name for HTML help builder. -htmlhelp_basename = 'Adafruit_circuitpython_mlx90393Librarydoc' +htmlhelp_basename = "AdafruitMLX90393Librarydoc" # -- Options for LaTeX output --------------------------------------------- latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - # 'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - # - # 'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # - # 'preamble': '', - - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'Adafruit_CircuitPython_MLX90393Library.tex', u'Adafruit_CircuitPython_MLX90393 Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitMLX90393Library.tex", + "Adafruit MLX90393 Library Documentation", + author, + "manual", + ), ] # -- Options for manual page output --------------------------------------- @@ -144,8 +158,13 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'Adafruit_CircuitPython_MLX90393library', u'Adafruit_CircuitPython_MLX90393 Library Documentation', - [author], 1) + ( + master_doc, + "AdafruitMLX90393library", + "Adafruit MLX90393 Library Documentation", + [author], + 1, + ) ] # -- Options for Texinfo output ------------------------------------------- @@ -154,7 +173,13 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'Adafruit_CircuitPython_MLX90393Library', u' Adafruit_CircuitPython_MLX90393 Library Documentation', - author, 'Adafruit_CircuitPython_MLX90393Library', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "Adafruit_CircuitPython_MLX90393Library", + " Adafruit_CircuitPython_MLX90393 Library Documentation", + author, + "Adafruit_CircuitPython_MLX90393Library", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/docs/examples.rst b/docs/examples.rst index 4916403..e3eb8d9 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -3,6 +3,15 @@ Simple test Ensure your device works with this simple test. -.. literalinclude:: ../examples/adafruit_mlx90393_simpletest.py - :caption: examples/adafruit_mlx90393_simpletest.py +.. literalinclude:: ../examples/mlx90393_simpletest.py + :caption: examples/mlx90393_simpletest.py + :linenos: + +Temperature test +----------------- + +Example showing how to measure temperature with the sensor + +.. literalinclude:: ../examples/mlx90393_temperature.py + :caption: examples/mlx90393_temperature.py :linenos: diff --git a/docs/examples.rst.license b/docs/examples.rst.license new file mode 100644 index 0000000..9aae48d --- /dev/null +++ b/docs/examples.rst.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT diff --git a/docs/index.rst b/docs/index.rst index 7341ccf..e811ffe 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,14 +23,19 @@ Table of Contents .. toctree:: :caption: Tutorials + Adafruit Wide-Range Triple-axis Magnetometer - MLX90393 Learning Guide + .. toctree:: :caption: Related Products + Adafruit Wide-Range Triple-axis Magnetometer - MLX90393 + .. 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/index.rst.license b/docs/index.rst.license new file mode 100644 index 0000000..9aae48d --- /dev/null +++ b/docs/index.rst.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..979f568 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,7 @@ +# SPDX-FileCopyrightText: 2021 Kattni Rembor for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +sphinx +sphinxcontrib-jquery +sphinx-rtd-theme diff --git a/examples/adafruit_mlx90393_simpletest.py b/examples/adafruit_mlx90393_simpletest.py deleted file mode 100755 index 6bdadaa..0000000 --- a/examples/adafruit_mlx90393_simpletest.py +++ /dev/null @@ -1,18 +0,0 @@ -import time -import busio -import board - -import adafruit_mlx90393 - -I2C_BUS = busio.I2C(board.SCL, board.SDA) -SENSOR = adafruit_mlx90393.MLX90393(I2C_BUS, gain=adafruit_mlx90393.GAIN_1X) - -while True: - MX, MY, MZ = SENSOR.read_data(delay=1.0, raw=False) - print("[{}]".format(time.monotonic())) - print("X: {} uT".format(MX)) - print("Y: {} uT".format(MY)) - print("Z: {} uT".format(MZ)) - # Display the status field if an error occured, etc. - if SENSOR.last_status > adafruit_mlx90393.STATUS_OK: - SENSOR.display_status() diff --git a/examples/mlx90393_simpletest.py b/examples/mlx90393_simpletest.py new file mode 100755 index 0000000..2a26f34 --- /dev/null +++ b/examples/mlx90393_simpletest.py @@ -0,0 +1,26 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + +import time + +import board + +import adafruit_mlx90393 + +i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller +try: + SENSOR = adafruit_mlx90393.MLX90393(i2c, gain=adafruit_mlx90393.GAIN_1X) +except ValueError: + SENSOR = adafruit_mlx90393.MLX90393(i2c, gain=adafruit_mlx90393.GAIN_1X, address=0x18) + +while True: + MX, MY, MZ = SENSOR.magnetic + print(f"[{time.monotonic()}]") + print(f"X: {MX} uT") + print(f"Y: {MY} uT") + print(f"Z: {MZ} uT") + # Display the status field if an error occured, etc. + if SENSOR.last_status > adafruit_mlx90393.STATUS_OK: + SENSOR.display_status() + time.sleep(1.0) diff --git a/examples/mlx90393_temperature.py b/examples/mlx90393_temperature.py new file mode 100644 index 0000000..cefc9e5 --- /dev/null +++ b/examples/mlx90393_temperature.py @@ -0,0 +1,26 @@ +# SPDX-FileCopyrightText: 2023 Jose D. Montoya +# SPDX-License-Identifier: MIT + +import time + +import board + +import adafruit_mlx90393 + +i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller +try: + SENSOR = adafruit_mlx90393.MLX90393(i2c, gain=adafruit_mlx90393.GAIN_1X) +except ValueError: + SENSOR = adafruit_mlx90393.MLX90393(i2c, gain=adafruit_mlx90393.GAIN_1X, address=0x18) + + +while True: + temp = SENSOR.temperature + + print(f"Temperature: {temp} °C") + + # Display the status field if an error occurred, etc. + if SENSOR.last_status > adafruit_mlx90393.STATUS_OK: + SENSOR.display_status() + 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..3f55237 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,47 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +[build-system] +requires = [ + "setuptools", + "wheel", + "setuptools-scm", +] + +[project] +name = "adafruit-circuitpython-mlx90393" +description = "CircuitPython driver for the MLX90393 3-axis magnetometer." +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_MLX90393"} +keywords = [ + "adafruit", + "three-axis", + "magnetometer", + "magnet", + "mlx90393", + "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_mlx90393"] + +[tool.setuptools.dynamic] +dependencies = {file = ["requirements.txt"]} +optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} diff --git a/requirements.txt b/requirements.txt index 3031961..7d01776 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,7 @@ -Adafruit-Blinka +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +Adafruit-Blinka>=7.0.0 adafruit-circuitpython-busdevice +adafruit-circuitpython-typing 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 72a0c19..0000000 --- a/setup.py +++ /dev/null @@ -1,60 +0,0 @@ -"""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-mlx90393', - - use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='CircuitPython driver for the MLX90393 3-axis magnetometer.', - long_description=long_description, - long_description_content_type='text/x-rst', - - # The project's main homepage. - url='https://github.com/adafruit/Adafruit_CircuitPython_MLX90393', - - # 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 three-axis magnetometer magnet mlx90393 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_mlx90393'], -)