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 index 11ce574..041a337 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + name: Build CI on: [pull_request, push] @@ -6,45 +10,5 @@ jobs: test: runs-on: ubuntu-latest steps: - - name: Dump GitHub context - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - run: echo "$GITHUB_CONTEXT" - - name: Translate Repo Name For Build Tools filename_prefix - id: repo-name - run: | - echo ::set-output name=repo-name::$( - echo ${{ github.repository }} | - awk -F '\/' '{ print tolower($2) }' | - tr '_' '-' - ) - - name: Set up Python 3.6 - uses: actions/setup-python@v1 - with: - python-version: 3.6 - - name: Versions - run: | - python3 --version - - name: Checkout Current Repo - uses: actions/checkout@v1 - with: - submodules: true - - name: Checkout tools repo - uses: actions/checkout@v2 - with: - repository: adafruit/actions-ci-circuitpython-libs - path: actions-ci - - name: Install deps - run: | - source actions-ci/install.sh - - name: Library version - run: git describe --dirty --always --tags - - name: PyLint - run: | - pylint $( find . -path './adafruit*.py' ) - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace $( find . -path "./examples/*.py" )) - - name: Build assets - run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - - name: Build docs - working-directory: docs - run: sphinx-build -E -W -b html . _build/html + - name: 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.yml b/.github/workflows/release.yml deleted file mode 100644 index 18efb9c..0000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,81 +0,0 @@ -name: Release Actions - -on: - release: - types: [published] - -jobs: - upload-release-assets: - runs-on: ubuntu-latest - steps: - - name: Dump GitHub context - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - run: echo "$GITHUB_CONTEXT" - - name: Translate Repo Name For Build Tools filename_prefix - id: repo-name - run: | - echo ::set-output name=repo-name::$( - echo ${{ github.repository }} | - awk -F '\/' '{ print tolower($2) }' | - tr '_' '-' - ) - - name: Set up Python 3.6 - uses: actions/setup-python@v1 - with: - python-version: 3.6 - - name: Versions - run: | - python3 --version - - name: Checkout Current Repo - uses: actions/checkout@v1 - with: - submodules: true - - name: Checkout tools repo - uses: actions/checkout@v2 - with: - repository: adafruit/actions-ci-circuitpython-libs - path: actions-ci - - name: Install deps - run: | - source actions-ci/install.sh - - name: Build assets - run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - - name: Upload Release Assets - # the 'official' actions version does not yet support dynamically - # supplying asset names to upload. @csexton's version chosen based on - # discussion in the issue below, as its the simplest to implement and - # allows for selecting files with a pattern. - # https://github.com/actions/upload-release-asset/issues/4 - #uses: actions/upload-release-asset@v1.0.1 - uses: csexton/release-asset-action@master - with: - pattern: "bundles/*" - github-token: ${{ secrets.GITHUB_TOKEN }} - - upload-pypi: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v1 - - name: Check For setup.py - id: need-pypi - run: | - echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) - - name: Set up Python - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - uses: actions/setup-python@v1 - with: - python-version: '3.x' - - name: Install dependencies - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - run: | - python -m pip install --upgrade pip - pip install setuptools wheel twine - - name: Build and publish - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - env: - TWINE_USERNAME: ${{ secrets.pypi_username }} - TWINE_PASSWORD: ${{ secrets.pypi_password }} - run: | - python setup.py sdist - twine upload dist/* diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml new file mode 100644 index 0000000..9acec60 --- /dev/null +++ b/.github/workflows/release_gh.yml @@ -0,0 +1,19 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: GitHub Release Actions + +on: + release: + types: [published] + +jobs: + upload-release-assets: + runs-on: ubuntu-latest + steps: + - name: Run GitHub Release CI workflow + uses: adafruit/workflows-circuitpython-libs/release-gh@main + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + upload-url: ${{ github.event.release.upload_url }} diff --git a/.github/workflows/release_pypi.yml b/.github/workflows/release_pypi.yml new file mode 100644 index 0000000..65775b7 --- /dev/null +++ b/.github/workflows/release_pypi.yml @@ -0,0 +1,19 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: PyPI Release Actions + +on: + release: + types: [published] + +jobs: + upload-release-assets: + runs-on: ubuntu-latest + steps: + - name: Run PyPI Release CI workflow + uses: adafruit/workflows-circuitpython-libs/release-pypi@main + with: + pypi-username: ${{ secrets.pypi_username }} + pypi-password: ${{ secrets.pypi_password }} diff --git a/.gitignore b/.gitignore index e7e0f2d..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 -bundles +.venv + +# MacOS-specific files *.DS_Store -.eggs -dist -**/*.egg-info + +# IDE-specific files +.idea .vscode +*~ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml 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/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 7ca3a1d..be1966c 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 @@ -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 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, 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, @danh#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 08f18de..fc8d5ba 100644 --- a/README.rst +++ b/README.rst @@ -2,19 +2,23 @@ Introduction ============ .. image:: https://readthedocs.org/projects/adafruit-circuitpython-lsm6dsox/badge/?version=latest - :target: https://circuitpython.readthedocs.io/projects/lsm6dsox/en/latest/ + :target: https://docs.circuitpython.org/projects/lsm6dsox/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://github.com/adafruit/Adafruit_CircuitPython_LSM6DSOX/workflows/Build%20CI/badge.svg - :target: https://github.com/adafruit/Adafruit_CircuitPython_LSM6DSOX/actions +.. image:: https://github.com/adafruit/Adafruit_CircuitPython_LSM6DS/workflows/Build%20CI/badge.svg + :target: https://github.com/adafruit/Adafruit_CircuitPython_LSM6DS/actions :alt: Build Status -CircuitPython library for the ST LSM6DSOX 6-axis Accelerometer and Gyro +.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json + :target: https://github.com/astral-sh/ruff + :alt: Code Style: Ruff + +CircuitPython helper library for the LSM6DS family of motion sensors from ST Dependencies @@ -27,60 +31,60 @@ This driver depends on: Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading -`the Adafruit library and driver bundle `_. +`the Adafruit library and driver bundle `_. Installing from PyPI ===================== On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from -PyPI `_. To install for current user: +PyPI `_. To install for current user: .. code-block:: shell - pip3 install adafruit-circuitpython-lsm6dsox + pip3 install adafruit-circuitpython-lsm6ds To install system-wide (this may be required in some cases): .. code-block:: shell - sudo pip3 install adafruit-circuitpython-lsm6dsox + sudo pip3 install adafruit-circuitpython-lsm6ds 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 - pip3 install adafruit-circuitpython-lsm6dsox + python3 -m venv .venv + source .venv/bin/activate + pip3 install adafruit-circuitpython-lsm6ds Usage Example ============= -.. code-block:: python +.. code-block:: python3 import time import board - import busio - import adafruit_lsm6ds - - i2c = busio.I2C(board.SCL, board.SDA) + from adafruit_lsm6ds.lsm6dsox import LSM6DSOX - sox = adafruit_lsm6ds.LSM6DSOX(i2c) + i2c = board.I2C() # uses board.SCL and board.SDA + sox = LSM6DSOX(i2c) while True: print("Acceleration: X:%.2f, Y: %.2f, Z: %.2f m/s^2"%(sox.acceleration)) - print("Gyro X:%.2f, Y: %.2f, Z: %.2f degrees/s"%(sox.gyro)) + print("Gyro X:%.2f, Y: %.2f, Z: %.2f radians/s"%(sox.gyro)) print("") time.sleep(0.5) +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. - -Documentation -============= - -For information on building library documentation, please check out `this guide `_. 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_lsm6ds.py b/adafruit_lsm6ds.py deleted file mode 100644 index 813b98a..0000000 --- a/adafruit_lsm6ds.py +++ /dev/null @@ -1,379 +0,0 @@ -# The MIT License (MIT) -# -# Copyright (c) 2019 Bryan Siepert 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. -""" -`adafruit_lsm6ds` -================================================================================ - -CircuitPython library for the ST LSM6DSOX 6-axis Accelerometer and Gyro - - -* Author(s): Bryan Siepert - -Implementation Notes --------------------- - -**Hardware:** - -* Adafruit LSM6DSOX Breakout - - -**Software and Dependencies:** - -* Adafruit CircuitPython firmware for the supported boards: - https://github.com/adafruit/circuitpython/releases - - -* Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice -* Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register -""" - -__version__ = "0.0.0-auto.0" -__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_LSM6DSOX.git" -from time import sleep -from micropython import const -import adafruit_bus_device.i2c_device as i2c_device -from adafruit_register.i2c_struct import ROUnaryStruct, Struct -from adafruit_register.i2c_bits import RWBits -from adafruit_register.i2c_bit import RWBit -__version__ = "0.0.0-auto.0" -__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_LSM6DSOX.git" - - -_LSM6DS_DEFAULT_ADDRESS = const(0x6a) - -_LSM6DS_CHIP_ID = const(0x6C) -_ISM330DHCT_CHIP_ID = const(0x6B) -_LSM6DS33_CHIP_ID = const(0x69) - -_LSM6DS_FUNC_CFG_ACCESS = const(0x1) -_LSM6DS_PIN_CTRL = const(0x2) -_LSM6DS_UI_INT_OIS = const(0x6F) -_LSM6DS_WHOAMI = const(0xF) -_LSM6DS_CTRL1_XL = const(0x10) -_LSM6DS_CTRL2_G = const(0x11) -_LSM6DS_CTRL3_C = const(0x12) -_LSM6DS_CTRL_5_C = const(0x14) -_LSM6DS_MASTER_CONFIG = const(0x14) -_LSM6DS_CTRL9_XL = const(0x18) -_LSM6DS_OUT_TEMP_L = const(0x20) -_LSM6DS_OUT_TEMP_H = const(0x21) -_LSM6DS_OUTX_L_G = const(0x22) -_LSM6DS_OUTX_H_G = const(0x23) -_LSM6DS_OUTY_L_G = const(0x24) -_LSM6DS_OUTY_H_G = const(0x25) -_LSM6DS_OUTZ_L_G = const(0x26) -_LSM6DS_OUTZ_H_G = const(0x27) -_LSM6DS_OUTX_L_A = const(0x28) -_LSM6DS_OUTX_H_A = const(0x29) -_LSM6DS_OUTY_L_A = const(0x2A) -_LSM6DS_OUTY_H_A = const(0x2B) -_LSM6DS_OUTZ_L_A = const(0x2C) -_LSM6DS_OUTZ_H_A = const(0x2D) - -_MILLI_G_TO_ACCEL = 0.00980665 - -class CV: - """struct helper""" - - @classmethod - def add_values(cls, value_tuples): - "creates CV entires" - cls.string = {} - cls.lsb = {} - - for value_tuple in value_tuples: - name, value, string, lsb = value_tuple - setattr(cls, name, value) - cls.string[value] = string - cls.lsb[value] = lsb - - @classmethod - def is_valid(cls, value): - "Returns true if the given value is a member of the CV" - return value in cls.string - -class AccelRange(CV): - """Options for ``accelerometer_range``""" - pass #pylint: disable=unnecessary-pass - -AccelRange.add_values(( - ('RANGE_2G', 0, 2, 0.061), - ('RANGE_16G', 1, 16, 0.488), - ('RANGE_4G', 2, 4, 0.122), - ('RANGE_8G', 3, 8, 0.244) -)) - -class GyroRange(CV): - """Options for ``gyro_data_range``""" - pass #pylint: disable=unnecessary-pass - -GyroRange.add_values(( - ('RANGE_125_DPS', 125, 125, 4.375), - ('RANGE_250_DPS', 0, 250, 8.75), - ('RANGE_500_DPS', 1, 500, 17.50), - ('RANGE_1000_DPS', 2, 1000, 35.0), - ('RANGE_2000_DPS', 3, 2000, 70.0), - ('RANGE_4000_DPS', 4000, 4000, 140.0) -)) - -class Rate(CV): - """Options for ``accelerometer_data_rate`` and ``gyro_data_rate``""" - pass #pylint: disable=unnecessary-pass - -Rate.add_values(( - ('RATE_SHUTDOWN', 0, 0, None), - ('RATE_12_5_HZ', 1, 12.5, None), - ('RATE_26_HZ', 2, 26.0, None), - ('RATE_52_HZ', 3, 52.0, None), - ('RATE_104_HZ', 4, 104.0, None), - ('RATE_208_HZ', 5, 208.0, None), - ('RATE_416_HZ', 6, 416.0, None), - ('RATE_833_HZ', 7, 833.0, None), - ('RATE_1_66K_HZ', 8, 1066.0, None), - ('RATE_3_33K_HZ', 9, 3033.0, None), - ('RATE_6_66K_HZ', 10, 6066.0, None), - ('RATE_1_6_HZ', 11, 1.6, None) -)) - - -class LSM6DS: #pylint: disable=too-many-instance-attributes - - """Driver for the LSM6DSOX 6-axis accelerometer and gyroscope. - - :param ~busio.I2C i2c_bus: The I2C bus the LSM6DSOX is connected to. - :param address: The I2C slave address of the sensor - - """ - -#ROUnaryStructs: - _chip_id = ROUnaryStruct(_LSM6DS_WHOAMI, "`_ (Product ID: 4438) + +* `Adafruit ISM330DHCX - 6 DoF IMU - Accelerometer and Gyroscope + `_ (Product ID: 4502) + +* `Adafruit LSM6DSO32 6-DoF Accelerometer and Gyroscope + `_ (Product ID: 4692) + +* `Adafruit LSM6DS33 6-DoF Accel + Gyro IMU + `_ (Product ID: 4480) + +* `Adafruit ISM330DHCX + LIS3MDL FeatherWing - High Precision 9-DoF IMU + `_ (Product ID: 4569) + +* `Adafruit LSM6DSOX + LIS3MDL - Precision 9 DoF IMU + `_ (Product ID: 4517) + +* `Adafruit LSM6DS33 + LIS3MDL - 9 DoF IMU with Accel / Gyro / Mag + `_ (Product ID: 4485) + +* `Adafruit LSM6DSOX + LIS3MDL FeatherWing - Precision 9-DoF IMU + `_ (Product ID: 4565) + + +**Software and Dependencies:** + +* Adafruit CircuitPython firmware for the supported boards: + https://circuitpython.org/downloads +* Adafruit's Bus Device library: + https://github.com/adafruit/Adafruit_CircuitPython_BusDevice +* Adafruit's Register library: + https://github.com/adafruit/Adafruit_CircuitPython_Register + +""" + +__version__ = "0.0.0+auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_LSM6DS.git" + +import struct +from math import radians +from time import sleep + +from adafruit_bus_device import i2c_device +from adafruit_register.i2c_bit import ROBit, RWBit +from adafruit_register.i2c_bits import RWBits +from adafruit_register.i2c_struct import ROUnaryStruct, Struct +from micropython import const + +try: + from typing import Optional, Tuple + + from busio import I2C +except ImportError: + pass + + +class CV: + """struct helper""" + + @classmethod + def add_values(cls, value_tuples: Tuple[str, int, float, Optional[float]]) -> None: + "creates CV entires" + cls.string = {} + cls.lsb = {} + + for value_tuple in value_tuples: + name, value, string, lsb = value_tuple + setattr(cls, name, value) + cls.string[value] = string + cls.lsb[value] = lsb + + @classmethod + def is_valid(cls, value: int) -> bool: + """Returns true if the given value is a member of the CV""" + return value in cls.string + + +class AccelRange(CV): + """Options for ``accelerometer_range``""" + + +class GyroRange(CV): + """Options for ``gyro_data_range``""" + + +class Rate(CV): + """Options for ``accelerometer_data_rate`` and ``gyro_data_rate``""" + + +Rate.add_values( + ( + ("RATE_SHUTDOWN", 0, 0, None), + ("RATE_12_5_HZ", 1, 12.5, None), + ("RATE_26_HZ", 2, 26.0, None), + ("RATE_52_HZ", 3, 52.0, None), + ("RATE_104_HZ", 4, 104.0, None), + ("RATE_208_HZ", 5, 208.0, None), + ("RATE_416_HZ", 6, 416.0, None), + ("RATE_833_HZ", 7, 833.0, None), + ("RATE_1_66K_HZ", 8, 1666.0, None), + ("RATE_3_33K_HZ", 9, 3332.0, None), + ("RATE_6_66K_HZ", 10, 6664.0, None), + ("RATE_1_6_HZ", 11, 1.6, None), + ) +) + + +class AccelHPF(CV): + """Options for the accelerometer high pass filter""" + + +AccelHPF.add_values( + ( + ("SLOPE", 0, 0, None), + ("HPF_DIV100", 1, 0, None), + ("HPF_DIV9", 2, 0, None), + ("HPF_DIV400", 3, 0, None), + ) +) + +LSM6DS_DEFAULT_ADDRESS = const(0x6A) + +LSM6DS_CHIP_ID = const(0x6C) + +_LSM6DS_MLC_INT1 = const(0x0D) +_LSM6DS_WHOAMI = const(0xF) +_LSM6DS_CTRL1_XL = const(0x10) +_LSM6DS_CTRL2_G = const(0x11) +_LSM6DS_CTRL3_C = const(0x12) +_LSM6DS_CTRL8_XL = const(0x17) +_LSM6DS_CTRL9_XL = const(0x18) +_LSM6DS_CTRL10_C = const(0x19) +_LSM6DS_ALL_INT_SRC = const(0x1A) +_LSM6DS_OUT_TEMP_L = const(0x20) +_LSM6DS_OUTX_L_G = const(0x22) +_LSM6DS_OUTX_L_A = const(0x28) +_LSM6DS_MLC_STATUS = const(0x38) +_LSM6DS_STEP_COUNTER = const(0x4B) +_LSM6DS_TAP_CFG0 = const(0x56) +_LSM6DS_TAP_CFG = const(0x58) +_LSM6DS_MLC0_SRC = const(0x70) +_MILLI_G_TO_ACCEL = 0.00980665 +_TEMPERATURE_SENSITIVITY = 256 +_TEMPERATURE_OFFSET = 25.0 + +_LSM6DS_EMB_FUNC_EN_A = const(0x04) +_LSM6DS_EMB_FUNC_EN_B = const(0x05) +_LSM6DS_FUNC_CFG_ACCESS = const(0x01) +_LSM6DS_FUNC_CFG_BANK_USER = const(0) +_LSM6DS_FUNC_CFG_BANK_HUB = const(1) +_LSM6DS_FUNC_CFG_BANK_EMBED = const(2) + + +class LSM6DS: + """Driver for the LSM6DSOX 6-axis accelerometer and gyroscope. + + :param ~busio.I2C i2c_bus: The I2C bus the LSM6DSOX is connected to. + :param int address: TThe I2C device address. Defaults to :const:`0x6A` + + """ + + # ROUnaryStructs: + _chip_id = ROUnaryStruct(_LSM6DS_WHOAMI, " None: + self._cached_accel_range = None + self._cached_gyro_range = None + + self.i2c_device = i2c_device.I2CDevice(i2c_bus, address) + if self.CHIP_ID is None: + raise AttributeError("LSM6DS Parent Class cannot be directly instantiated") + if self._chip_id != self.CHIP_ID: + raise RuntimeError("Failed to find %s - check your wiring!" % self.__class__.__name__) + self.reset() + if not hasattr(GyroRange, "string"): + self._add_gyro_ranges() + self._bdu = True + + self._add_accel_ranges() + self.accelerometer_data_rate = Rate.RATE_104_HZ + self.gyro_data_rate = Rate.RATE_104_HZ + + self.accelerometer_range = AccelRange.RANGE_4G + self.gyro_range = GyroRange.RANGE_250_DPS + # Load and configure MLC if UCF file is provided + if ucf is not None: + self.load_mlc(ucf) + + def reset(self) -> None: + "Resets the sensor's configuration into an initial state" + self._sw_reset = True + while self._sw_reset: + sleep(0.001) + + @staticmethod + def _add_gyro_ranges() -> None: + GyroRange.add_values( + ( + ("RANGE_125_DPS", 125, 125, 4.375), + ("RANGE_250_DPS", 0, 250, 8.75), + ("RANGE_500_DPS", 1, 500, 17.50), + ("RANGE_1000_DPS", 2, 1000, 35.0), + ("RANGE_2000_DPS", 3, 2000, 70.0), + ) + ) + + @staticmethod + def _add_accel_ranges() -> None: + AccelRange.add_values( + ( + ("RANGE_2G", 0, 2, 0.061), + ("RANGE_16G", 1, 16, 0.488), + ("RANGE_4G", 2, 4, 0.122), + ("RANGE_8G", 3, 8, 0.244), + ) + ) + + @property + def acceleration(self) -> Tuple[float, float, float]: + """The x, y, z acceleration values returned in a 3-tuple and are in m / s ^ 2.""" + raw_accel_data = self._raw_accel_data + + x = self._scale_xl_data(raw_accel_data[0]) + y = self._scale_xl_data(raw_accel_data[1]) + z = self._scale_xl_data(raw_accel_data[2]) + + return (x, y, z) + + @property + def gyro(self) -> Tuple[float, float, float]: + """The x, y, z angular velocity values returned in a 3-tuple and are in radians / second""" + raw_gyro_data = self._raw_gyro_data + x, y, z = (radians(self._scale_gyro_data(i)) for i in raw_gyro_data) + return (x, y, z) + + def _scale_xl_data(self, raw_measurement: int) -> float: + return raw_measurement * AccelRange.lsb[self._cached_accel_range] * _MILLI_G_TO_ACCEL + + def _scale_gyro_data(self, raw_measurement: int) -> float: + return raw_measurement * GyroRange.lsb[self._cached_gyro_range] / 1000 + + @property + def accelerometer_range(self) -> int: + """Adjusts the range of values that the sensor can measure, from +/- 2G to +/-16G + Note that larger ranges will be less accurate. Must be an ``AccelRange``""" + return self._cached_accel_range + + @accelerometer_range.setter + def accelerometer_range(self, value: int) -> None: + if not AccelRange.is_valid(value): + raise AttributeError("range must be an `AccelRange`") + self._accel_range = value + self._cached_accel_range = value + sleep(0.2) # needed to let new range settle + + @property + def gyro_range(self) -> int: + """Adjusts the range of values that the sensor can measure, from 125 Degrees/s to 2000 + degrees/s. Note that larger ranges will be less accurate. Must be a ``GyroRange``. + """ + return self._cached_gyro_range + + @gyro_range.setter + def gyro_range(self, value: int) -> None: + self._set_gyro_range(value) + sleep(0.2) + + def _set_gyro_range(self, value: int) -> None: + if not GyroRange.is_valid(value): + raise AttributeError("range must be a `GyroRange`") + + # range uses `FS_G` enum + if value <= GyroRange.RANGE_2000_DPS: + self._gyro_range_125dps = False + self._gyro_range = value + # range uses the `FS_125` bit + if value is GyroRange.RANGE_125_DPS: + self._gyro_range_125dps = True + + self._cached_gyro_range = value # needed to let new range settle + + @property + def accelerometer_data_rate(self) -> int: + """Select the rate at which the accelerometer takes measurements. Must be a ``Rate``""" + return self._accel_data_rate + + @accelerometer_data_rate.setter + def accelerometer_data_rate(self, value: int) -> None: + if not Rate.is_valid(value): + raise AttributeError("accelerometer_data_rate must be a `Rate`") + + self._accel_data_rate = value + # sleep(.2) # needed to let new range settle + + @property + def gyro_data_rate(self) -> int: + """Select the rate at which the gyro takes measurements. Must be a ``Rate``""" + return self._gyro_data_rate + + @gyro_data_rate.setter + def gyro_data_rate(self, value: int) -> None: + if not Rate.is_valid(value): + raise AttributeError("gyro_data_rate must be a `Rate`") + + self._gyro_data_rate = value + # sleep(.2) # needed to let new range settle + + @property + def pedometer_enable(self) -> bool: + """Whether the pedometer function on the accelerometer is enabled""" + return self._ped_enable and self._func_enable + + @pedometer_enable.setter + def pedometer_enable(self, enable: bool) -> None: + self._ped_enable = enable + self._func_enable = enable + self._pedometer_reset = enable + + @property + def high_pass_filter(self) -> int: + """The high pass filter applied to accelerometer data""" + return self._high_pass_filter + + @high_pass_filter.setter + def high_pass_filter(self, value: int) -> None: + if not AccelHPF.is_valid(value): + raise AttributeError("range must be an `AccelHPF`") + self._high_pass_filter = value + + @property + def temperature(self) -> float: + """Temperature in Celsius""" + # Data from Datasheet Table 4.3 + # Temp range -40 to 85 Celsius + # T_ADC_RES = ADC Res 16 bit + # Stabilization time 500 μs + + temp = self._raw_temp_data[0] + + return temp / _TEMPERATURE_SENSITIVITY + _TEMPERATURE_OFFSET + + def _set_embedded_functions(self, enable, emb_ab=None): + """Enable/disable embedded functions - returns prior settings when disabled""" + self._mem_bank = 1 + if enable: + self._emb_func_en_a = emb_ab[0] + self._emb_func_en_b = emb_ab[1] + else: + emb_a = self._emb_func_en_a + emb_b = self._emb_func_en_b + self._emb_func_en_a = (emb_a[0] & 0xC7,) + self._emb_func_en_b = (emb_b[0] & 0xE6,) + emb_ab = (emb_a, emb_b) + + self._mem_bank = 0 + return emb_ab + + def load_mlc(self, ucf): + """Load MLC configuration file into sensor""" + buf = bytearray(2) + with self.i2c_device as i2c: + # Load MLC config from file + with open(ucf) as ucf_file: + for line in ucf_file: + if line.startswith("Ac"): + command = [int(v, 16) for v in line.strip().split(" ")[1:3]] + buf[0] = command[0] + buf[1] = command[1] + i2c.write(buf) + + # Disable embudded function -- save current settings + emb_ab = self._set_embedded_functions(False) + + # Disable I3C interface + self._i3c_disable = 1 + + # Enable Block Data Update + self._block_data_enable = 1 + + # Route signals on interrupt pin 1 + self._mem_bank = 1 + self._route_int1 &= 1 + self._mem_bank = 0 + + # Configure interrupt pin mode + self._tap_latch = 1 + self._tap_clear = 1 + + # Enabble Embedded Functions using previously stored settings + self._set_embedded_functions(True, emb_ab) + + def read_mlc_output(self): + """Read MLC results""" + buf = None + if self._mlc_status: + self._mem_bank = 1 + buf = self._mlc0_src + self._mem_bank = 0 + return buf diff --git a/adafruit_lsm6ds/ism330dhcx.py b/adafruit_lsm6ds/ism330dhcx.py new file mode 100644 index 0000000..4e33f7f --- /dev/null +++ b/adafruit_lsm6ds/ism330dhcx.py @@ -0,0 +1,94 @@ +# SPDX-FileCopyrightText: Copyright (c) 2020 Bryan Siepert for Adafruit Industries +# +# SPDX-License-Identifier: MIT +""" +This module provides the `adafruit_lsm6ds.ism330dhcx` subclass of LSM6DS sensors +================================================================================== +""" + +from time import sleep + +from . import LSM6DS, LSM6DS_DEFAULT_ADDRESS, GyroRange, RWBit, const + +try: + import typing + + from busio import I2C +except ImportError: + pass + +_LSM6DS_CTRL2_G = const(0x11) + + +class ISM330DHCX(LSM6DS): + """Driver for the ISM330DHCX 6-axis accelerometer and gyroscope. + + :param ~busio.I2C i2c_bus: The I2C bus the device is connected to. + :param int address: The I2C device address. Defaults to :const:`0x6A` + + + **Quickstart: Importing and using the device** + + Here is an example of using the :class:`ISM330DHCX` class. + First you will need to import the libraries to use the sensor + + .. code-block:: python + + import board + from adafruit_lsm6ds.ism330dhcx import ISM330DHCX + + 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 = ISM330DHCX(i2c) + + Now you have access to the :attr:`acceleration` and :attr:`gyro`: attributes + + .. code-block:: python + + acc_x, acc_y, acc_z = sensor.acceleration + gyro_x, gyro_z, gyro_z = sensor.gyro + + + """ + + CHIP_ID = 0x6B + _gyro_range_4000dps = RWBit(_LSM6DS_CTRL2_G, 0) + + def __init__(self, i2c_bus: I2C, address: int = LSM6DS_DEFAULT_ADDRESS) -> None: + GyroRange.add_values( + ( + ("RANGE_125_DPS", 125, 125, 4.375), + ("RANGE_250_DPS", 0, 250, 8.75), + ("RANGE_500_DPS", 1, 500, 17.50), + ("RANGE_1000_DPS", 2, 1000, 35.0), + ("RANGE_2000_DPS", 3, 2000, 70.0), + ("RANGE_4000_DPS", 4000, 4000, 140.0), + ) + ) + super().__init__(i2c_bus, address) + + # Called DEVICE_CONF in the datasheet, but it recommends setting it + self._i3c_disable = True + + @property + def gyro_range(self) -> int: + """Adjusts the range of values that the sensor can measure, from 125 Degrees/s to 4000 + degrees/s. Note that larger ranges will be less accurate. Must be a ``GyroRange``. 4000 DPS + is only available for the ISM330DHCX""" + return self._cached_gyro_range + + @gyro_range.setter + def gyro_range(self, value: int) -> None: + super()._set_gyro_range(value) + + # range uses the `FS_4000` bit + if value is GyroRange.RANGE_4000_DPS: + self._gyro_range_125dps = False + self._gyro_range_4000dps = True + else: + self._gyro_range_4000dps = False + + sleep(0.2) # needed to let new range settle diff --git a/adafruit_lsm6ds/lsm6ds3.py b/adafruit_lsm6ds/lsm6ds3.py new file mode 100644 index 0000000..84c07c8 --- /dev/null +++ b/adafruit_lsm6ds/lsm6ds3.py @@ -0,0 +1,45 @@ +# SPDX-FileCopyrightText: Copyright (c) 2022 Edrig +# +# SPDX-License-Identifier: MIT +""" +This module provides the `adafruit_lsm6ds.lsm6ds33` subclass of LSM6DS sensors +=============================================================================== +""" + +from . import LSM6DS + + +class LSM6DS3(LSM6DS): + """Driver for the LSM6DS3 6-axis accelerometer and gyroscope. + + :param ~busio.I2C i2c_bus: The I2C bus the LSM6DS3 is connected to. + :param int address: The I2C device address. Defaults to :const:`0x6A` + + + **Quickstart: Importing and using the device** + + Here is an example of using the :class:`LSM6DS3` class. + First you will need to import the libraries to use the sensor + + .. code-block:: python + + import board + from adafruit_lsm6ds.lsm6ds3 import LSM6DS3 + + 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 = LSM6DS3(i2c) + + Now you have access to the :attr:`acceleration` and :attr:`gyro`: attributes + + .. code-block:: python + + acc_x, acc_y, acc_z = sensor.acceleration + gyro_x, gyro_z, gyro_z = sensor.gyro + + """ + + CHIP_ID = 0x6A diff --git a/adafruit_lsm6ds/lsm6ds33.py b/adafruit_lsm6ds/lsm6ds33.py new file mode 100644 index 0000000..fae5604 --- /dev/null +++ b/adafruit_lsm6ds/lsm6ds33.py @@ -0,0 +1,45 @@ +# SPDX-FileCopyrightText: Copyright (c) 2020 Bryan Siepert for Adafruit Industries +# +# SPDX-License-Identifier: MIT +""" +This module provides the `adafruit_lsm6ds.lsm6ds33` subclass of LSM6DS sensors +=============================================================================== +""" + +from . import LSM6DS + + +class LSM6DS33(LSM6DS): + """Driver for the LSM6DS33 6-axis accelerometer and gyroscope. + + :param ~busio.I2C i2c_bus: The I2C bus the LSM6DS33 is connected to. + :param int address: The I2C device address. Defaults to :const:`0x6A` + + + **Quickstart: Importing and using the device** + + Here is an example of using the :class:`LSM6DS33` class. + First you will need to import the libraries to use the sensor + + .. code-block:: python + + import board + from adafruit_lsm6ds.lsm6ds33 import LSM6DS33 + + 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 = LSM6DS33(i2c) + + Now you have access to the :attr:`acceleration` and :attr:`gyro`: attributes + + .. code-block:: python + + acc_x, acc_y, acc_z = sensor.acceleration + gyro_x, gyro_z, gyro_z = sensor.gyro + + """ + + CHIP_ID = 0x69 diff --git a/adafruit_lsm6ds/lsm6ds3trc.py b/adafruit_lsm6ds/lsm6ds3trc.py new file mode 100644 index 0000000..1c893a9 --- /dev/null +++ b/adafruit_lsm6ds/lsm6ds3trc.py @@ -0,0 +1,51 @@ +# SPDX-FileCopyrightText: Copyright (c) 2020 Bryan Siepert for Adafruit Industries +# +# SPDX-License-Identifier: MIT +""" +This module provides the `adafruit_lsm6ds.lsm6ds3trc` subclass of LSM6DS sensors +=============================================================================== +""" + +from . import LSM6DS, RWBit, const + +_LSM6DS_CTRL10_C = const(0x19) + + +class LSM6DS3TRC(LSM6DS): + """Driver for the LSM6DS3TR-C 6-axis accelerometer and gyroscope. + + :param ~busio.I2C i2c_bus: The I2C bus the LSM6DS3TR-C is connected to. + :param int address: The I2C device address. Defaults to :const:`0x6A` + + + **Quickstart: Importing and using the device** + + Here is an example of using the :class:`LSM6DS3TRC` class. + First you will need to import the libraries to use the sensor + + .. code-block:: python + + import board + from adafruit_lsm6ds.lsm6ds3trc import LSM6DS3TRC + + 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 = LSM6DS3TRC(i2c) + + Now you have access to the :attr:`acceleration` and :attr:`gyro`: attributes + + .. code-block:: python + + acc_x, acc_y, acc_z = sensor.acceleration + gyro_x, gyro_y, gyro_z = sensor.gyro + + """ + + CHIP_ID = 0x6A + + # This version of the IMU has a different register for enabling the pedometer + # https://www.st.com/resource/en/datasheet/lsm6ds3tr-c.pdf + _ped_enable = RWBit(_LSM6DS_CTRL10_C, 4) diff --git a/adafruit_lsm6ds/lsm6dso32.py b/adafruit_lsm6ds/lsm6dso32.py new file mode 100644 index 0000000..e0921b7 --- /dev/null +++ b/adafruit_lsm6ds/lsm6dso32.py @@ -0,0 +1,69 @@ +# SPDX-FileCopyrightText: Copyright (c) 2020 Bryan Siepert for Adafruit Industries +# +# SPDX-License-Identifier: MIT +""" +This module provides the `adafruit_lsm6ds.lsm6dso32` subclass of LSM6DS sensors +================================================================================= +""" + +from . import LSM6DS, LSM6DS_CHIP_ID, LSM6DS_DEFAULT_ADDRESS, AccelRange + +try: + import typing + + from busio import I2C +except ImportError: + pass + + +class LSM6DSO32(LSM6DS): + """Driver for the LSM6DSO32 6-axis accelerometer and gyroscope. + + :param ~busio.I2C i2c_bus: The I2C bus the LSM6DSO32 is connected to. + :param address: The I2C device address. Defaults to :const:`0x6A` + + + **Quickstart: Importing and using the device** + + Here is an example of using the :class:`LSM6DSO32` class. + First you will need to import the libraries to use the sensor + + .. code-block:: python + + import board + from adafruit_lsm6ds.lsm6dso32 import LSM6DSO32 + + 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 = LSM6DSO32(i2c) + + Now you have access to the :attr:`acceleration` and :attr:`gyro`: attributes + + .. code-block:: python + + acc_x, acc_y, acc_z = sensor.acceleration + gyro_x, gyro_z, gyro_z = sensor.gyro + + + """ + + CHIP_ID = LSM6DS_CHIP_ID + + def __init__(self, i2c_bus: I2C, address: int = LSM6DS_DEFAULT_ADDRESS) -> None: + super().__init__(i2c_bus, address) + self._i3c_disable = True + self.accelerometer_range = AccelRange.RANGE_8G # pylint:disable=no-member + + @staticmethod + def _add_accel_ranges() -> None: + AccelRange.add_values( + ( + ("RANGE_4G", 0, 4, 0.122), + ("RANGE_32G", 1, 32, 0.976), + ("RANGE_8G", 2, 8, 0.244), + ("RANGE_16G", 3, 16, 0.488), + ) + ) diff --git a/adafruit_lsm6ds/lsm6dsox.py b/adafruit_lsm6ds/lsm6dsox.py new file mode 100644 index 0000000..a7248d5 --- /dev/null +++ b/adafruit_lsm6ds/lsm6dsox.py @@ -0,0 +1,58 @@ +# SPDX-FileCopyrightText: Copyright (c) 2020 Bryan Siepert for Adafruit Industries +# +# SPDX-License-Identifier: MIT +""" +This module provides the `adafruit_lsm6ds.lsm6dsox` subclass of LSM6DS sensors +============================================================================== +""" + +from . import LSM6DS, LSM6DS_CHIP_ID, LSM6DS_DEFAULT_ADDRESS + +try: + import typing + + from busio import I2C +except ImportError: + pass + + +class LSM6DSOX(LSM6DS): + """Driver for the LSM6DSOX 6-axis accelerometer and gyroscope. + + :param ~busio.I2C i2c_bus: The I2C bus the LSM6DSOX is connected to. + :param int address: The I2C device address. Defaults to :const:`0x6A` + + + **Quickstart: Importing and using the device** + + Here is an example of using the :class:`LSM6DSOX` class. + First you will need to import the libraries to use the sensor + + .. code-block:: python + + import board + from adafruit_lsm6ds.lsm6dsox import LSM6DSOX + + 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 = LSM6DSOX(i2c) + + Now you have access to the :attr:`acceleration` and :attr:`gyro`: attributes + + .. code-block:: python + + acc_x, acc_y, acc_z = sensor.acceleration + gyro_x, gyro_z, gyro_z = sensor.gyro + + """ + + CHIP_ID = LSM6DS_CHIP_ID + + def __init__( + self, i2c_bus: I2C, address: int = LSM6DS_DEFAULT_ADDRESS, ucf: str = None + ) -> None: + super().__init__(i2c_bus, address, ucf) + self._i3c_disable = True 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 424f35c..3b6c479 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,5 +4,23 @@ .. 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_lsm6ds :members: + :exclude-members: CV, AccelRange, GyroRange, AccelHPF, Rate + :member-order: bysource + + +.. automodule:: adafruit_lsm6ds.ism330dhcx + :members: + +.. automodule:: adafruit_lsm6ds.lsm6ds33 + :members: + +.. automodule:: adafruit_lsm6ds.lsm6dso32 + :members: + +.. automodule:: adafruit_lsm6ds.lsm6dsox + :members: diff --git a/docs/api.rst.license b/docs/api.rst.license new file mode 100644 index 0000000..11cd75d --- /dev/null +++ b/docs/api.rst.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries + +SPDX-License-Identifier: MIT diff --git a/docs/conf.py b/docs/conf.py index 0ba2e58..cbcf28a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,8 +1,12 @@ -# -*- coding: utf-8 -*- +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written 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 = ["micropython", "adafruit_bus_device", "adafruit_register"] -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 LSM6DSOX Library' -copyright = u'2019 Bryan Siepert' -author = u'Bryan Siepert' +project = "Adafruit LSM6DS Library" +creation_year = "2019" +current_year = str(datetime.datetime.now().year) +year_duration = ( + current_year if current_year == creation_year else creation_year + " - " + current_year +) +copyright = year_duration + " Bryan Siepert" +author = "Bryan Siepert" # The version info for the project you're documenting, acts as replacement for # |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 = 'AdafruitLsm6dsoxLibrarydoc' +htmlhelp_basename = "AdafruitLsm6dsLibrarydoc" # -- 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, 'AdafruitLSM6DSOXLibrary.tex', u'AdafruitLSM6DSOX Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitLSM6DSLibrary.tex", + "AdafruitLSM6DS 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, 'AdafruitLSM6DSOXlibrary', u'Adafruit LSM6DSOX Library Documentation', - [author], 1) + ( + master_doc, + "AdafruitLSM6DSlibrary", + "Adafruit LSM6DS 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, 'AdafruitLSM6DSOXLibrary', u'Adafruit LSM6DSOX Library Documentation', - author, 'AdafruitLSM6DSOXLibrary', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitLSM6DSLibrary", + "Adafruit LSM6DS Library Documentation", + author, + "AdafruitLSM6DSLibrary", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/docs/examples.rst b/docs/examples.rst index 1270293..48353eb 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -1,8 +1,68 @@ -Simple test +LSM6DSOX Simple test +-------------------- + +Ensure your LSM6DSOX device works with this simple test. + +.. literalinclude:: ../examples/lsm6ds_lsm6dsox_simpletest.py + :caption: examples/lsm6ds_lsm6dsox_simpletest.py + :linenos: + + +LSM6DSO32 Simple test +--------------------- + +Ensure your LSM6DSO32 device works with this simple test. + +.. literalinclude:: ../examples/lsm6ds_lsm6dso32_simpletest.py + :caption: examples/lsm6ds_lsm6dso32_simpletest.py + :linenos: + + +LSM6DS Simple test +------------------ + +Ensure your LSM6DS device works with this simple test. + +.. literalinclude:: ../examples/lsm6ds_lsm6ds33_simpletest.py + :caption: examples/lsm6ds_lsm6ds33_simpletest.py + :linenos: + + +ISM330DHCX Simple test +---------------------- + +Ensure your ISM330DHCX device works with this simple test. + +.. literalinclude:: ../examples/lsm6ds_ism330dhcx_simpletest.py + :caption: examples/lsm6ds_ism330dhcx_simpletest.py + :linenos: + + +LSM6DS Full test +---------------- + +LSM6DS Full tests + +.. literalinclude:: ../examples/lsm6ds_full_test.py + :caption: examples/lsm6ds_full_test.py + :linenos: + + +Pedometer Example +----------------- + +Example showing how to use the device as a pedometer + +.. literalinclude:: ../examples/lsm6ds_pedometer.py + :caption: examples/lsm6ds_pedometer.py + :linenos: + + +Rate test ------------ -Ensure your device works with this simple test. +Example showing a Rate test -.. literalinclude:: ../examples/lsm6dsox_simpletest.py - :caption: examples/lsm6dsox_simpletest.py +.. literalinclude:: ../examples/lsm6ds_rate_test.py + :caption: examples/lsm6ds_rate_test.py :linenos: diff --git a/docs/examples.rst.license b/docs/examples.rst.license new file mode 100644 index 0000000..11cd75d --- /dev/null +++ b/docs/examples.rst.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries + +SPDX-License-Identifier: MIT diff --git a/docs/index.rst b/docs/index.rst index 709c5c0..a8de34e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -20,17 +20,39 @@ Table of Contents api +.. toctree:: + :caption: Tutorials + + LSM6DSOX and ISM330DHC 6 DoF IMU Guide + Adafruit LSM6DS33 6-DoF IMU Breakout Guide + ST 9-DoF Combo Breakouts and Wings Guide + .. toctree:: :caption: Related Products - Adafruit LSM6DSOX Breakout + * Adafruit LSM6DSOX Breakout + + * Adafruit ISM330DHCX Breakout + + * Adafruit LSM6DSO32 Breakout + + * Adafruit LSM6DS33 Breakout + + * Adafruit ISM330DHCX + LIS3MDL FEATHERWING + + * Adafruit LSM6DSOX + LIS3MDL - 9 DOF IMU Breakout + + * Adafruit LSM6DS33 + LIS3MDL - 9 DOF IMU Breakout + + * Adafruit LSM6DSOX + LIS3MDL 9 DOF IMU FeatherWing .. 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..11cd75d --- /dev/null +++ b/docs/index.rst.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2017 Scott Shawcroft, written 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/ism330dhct_simpletest.py b/examples/ism330dhct_simpletest.py deleted file mode 100644 index e6a99ec..0000000 --- a/examples/ism330dhct_simpletest.py +++ /dev/null @@ -1,14 +0,0 @@ -import time -import board -import busio -from adafruit_lsm6ds import ISM330DHCT - -i2c = busio.I2C(board.SCL, board.SDA) - -sensor = ISM330DHCT(i2c) - -while True: - print("Acceleration: X:%.2f, Y: %.2f, Z: %.2f m/s^2" % (sensor.acceleration)) - print("Gyro X:%.2f, Y: %.2f, Z: %.2f degrees/s" % (sensor.gyro)) - print("") - time.sleep(0.5) diff --git a/examples/lsm6ds33_simpletest.py b/examples/lsm6ds33_simpletest.py deleted file mode 100644 index ccb3e35..0000000 --- a/examples/lsm6ds33_simpletest.py +++ /dev/null @@ -1,14 +0,0 @@ -import time -import board -import busio -from adafruit_lsm6ds import LSM6DS33 - -i2c = busio.I2C(board.SCL, board.SDA) - -sensor = LSM6DS33(i2c) - -while True: - print("Acceleration: X:%.2f, Y: %.2f, Z: %.2f m/s^2" % (sensor.acceleration)) - print("Gyro X:%.2f, Y: %.2f, Z: %.2f degrees/s" % (sensor.gyro)) - print("") - time.sleep(0.5) diff --git a/examples/lsm6ds_full_test.py b/examples/lsm6ds_full_test.py index 47dffcf..50e0594 100644 --- a/examples/lsm6ds_full_test.py +++ b/examples/lsm6ds_full_test.py @@ -1,14 +1,21 @@ +# SPDX-FileCopyrightText: Copyright (c) 2020 Bryan Siepert for Adafruit Industries +# +# SPDX-License-Identifier: MIT import time + import board -import busio -#pylint:disable=no-member,unused-import -from adafruit_lsm6ds import LSM6DS33, LSM6DSOX, ISM330DHCT, Rate, AccelRange, GyroRange -i2c = busio.I2C(board.SCL, board.SDA) +# pylint:disable=no-member +from adafruit_lsm6ds import AccelRange, GyroRange, Rate +from adafruit_lsm6ds.lsm6dsox import LSM6DSOX as LSM6DS + +# from adafruit_lsm6ds.lsm6ds33 import LSM6DS33 as LSM6DS +# from adafruit_lsm6ds.lsm6dso32 import LSM6DSO32 as LSM6DS +# from adafruit_lsm6ds.ism330dhcx import ISM330DHCX as LSM6DS -sensor = LSM6DS33(i2c) -#sensor = LSM6DSOX(i2c) -#sensor = ISM330DHCT(i2c) +i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller +sensor = LSM6DS(i2c) sensor.accelerometer_range = AccelRange.RANGE_8G print("Accelerometer range set to: %d G" % AccelRange.string[sensor.accelerometer_range]) @@ -17,13 +24,15 @@ print("Gyro range set to: %d DPS" % GyroRange.string[sensor.gyro_range]) sensor.accelerometer_data_rate = Rate.RATE_1_66K_HZ -#sensor.accelerometer_data_rate = Rate.RATE_12_5_HZ +# sensor.accelerometer_data_rate = Rate.RATE_12_5_HZ print("Accelerometer rate set to: %d HZ" % Rate.string[sensor.accelerometer_data_rate]) sensor.gyro_data_rate = Rate.RATE_1_66K_HZ print("Gyro rate set to: %d HZ" % Rate.string[sensor.gyro_data_rate]) while True: - print("Accel X:%.2f Y:%.2f Z:%.2f ms^2 Gyro X:%.2f Y:%.2f Z:%.2f degrees/s" % - (sensor.acceleration+sensor.gyro)) + print( + "Accel X:%.2f Y:%.2f Z:%.2f ms^2 Gyro X:%.2f Y:%.2f Z:%.2f radians/s" + % (sensor.acceleration + sensor.gyro) + ) time.sleep(0.05) diff --git a/examples/lsm6ds_ism330dhcx_simpletest.py b/examples/lsm6ds_ism330dhcx_simpletest.py new file mode 100644 index 0000000..9dda013 --- /dev/null +++ b/examples/lsm6ds_ism330dhcx_simpletest.py @@ -0,0 +1,20 @@ +# SPDX-FileCopyrightText: Copyright (c) 2020 Bryan Siepert for Adafruit Industries +# +# SPDX-License-Identifier: MIT +import time + +import board + +from adafruit_lsm6ds.ism330dhcx import ISM330DHCX + +i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller +sensor = ISM330DHCX(i2c) + +while True: + accel_x, accel_y, accel_z = sensor.acceleration + print(f"Acceleration: X:{accel_x:.2f}, Y: {accel_y:.2f}, Z: {accel_z:.2f} m/s^2") + gyro_x, gyro_y, gyro_z = sensor.gyro + print(f"Gyro X:{gyro_x:.2f}, Y: {gyro_y:.2f}, Z: {gyro_z:.2f} radians/s") + print("") + time.sleep(0.5) diff --git a/examples/lsm6ds_lsm6ds33_simpletest.py b/examples/lsm6ds_lsm6ds33_simpletest.py new file mode 100644 index 0000000..5d92fbc --- /dev/null +++ b/examples/lsm6ds_lsm6ds33_simpletest.py @@ -0,0 +1,20 @@ +# SPDX-FileCopyrightText: Copyright (c) 2020 Bryan Siepert for Adafruit Industries +# +# SPDX-License-Identifier: MIT +import time + +import board + +from adafruit_lsm6ds.lsm6ds33 import LSM6DS33 + +i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller +sensor = LSM6DS33(i2c) + +while True: + accel_x, accel_y, accel_z = sensor.acceleration + print(f"Acceleration: X:{accel_x:.2f}, Y: {accel_y:.2f}, Z: {accel_z:.2f} m/s^2") + gyro_x, gyro_y, gyro_z = sensor.gyro + print(f"Gyro X:{gyro_x:.2f}, Y: {gyro_y:.2f}, Z: {gyro_z:.2f} radians/s") + print("") + time.sleep(0.5) diff --git a/examples/lsm6ds_lsm6ds3_simpletest.py b/examples/lsm6ds_lsm6ds3_simpletest.py new file mode 100644 index 0000000..069f65c --- /dev/null +++ b/examples/lsm6ds_lsm6ds3_simpletest.py @@ -0,0 +1,20 @@ +# SPDX-FileCopyrightText: Copyright (c) 2022 Edrig +# +# SPDX-License-Identifier: MIT +import time + +import board + +from adafruit_lsm6ds.lsm6ds3 import LSM6DS3 + +i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller +sensor = LSM6DS3(i2c) + +while True: + accel_x, accel_y, accel_z = sensor.acceleration + print(f"Acceleration: X:{accel_x:.2f}, Y: {accel_y:.2f}, Z: {accel_z:.2f} m/s^2") + gyro_x, gyro_y, gyro_z = sensor.gyro + print(f"Gyro X:{gyro_x:.2f}, Y: {gyro_y:.2f}, Z: {gyro_z:.2f} radians/s") + print("") + time.sleep(0.5) diff --git a/examples/lsm6ds_lsm6ds3trc_simpletest.py b/examples/lsm6ds_lsm6ds3trc_simpletest.py new file mode 100644 index 0000000..103e751 --- /dev/null +++ b/examples/lsm6ds_lsm6ds3trc_simpletest.py @@ -0,0 +1,28 @@ +# SPDX-FileCopyrightText: Copyright (c) 2020 Bryan Siepert for Adafruit Industries +# +# SPDX-License-Identifier: MIT +import time + +import board +import busio +import digitalio + +from adafruit_lsm6ds.lsm6ds3trc import LSM6DS3TRC + +# On the Seeed XIAO nRF52840 Sense the LSM6DS3TR-C IMU is connected on a separate +# I2C bus and it has its own power pin that we need to enable. +imupwr = digitalio.DigitalInOut(board.IMU_PWR) +imupwr.direction = digitalio.Direction.OUTPUT +imupwr.value = True +time.sleep(0.1) + +imu_i2c = busio.I2C(board.IMU_SCL, board.IMU_SDA) +sensor = LSM6DS3TRC(imu_i2c) + +while True: + accel_x, accel_y, accel_z = sensor.acceleration + print(f"Acceleration: X:{accel_x:.2f}, Y: {accel_y:.2f}, Z: {accel_z:.2f} m/s^2") + gyro_x, gyro_y, gyro_z = sensor.gyro + print(f"Gyro X:{gyro_x:.2f}, Y: {gyro_y:.2f}, Z: {gyro_z:.2f} radians/s") + print("") + time.sleep(0.5) diff --git a/examples/lsm6ds_lsm6dso32_simpletest.py b/examples/lsm6ds_lsm6dso32_simpletest.py new file mode 100644 index 0000000..fe5d161 --- /dev/null +++ b/examples/lsm6ds_lsm6dso32_simpletest.py @@ -0,0 +1,20 @@ +# SPDX-FileCopyrightText: Copyright (c) 2020 Bryan Siepert for Adafruit Industries +# +# SPDX-License-Identifier: MIT +import time + +import board + +from adafruit_lsm6ds.lsm6dso32 import LSM6DSO32 + +i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller +sensor = LSM6DSO32(i2c) + +while True: + accel_x, accel_y, accel_z = sensor.acceleration + print(f"Acceleration: X:{accel_x:.2f}, Y: {accel_y:.2f}, Z: {accel_z:.2f} m/s^2") + gyro_x, gyro_y, gyro_z = sensor.gyro + print(f"Gyro X:{gyro_x:.2f}, Y: {gyro_y:.2f}, Z: {gyro_z:.2f} radians/s") + print("") + time.sleep(0.5) diff --git a/examples/lsm6ds_lsm6dsox_mlc_test.py b/examples/lsm6ds_lsm6dsox_mlc_test.py new file mode 100644 index 0000000..9f57ca8 --- /dev/null +++ b/examples/lsm6ds_lsm6dsox_mlc_test.py @@ -0,0 +1,61 @@ +# SPDX-FileCopyrightText: Copyright (c) 2020 Bryan Siepert for Adafruit Industries +# +# SPDX-License-Identifier: MIT +# LSM6DSOX IMU MLC (Machine Learning Core) Example. +# Download the raw UCF file, copy to storage and reset. + +# NOTE: The pre-trained models (UCF files) for the examples can be found here: +# https://github.com/STMicroelectronics/STMems_Machine_Learning_Core/tree/master/application_examples/lsm6dsox + +import time + +import board + +from adafruit_lsm6ds import AccelRange, GyroRange, Rate +from adafruit_lsm6ds.lsm6dsox import LSM6DSOX + +i2c = board.STEMMA_I2C() # uses board.SCL and board.SDA + + +# Vibration detection example +UCF_FILE = "lsm6dsox_vibration_monitoring.ucf" +UCF_LABELS = {0: "no vibration", 1: "low vibration", 2: "high vibration"} +# NOTE: Selected data rate and scale must match the MLC data rate and scale. +lsm = LSM6DSOX(i2c, ucf=UCF_FILE) +lsm.gyro_range = GyroRange.RANGE_2000_DPS +lsm.accelerometer_range = AccelRange.RANGE_4G +lsm.accelerometer_data_rate = Rate.RATE_26_HZ +lsm.gyro_data_rate = Rate.RATE_26_HZ + + +# Head gestures example +# UCF_FILE = "lsm6dsox_head_gestures.ucf" +# UCF_LABELS = {0:"Nod", 1:"Shake", 2:"Stationary", 3:"Swing", 4:"Walk"} +# NOTE: Selected data rate and scale must match the MLC data rate and scale. +# lsm = LSM6DSOX(i2c, ucf=UCF_FILE) +# lsm.gyro_range = GyroRange.RANGE_250_DPS +# lsm.accelerometer_range = AccelRange.RANGE_2G +# lsm.accelerometer_data_rate = Rate.RATE_26_HZ +# lsm.gyro_data_rate = Rate.RATE_26_HZ + +# 6 DOF Position example +# UCF_FILE = "lsm6dsox_six_d_position.ucf" +# UCF_LABELS = {0:"None", 1:"X-UP", 2:"X-DOWN", 3:"Y-UP", 4:"Y-DOWN", 5:"Z-UP", 6:"Z-DOWN"} +# NOTE: Selected data rate and scale must match the MLC data rate and scale. +# lsm = LSM6DSOX(i2c, ucf=UCF_FILE) +# lsm.gyro_range = GyroRange.RANGE_250_DPS +# lsm.accelerometer_range = AccelRange.RANGE_2G +# lsm.accelerometer_data_rate = Rate.RATE_26_HZ +# lsm.gyro_data_rate = Rate.RATE_26_HZ + + +print("MLC configured...") + +while True: + buf = lsm.read_mlc_output() + if buf is not None: + print(UCF_LABELS[buf[0]]) + # delay to allow interrupt flag to clear + # interrupt stays high for one sample interval + # (38.4 ms @ 26 Hz ot 19.2 ms @ 52Hz) + time.sleep(0.05) diff --git a/examples/lsm6ds_lsm6dsox_simpletest.py b/examples/lsm6ds_lsm6dsox_simpletest.py new file mode 100644 index 0000000..f2f7037 --- /dev/null +++ b/examples/lsm6ds_lsm6dsox_simpletest.py @@ -0,0 +1,20 @@ +# SPDX-FileCopyrightText: Copyright (c) 2020 Bryan Siepert for Adafruit Industries +# +# SPDX-License-Identifier: MIT +import time + +import board + +from adafruit_lsm6ds.lsm6dsox import LSM6DSOX + +i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller +sensor = LSM6DSOX(i2c) + +while True: + accel_x, accel_y, accel_z = sensor.acceleration + print(f"Acceleration: X:{accel_x:.2f}, Y: {accel_y:.2f}, Z: {accel_z:.2f} m/s^2") + gyro_x, gyro_y, gyro_z = sensor.gyro + print(f"Gyro X:{gyro_x:.2f}, Y: {gyro_y:.2f}, Z: {gyro_z:.2f} radians/s") + print("") + time.sleep(0.5) diff --git a/examples/lsm6ds_pedometer.py b/examples/lsm6ds_pedometer.py new file mode 100644 index 0000000..da8d2af --- /dev/null +++ b/examples/lsm6ds_pedometer.py @@ -0,0 +1,32 @@ +# SPDX-FileCopyrightText: Copyright (c) 2020 Bryan Siepert for Adafruit Industries +# +# SPDX-License-Identifier: MIT +"""This example shows off how to use the step counter built +into the ST LSM6DS series IMUs. The steps are calculated in +the chip so you don't have to do any calculations!""" + +import time + +import board + +from adafruit_lsm6ds import AccelRange, Rate + +# pylint:disable=no-member +from adafruit_lsm6ds.lsm6ds33 import LSM6DS33 + +i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller +sensor = LSM6DS33(i2c) + +# enable accelerometer sensor @ 2G and 26 Hz +sensor.accelerometer_range = AccelRange.RANGE_2G +sensor.accelerometer_data_rate = Rate.RATE_26_HZ +# no gyro used for step detection +sensor.gyro_data_rate = Rate.RATE_SHUTDOWN + +# enable the pedometer +sensor.pedometer_enable = True + +while True: + print("Steps: ", sensor.pedometer_steps) + time.sleep(1) diff --git a/examples/lsm6ds_rate_test.py b/examples/lsm6ds_rate_test.py index 5ba3574..6ff7365 100644 --- a/examples/lsm6ds_rate_test.py +++ b/examples/lsm6ds_rate_test.py @@ -1,29 +1,35 @@ +# SPDX-FileCopyrightText: Copyright (c) 2020 Bryan Siepert for Adafruit Industries +# +# SPDX-License-Identifier: MIT import board -import busio -#pylint:disable=no-member,unused-import -from adafruit_lsm6ds import LSM6DS33, LSM6DSOX, ISM330DHCT, Rate -i2c = busio.I2C(board.SCL, board.SDA) +# pylint:disable=no-member,unused-import +from adafruit_lsm6ds import Rate +from adafruit_lsm6ds.lsm6dsox import LSM6DSOX as LSM6DS -sensor = LSM6DS33(i2c) -#sensor = LSM6DSOX(i2c) -#sensor = ISM330DHCT(i2c) +# from adafruit_lsm6ds.lsm6ds33 import LSM6DS33 as LSM6DS +# from adafruit_lsm6ds.lsm6dso32 import LSM6DSO32 as LSM6DS +# from adafruit_lsm6ds.ism330dhcx import ISM330DHCX as LSM6DS + +i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller +sensor = LSM6DS(i2c) while True: sensor.accelerometer_data_rate = Rate.RATE_12_5_HZ sensor.gyro_data_rate = Rate.RATE_12_5_HZ for i in range(100): - print("(%.2f, %.2f, %.2f, %.2f, %.2f, %.2f" % (sensor.acceleration+sensor.gyro)) + print("(%.2f, %.2f, %.2f, %.2f, %.2f, %.2f" % (sensor.acceleration + sensor.gyro)) print() sensor.accelerometer_data_rate = Rate.RATE_52_HZ sensor.gyro_data_rate = Rate.RATE_52_HZ for i in range(100): - print("(%.2f, %.2f, %.2f, %.2f, %.2f, %.2f" % (sensor.acceleration+sensor.gyro)) + print("(%.2f, %.2f, %.2f, %.2f, %.2f, %.2f" % (sensor.acceleration + sensor.gyro)) print() sensor.accelerometer_data_rate = Rate.RATE_416_HZ sensor.gyro_data_rate = Rate.RATE_416_HZ for i in range(100): - print("(%.2f, %.2f, %.2f, %.2f, %.2f, %.2f" % (sensor.acceleration+sensor.gyro)) + print("(%.2f, %.2f, %.2f, %.2f, %.2f, %.2f" % (sensor.acceleration + sensor.gyro)) print() diff --git a/examples/lsm6dsox_simpletest.py b/examples/lsm6dsox_simpletest.py deleted file mode 100644 index b2355d5..0000000 --- a/examples/lsm6dsox_simpletest.py +++ /dev/null @@ -1,14 +0,0 @@ -import time -import board -import busio -from adafruit_lsm6ds import LSM6DSOX - -i2c = busio.I2C(board.SCL, board.SDA) - -sensor = LSM6DSOX(i2c) - -while True: - print("Acceleration: X:%.2f, Y: %.2f, Z: %.2f m/s^2" % (sensor.acceleration)) - print("Gyro X:%.2f, Y: %.2f, Z: %.2f degrees/s" % (sensor.gyro)) - print("") - time.sleep(0.5) 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..aa7ae76 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,56 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +[build-system] +requires = [ + "setuptools", + "wheel", + "setuptools-scm", +] + +[project] +name = "adafruit-circuitpython-lsm6ds" +description = "CircuitPython helper library for the LSM6DS family of motion sensors from ST" +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_LSM6DS"} +keywords = [ + "adafruit", + "blinka", + "circuitpython", + "micropython", + "lsm6ds", + "lsm6dsox", + "lsmds33", + "lsm6dso32", + "st", + "imu", + "gyro", + "accelerometer", + "ism330dhcx", + "imu", + "gyro", + "gyroscope", + "inemo", +] +license = {text = "MIT"} +classifiers = [ + "Intended Audience :: Developers", + "Topic :: Software Development :: Libraries", + "Topic :: Software Development :: Embedded Systems", + "Topic :: System :: Hardware", + "License :: OSI Approved :: MIT License", + "Programming Language :: Python :: 3", +] +dynamic = ["dependencies", "optional-dependencies"] + +[tool.setuptools] +packages = ["adafruit_lsm6ds"] + +[tool.setuptools.dynamic] +dependencies = {file = ["requirements.txt"]} +optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} diff --git a/register_map.json b/register_map.json deleted file mode 100644 index 2d67414..0000000 --- a/register_map.json +++ /dev/null @@ -1,118 +0,0 @@ -{ - "sensor_name": "LSM6DS0X", - "default_address": 106, - "registers": { - "FUNC_CFG_ACCESS" : { - "address" : "01h", - "fields" :[ - "FUNC_CFG_ACCESS", - "SHUB_REG_ACCESS", - null, - null, - null, - null, - null, - "OIS_CTRL_FROM_UI" - ] - }, - "PIN_CTRL": { - "address" : "02h", - "fields" : ["OIS_PU_DIS","SDO_PU_EN", null, null, null, null, null, null] - }, - "UI_INT_OIS": { - "address": "6Fh", - "fields" : ["INT2_DRDY_OIS", "LVL2_OIS", "DEN_LH_OIS", null, "SPI2_READ_EN", null, null, null] - }, - "WHOAMI": { - "address": "0Fh", - "length" : 1, - "format_str" : ">b", - "human_name" : "chip_id" - }, - "CTRL1_XL": { - "address" : "10h", - "fields" :["ODR_XL3", "ODR_XL2", "ODR_XL1", "ODR_XL0", "FS1_XL", "FS0_XL", "LPF2_XL_EN", null] - }, - "CTRL2_G": { - "address" : "11h", - "fields" :["ODR_G3", "ODR_G2", "ODR_G1", "ODR_G0", "FS1_G", "FS0_G", "FS_125", null], - "cvs" : { - "ODR": [ - ["250 DPS", 0], - ["500 DPS", 1], - ["1000 DPS", 2], - ["2000 DPS", 3] - ] - - } - }, - "CTRL3_C": { - "address" : "12h", - "fields":["BOOT", "BDU", "H_LACTIVE", "PP_OD", "SIM", "IF_INC", null, "SW_RESET"] - }, - "CTRL_5_C" : { - "address" : "14h", - "fields" : [ - - "XL_ULP_EN", - "ROUNDING1", - "ROUNDING0", - "ROUNDING_STATUS", - "ST1_G", - "ST0_G", - "ST1_XL", - "ST0_XL" - - ] - }, - "MASTER_CONFIG": { - "address" : "14h", - "fields" : [ - "RST_MASTER_REGS", - "WRITE_ONCE", - "START_CONFIG", - "PASS_THROUGH_MODE", - "SHUB_PU_EN", - "MASTER_ON", - "AUX_SENS_ON1", - "AUX_SENS_ON0" - ] - }, - "CTRL9_XL" : { - "address" : "18h", - "fields" : [ - "DEN_X", - "DEN_Y", - "DEN_Z", - "DEN_XL_G", - "DEN_XL_EN", - "DEN_LH", - "I3C_DISABLE", - null - ] - }, - "OUT_TEMP_L": { - "address": "20h", - "format_str" : "