diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..11ce574 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,50 @@ +name: Build CI + +on: [pull_request, push] + +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 diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..18efb9c --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,81 @@ +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/.gitignore b/.gitignore new file mode 100644 index 0000000..066d563 --- /dev/null +++ b/.gitignore @@ -0,0 +1,13 @@ +*.mpy +.idea +__pycache__ +_build +*.pyc +.env +build*/ +bundles +*.DS_Store +.eggs +dist +**/*.egg-info +.vscode diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 0000000..039eaec --- /dev/null +++ b/.pylintrc @@ -0,0 +1,433 @@ +[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.yml b/.readthedocs.yml new file mode 100644 index 0000000..f4243ad --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,3 @@ +python: + version: 3 +requirements_file: requirements.txt diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..7ca3a1d --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,127 @@ +# Adafruit Community Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and leaders pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level or type of +experience, education, socio-economic status, nationality, personal appearance, +race, religion, or sexual identity and orientation. + +## Our Standards + +We are committed to providing a friendly, safe and welcoming environment for +all. + +Examples of behavior that contributes to creating a positive environment +include: + +* Be kind and courteous to others +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Collaborating with other community members +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and sexual attention or advances +* The use of inappropriate images, including in a community member's avatar +* The use of inappropriate language, including in a community member's nickname +* Any spamming, flaming, baiting or other attention-stealing behavior +* Excessive or unwelcome helping; answering outside the scope of the question + asked +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate + +The goal of the standards and moderation guidelines outlined here is to build +and maintain a respectful community. We ask that you don’t just aim to be +"technically unimpeachable", but rather try to be your best self. + +We value many things beyond technical expertise, including collaboration and +supporting others within our community. Providing a positive experience for +other community members can have a much more significant impact than simply +providing the correct answer. + +## Our Responsibilities + +Project leaders are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project leaders have the right and responsibility to remove, edit, or +reject messages, comments, commits, code, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any community member for other behaviors that they deem +inappropriate, threatening, offensive, or harmful. + +## Moderation + +Instances of behaviors that violate the Adafruit Community Code of Conduct +may be reported by any member of the community. Community members are +encouraged to report these situations, including situations they witness +involving other community members. + +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. + +Email and direct message reports will be kept confidential. + +In situations on Discord where the issue is particularly egregious, possibly +illegal, requires immediate action, or violates the Discord terms of service, +you should also report the message directly to Discord. + +These are the steps for upholding our community’s standards of conduct. + +1. Any member of the community may report any situation that violates the +Adafruit Community Code of Conduct. All reports will be reviewed and +investigated. +2. If the behavior is an egregious violation, the community member who +committed the violation may be banned immediately, without warning. +3. Otherwise, moderators will first respond to such behavior with a warning. +4. Moderators follow a soft "three strikes" policy - the community member may +be given another chance, if they are receptive to the warning and change their +behavior. +5. If the community member is unreceptive or unreasonable when warned by a +moderator, or the warning goes unheeded, they may be banned for a first or +second offense. Repeated offenses will result in the community member being +banned. + +## Scope + +This Code of Conduct and the enforcement policies listed above apply to all +Adafruit Community venues. This includes but is not limited to any community +spaces (both public and private), the entire Adafruit Discord server, and +Adafruit GitHub repositories. Examples of Adafruit Community spaces include +but are not limited to meet-ups, audio chats on the Adafruit Discord, or +interaction at a conference. + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. As a community +member, you are representing our community, and are expected to behave +accordingly. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 1.4, available at +, +and the [Rust Code of Conduct](https://www.rust-lang.org/en-US/conduct.html). + +For other projects adopting the Adafruit Community Code of +Conduct, please contact the maintainers of those projects for enforcement. +If you wish to use this code of conduct for your own project, consider +explicitly mentioning your moderation policy or making a copy with your +own moderation policy so as to avoid confusion. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..c11e9fa --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2020 Kattni Rembor 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. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..663a629 --- /dev/null +++ b/README.rst @@ -0,0 +1,105 @@ +Introduction +============ + +.. image:: https://readthedocs.org/projects/adafruit-circuitpython-clue/badge/?version=latest + :target: https://circuitpython.readthedocs.io/projects/clue/en/latest/ + :alt: Documentation Status + +.. image:: https://img.shields.io/discord/327254708534116352.svg + :target: https://discord.gg/nBQh6qu + :alt: Discord + +.. image:: https://github.com/adafruit/Adafruit_CircuitPython_CLUE/workflows/Build%20CI/badge.svg + :target: https://github.com/adafruit/Adafruit_CircuitPython_CLUE/actions + :alt: Build Status + +A high level library representing all the features of the Adafruit CLUE. + + +Dependencies +============= +This driver depends on: + +* `Adafruit CircuitPython `_ +* `Bus Device `_ +* `Register `_ +* `Adafruit LSM6DS `_ +* `Adafruit LIS3MDL `_ +* `Adafruit APDS9960 `_ +* `Adafruit BMP280 `_ +* `Adafruit SHT31D `_ +* `Adafruit NeoPixel `_ + +Please ensure all dependencies are available on the CircuitPython filesystem. +This is easily achieved by downloading +`the Adafruit library and driver bundle `_. + +Installing from PyPI +===================== +.. note:: This library is not available on PyPI yet. Install documentation is included + as a standard element. Stay tuned for PyPI availability! + +On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from +PyPI `_. To install for current user: + +.. code-block:: shell + + pip3 install adafruit-circuitpython-clue + +To install system-wide (this may be required in some cases): + +.. code-block:: shell + + sudo pip3 install adafruit-circuitpython-clue + +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-clue + +Usage Example +============= +This example displays sensor and input data on the CLUE display. + +.. code-block:: python + + from adafruit_clue import clue + + clue.sea_level_pressure = 1020 + + clue_data = clue.display_clue_data(title="CLUE Sensor Data!", title_scale=2, num_lines=15) + + while True: + clue_data[0].text = "Acceleration: {:.2f} {:.2f} {:.2f}".format(*clue.acceleration) + clue_data[1].text = "Gyro: {:.2f} {:.2f} {:.2f}".format(*clue.gyro) + clue_data[2].text = "Magnetic: {:.3f} {:.3f} {:.3f}".format(*clue.magnetic) + clue_data[3].text = "Pressure: {:.3f}hPa".format(clue.pressure) + clue_data[4].text = "Altitude: {:.1f}m".format(clue.altitude) + clue_data[5].text = "Temperature: {:.1f}C".format(clue.temperature) + clue_data[6].text = "Humidity: {:.1f}%".format(clue.humidity) + clue_data[7].text = "Proximity: {}".format(clue.proximity) + clue_data[8].text = "Gesture: {}".format(clue.gesture) + clue_data[9].text = "Color: R: {} G: {} B: {} C: {}".format(*clue.color) + clue_data[10].text = "Button A: {}".format(clue.button_a) + clue_data[11].text = "Button B: {}".format(clue.button_b) + clue_data[12].text = "Touch 0: {}".format(clue.touch_0) + clue_data[13].text = "Touch 1: {}".format(clue.touch_1) + clue_data[14].text = "Touch 2: {}".format(clue.touch_2) + clue_data.show() + + +Contributing +============ + +Contributions are welcome! Please read our `Code of Conduct +`_ +before contributing to help this project stay welcoming. + +Documentation +============= + +For information on building library documentation, please check out `this guide `_. diff --git a/adafruit_clue.py b/adafruit_clue.py new file mode 100644 index 0000000..7fdc41e --- /dev/null +++ b/adafruit_clue.py @@ -0,0 +1,852 @@ +# The MIT License (MIT) +# +# Copyright (c) 2020 Kattni Rembor 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_clue` +================================================================================ + +A high level library representing all the features of the Adafruit CLUE. + + +* Author(s): Kattni Rembor + +Implementation Notes +-------------------- + +**Hardware:** + +.. "* `Adafruit CLUE - nRF52840 Express with Bluetooth LE `_" + +**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 + * Adafruit's LSM6DS CircuitPython Library: + https://github.com/adafruit/Adafruit_CircuitPython_LSM6DS + * Adafruit's LIS3MDL CircuitPython Library: + https://github.com/adafruit/Adafruit_CircuitPython_LIS3MDL + * Adafruit's APDS9960 CircuitPython Library: + https://github.com/adafruit/Adafruit_CircuitPython_APDS9960 + * Adafruit's BMP280 CircuitPython Library: + https://github.com/adafruit/Adafruit_CircuitPython_BMP280 + * Adafruit's SHT31D CircuitPython Library: + https://github.com/adafruit/Adafruit_CircuitPython_SHT31D + * Adafruit's NeoPixel CircuitPython Library: + https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel +""" + +import time +import array +import math +import board +import digitalio +import audiobusio +import audiopwmio +import audiocore +import gamepad +import touchio +import neopixel +import adafruit_apds9960.apds9960 +import adafruit_bmp280 +import adafruit_lis3mdl +import adafruit_lsm6ds +import adafruit_sht31d + +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_CLUE.git" + +class _DisplayClueData: + """Display sensor data.""" + def __init__(self, title="CLUE Sensor Data", title_color=0xFFFFFF, title_scale=1, # pylint: disable=too-many-arguments + clue_data_scale=1, font=None, num_lines=1, colors=None): + import displayio + import terminalio + from adafruit_display_text import label + + if not colors: + colors = ((255, 0, 255), (0, 255, 0), (255, 0, 0), (0, 255, 255), (255, 255, 0), + (0, 0, 255), (255, 0, 180), (0, 180, 255), (255, 180, 0), (180, 0, 255)) + + self._label = label + self._display = board.DISPLAY + self._font = terminalio.FONT + if font: + self._font = font + + # Fail gracefully if title is longer than 60 characters. + if len(title) > 60: + raise ValueError("Title must be 60 characters or less.") + + title = label.Label(self._font, text=title, max_glyphs=60, color=title_color, + scale=title_scale) + title.x = 0 + title.y = 8 + self._y = title.y + 20 + + self.data_group = displayio.Group(max_size=20, scale=clue_data_scale) + self.data_group.append(title) + + self._lines = [] + for num in range(num_lines): + self._lines.append(self.add_text_line(color=colors[num % len(colors)])) + + def __getitem__(self, item): + """Fetch the Nth text line Group""" + return self._lines[item] + + def add_text_line(self, color=0xFFFFFF): + """Adds a line on the display of the specified color and returns the label object.""" + clue_data_label = self._label.Label(self._font, text="", max_glyphs=45, color=color) + clue_data_label.x = 0 + clue_data_label.y = self._y + self._y = clue_data_label.y + 13 + self.data_group.append(clue_data_label) + + return clue_data_label + + def show(self): + """Call show() to display the data list.""" + self._display.show(self.data_group) + + def show_terminal(self): + """Revert to terminalio screen.""" + self._display.show(None) + +class Clue: # pylint: disable=too-many-instance-attributes, too-many-public-methods + """Represents a single CLUE.""" + def __init__(self): + # Define I2C: + self._i2c = board.I2C() + + # Define touch: + # Initially, self._touches stores the pin used for a particular touch. When that touch is + # used for the first time, the pin is replaced with the corresponding TouchIn object. + # This saves a little RAM over using a separate read-only pin tuple. + # For example, after `clue.touch_2`, self._touches is equivalent to: + # [board.D0, board.D1, touchio.TouchIn(board.D2)] + self._touches = [board.D0, board.D1, board.D2] + self._touch_threshold_adjustment = 0 + + # Define buttons: + self._a = digitalio.DigitalInOut(board.BUTTON_A) + self._a.switch_to_input(pull=digitalio.Pull.UP) + self._b = digitalio.DigitalInOut(board.BUTTON_B) + self._b.switch_to_input(pull=digitalio.Pull.UP) + self._gamepad = gamepad.GamePad(self._a, self._b) + + # Define LEDs: + self._white_leds = digitalio.DigitalInOut(board.WHITE_LEDS) + self._white_leds.switch_to_output() + self._pixel = neopixel.NeoPixel(board.NEOPIXEL, 1) + self._red_led = digitalio.DigitalInOut(board.L) + self._red_led.switch_to_output() + + # Define audio: + self._mic = audiobusio.PDMIn(board.MICROPHONE_CLOCK, board.MICROPHONE_DATA, + sample_rate=16000, bit_depth=16) + self._speaker = digitalio.DigitalInOut(board.SPEAKER) + self._speaker.switch_to_output() + self._sample = None + self._samples = None + self._sine_wave = None + self._sine_wave_sample = None + + # Define sensors: + # Accelerometer/gyroscope: + self._accelerometer = adafruit_lsm6ds.LSM6DS33(self._i2c) + + # Magnetometer: + self._magnetometer = adafruit_lis3mdl.LIS3MDL(self._i2c) + + # DGesture/proximity/color/light sensor: + self._sensor = adafruit_apds9960.apds9960.APDS9960(self._i2c) + + # Humidity sensor: + self._humidity = adafruit_sht31d.SHT31D(self._i2c) + + # Barometric pressure sensor: + self._pressure = adafruit_bmp280.Adafruit_BMP280_I2C(self._i2c) + + def _touch(self, i): + if not isinstance(self._touches[i], touchio.TouchIn): + # First time referenced. Get the pin from the slot for this touch + # and replace it with a TouchIn object for the pin. + self._touches[i] = touchio.TouchIn(self._touches[i]) + self._touches[i].threshold += self._touch_threshold_adjustment + return self._touches[i].value + + @property + def touch_0(self): + """Detect touch on capacitive touch pad 0. + + .. image :: ../docs/_static/pad_0.jpg + :alt: Pad 0 + + This example prints when pad 0 is touched. + + To use with the CLUE: + + .. code-block:: python + + from adafruit_clue import clue + + while True: + if clue.touch_0: + print("Touched pad 0") + """ + return self._touch(0) + + @property + def touch_1(self): + """Detect touch on capacitive touch pad 1. + + .. image :: ../docs/_static/pad_1.jpg + :alt: Pad 1 + + This example prints when pad 1 is touched. + + To use with the CLUE: + + .. code-block:: python + + from adafruit_clue import clue + + while True: + if clue.touch_1: + print("Touched pad 1") + """ + return self._touch(1) + + @property + def touch_2(self): + """Detect touch on capacitive touch pad 2. + + .. image :: ../docs/_static/pad_2.jpg + :alt: Pad 2 + + This example prints when pad 2 is touched. + + To use with the CLUE: + + .. code-block:: python + + from adafruit_clue import clue + + while True: + if clue.touch_2: + print("Touched pad 2") + """ + return self._touch(2) + + @property + def button_a(self): + """``True`` when Button A is pressed. ``False`` if not. + + .. image :: ../docs/_static/button_a.jpg + :alt: Button A + + This example prints when button A is pressed. + + To use with the CLUE: + + .. code-block:: python + + from adafruit_clue import clue + + while True: + if clue.button_a: + print("Button A pressed") + """ + return not self._a.value + + @property + def button_b(self): + """``True`` when Button B is pressed. ``False`` if not. + + .. image :: ../docs/_static/button_b.jpg + :alt: Button B + + This example prints when button B is pressed. + + To use with the CLUE: + + .. code-block:: python + + from adafruit_clue import clue + + while True: + if clue.button_b: + print("Button B pressed") + """ + return not self._b.value + + @property + def were_pressed(self): + """Returns a set of the buttons that have been pressed. + + .. image :: ../docs/_static/button_b.jpg + :alt: Button B + + To use with the CLUE: + + .. code-block:: python + + from adafruit_clue import clue + + while True: + print(clue.were_pressed) + """ + ret = set() + pressed = self._gamepad.get_pressed() + for button, mask in (('A', 0x01), ('B', 0x02)): + if mask & pressed: + ret.add(button) + return ret + + @property + def acceleration(self): + """Obtain acceleration data from the x, y and z axes. + + .. image :: ../docs/_static/accelerometer.jpg + :alt: Accelerometer + + This example prints the values. Try moving the board to see how the printed values change. + + To use with the CLUE: + + .. code-block:: python + + from adafruit_clue import clue + + while True: + print("Accel: {:.2f} {:.2f} {:.2f}".format(*clue.acceleration)) + """ + return self._accelerometer.acceleration + + @property + def gyro(self): + """Obtain x, y, z angular velocity values in degrees/second. + + .. image :: ../docs/_static/accelerometer.jpg + :alt: Gyro + + This example prints the values. Try moving the board to see how the printed values change. + + To use with the CLUE: + + .. code-block:: python + + from adafruit_clue import clue + + while True: + print("Gyro: {:.2f} {:.2f} {:.2f}".format(*clue.gyro)) + """ + return self._accelerometer.gyro + + @property + def magnetic(self): + """Obtain x, y, z magnetic values in microteslas. + + .. image :: ../docs/_static/magnetometer.jpg + :alt: Magnetometer + + This example prints the values. Try moving the board to see how the printed values change. + + To use with the CLUE: + + .. code-block:: python + + from adafruit_clue import clue + + while True: + print("Magnetic: {:.3f} {:.3f} {:.3f}".format(*clue.magnetic)) + """ + return self._magnetometer.magnetic + + @property + def proximity(self): + """A relative proximity to the sensor in values from 0 - 255. + + .. image :: ../docs/_static/proximity.jpg + :alt: Proximity sensor + + This example prints the value. Try moving your hand towards and away from the front of the + board to see how the printed values change. + + To use with the CLUE: + + .. code-block:: python + + from adafruit_clue import clue + + while True: + print("Proximity: {}".format(clue.proximity)) + """ + self._sensor.enable_proximity = True + return self._sensor.proximity() + + @property + def color(self): + """The red, green, blue, and clear light values. (r, g, b, c) + + .. image :: ../docs/_static/proximity.jpg + :alt: Color sensor + + This example prints the values. Try holding something up to the sensor to see the values + change. Works best with white LEDs enabled. + + To use with the CLUE: + + .. code-block:: python + + from adafruit_clue import clue + + while True: + print("Color: R: {} G: {} B: {} C: {}".format(*clue.color)) + """ + self._sensor.enable_color = True + return self._sensor.color_data + + @property + def gesture(self): + """A gesture code if gesture is detected. Shows ``0`` if no gesture detected. + ``1`` if an UP gesture is detected, ``2`` if DOWN, ``3`` if LEFT, and ``4`` if RIGHT. + + .. image :: ../docs/_static/proximity.jpg + :alt: Gesture sensor + + This example prints the gesture values. Try moving your hand up, down, left or right over + the sensor to see the value change. + + To use with the CLUE: + + .. code-block:: python + + from adafruit_clue import clue + + while True: + print("Gesture: {}".format(clue.gesture)) + """ + self._sensor.enable_gesture = True + return self._sensor.gesture() + + @property + def humidity(self): + """The measured relative humidity in percent. + + .. image :: ../docs/_static/humidity.jpg + :alt: Humidity sensor + + This example prints the value. Try breathing on the sensor to see the values change. + + To use with the CLUE: + + .. code-block:: python + + from adafruit_clue import clue + + while True: + print("Humidity: {:.1f}%".format(clue.humidity)) + """ + return self._humidity.relative_humidity + + @property + def pressure(self): + """The barometric pressure in hectoPascals. + + .. image :: ../docs/_static/pressure.jpg + :alt: Barometric pressure sensor + + This example prints the value. + + To use with the CLUE: + + .. code-block:: python + + from adafruit_clue import clue + + print("Pressure: {:.3f}hPa".format(clue.pressure)) + """ + return self._pressure.pressure + + @property + def temperature(self): + """The temperature in degrees Celsius. + + .. image :: ../docs/_static/pressure.jpg + :alt: Temperature sensor + + This example prints the value. Try touching the sensor to see the value change. + + To use with the CLUE: + + .. code-block:: python + + from adafruit_clue import clue + + print("Temperature: {:.1f}C".format(clue.temperature)) + """ + return self._pressure.temperature + + @property + def altitude(self): + """The altitude in meters based on the sea level pressure at your location. You must set + ``sea_level_pressure`` to receive an accurate reading. + + .. image :: ../docs/_static/pressure.jpg + :alt: Altitude sensor + + This example prints the value. Try moving the board vertically to see the value change. + + .. code-block:: python + + from adafruit_clue import clue + + clue.sea_level_pressure = 1015 + + print("Altitude: {:.1f}m".format(clue.altitude)) + """ + return self._pressure.altitude + + @property + def sea_level_pressure(self): + """Set to the pressure at sea level at your location, before reading altitude for + the most accurate altitude measurement. + + .. image :: ../docs/_static/pressure.jpg + :alt: Barometric pressure sensor + + This example prints the value. + + To use with the CLUE: + + .. code-block:: python + + from adafruit_clue import clue + + clue.sea_level_pressure = 1015 + + print("Pressure: {:.3f}hPa".format(clue.pressure)) + """ + return self._pressure.sea_level_pressure + + @sea_level_pressure.setter + def sea_level_pressure(self, value): + self._pressure.sea_level_pressure = value + + @property + def white_leds(self): + """The red led next to the USB plug labeled LED. + + .. image :: ../docs/_static/white_leds.jpg + :alt: White LEDs + + This example turns on the white LEDs. + + To use with the CLUE: + + .. code-block:: python + + from adafruit_clue import clue + + clue.white_leds = True + """ + return self._white_leds.value + + @white_leds.setter + def white_leds(self, value): + self._white_leds.value = value + + @property + def red_led(self): + """The red led next to the USB plug labeled LED. + + .. image :: ../docs/_static/red_led.jpg + :alt: Red LED + + This example turns on the red LED. + + To use with the CLUE: + + .. code-block:: python + + from adafruit_clue import clue + + clue.red_led = True + """ + return self._red_led.value + + @red_led.setter + def red_led(self, value): + self._red_led.value = value + + @property + def pixel(self): + """The NeoPixel RGB LED. + + .. image :: ../docs/_static/neopixel.jpg + :alt: NeoPixel + + This example turns the NeoPixel purple. + + To use with the CLUE: + + .. code-block:: python + + from adafruit_clue import clue + + clue.pixel.fill((255, 0, 255)) + """ + return self._pixel + + @staticmethod + def _sine_sample(length): + tone_volume = (2 ** 15) - 1 + shift = 2 ** 15 + for i in range(length): + yield int(tone_volume * math.sin(2*math.pi*(i / length)) + shift) + + def _generate_sample(self, length=100): + if self._sample is not None: + return + self._sine_wave = array.array("H", self._sine_sample(length)) + self._sample = audiopwmio.PWMAudioOut(board.SPEAKER) + self._sine_wave_sample = audiocore.RawSample(self._sine_wave) + + def play_tone(self, frequency, duration): + """ Produce a tone using the speaker. Try changing frequency to change + the pitch of the tone. + + :param int frequency: The frequency of the tone in Hz + :param float duration: The duration of the tone in seconds + + .. image :: ../docs/_static/speaker.jpg + :alt: Speaker + + This example plays a 880 Hz tone for a duration of 1 second. + + To use with the CLUE: + + .. code-block:: python + + from adafruit_clue import clue + + clue.play_tone(880, 1) + """ + # Play a tone of the specified frequency (hz). + self.start_tone(frequency) + time.sleep(duration) + self.stop_tone() + + def start_tone(self, frequency): + """ Produce a tone using the speaker. Try changing frequency to change + the pitch of the tone. + + :param int frequency: The frequency of the tone in Hz + + .. image :: ../docs/_static/speaker.jpg + :alt: Speaker + + This example plays a 523Hz tone when button A is pressed and a 587Hz tone when button B is + pressed, only while the buttons are being pressed. + + To use with the CLUE: + + .. code-block:: python + + from adafruit_clue import clue + + while True: + if clue.button_a: + clue.start_tone(523) + elif clue.button_b: + clue.start_tone(587) + else: + clue.stop_tone() + """ + length = 100 + if length * frequency > 350000: + length = 350000 // frequency + self._generate_sample(length) + # Start playing a tone of the specified frequency (hz). + self._sine_wave_sample.sample_rate = int(len(self._sine_wave) * frequency) + if not self._sample.playing: + self._sample.play(self._sine_wave_sample, loop=True) + + def stop_tone(self): + """ Use with start_tone to stop the tone produced. + + .. image :: ../docs/_static/speaker.jpg + :alt: Speaker + + This example plays a 523Hz tone when button A is pressed and a 587Hz tone when button B is + pressed, only while the buttons are being pressed. + + To use with the CLUE: + + .. code-block:: python + + from adafruit_clue import clue + + while True: + if clue.button_a: + clue.start_tone(523) + elif clue.button_b: + clue.start_tone(587) + else: + clue.stop_tone() + """ + # Stop playing any tones. + if self._sample is not None and self._sample.playing: + self._sample.stop() + self._sample.deinit() + self._sample = None + + @staticmethod + def _normalized_rms(values): + mean_values = int(sum(values) / len(values)) + return math.sqrt(sum(float(sample - mean_values) * (sample - mean_values) + for sample in values) / len(values)) + + @property + def sound_level(self): + """Obtain the sound level from the microphone (sound sensor). + + .. image :: ../docs/_static/microphone.jpg + :alt: Microphone (sound sensor) + + This example prints the sound levels. Try clapping or blowing on + the microphone to see the levels change. + + .. code-block:: python + + from adafruit_clue import clue + + while True: + print(clue.sound_level) + """ + if self._sample is None: + self._samples = array.array('H', [0] * 160) + self._mic.record(self._samples, len(self._samples)) + return self._normalized_rms(self._samples) + + def loud_sound(self, sound_threshold=200): + """Utilise a loud sound as an input. + + :param int sound_threshold: Threshold sound level must exceed to return true (Default: 200) + + .. image :: ../docs/_static/microphone.jpg + :alt: Microphone (sound sensor) + + This example turns the NeoPixel LED blue each time you make a loud sound. + Try clapping or blowing onto the microphone to trigger it. + + .. code-block:: python + + from adafruit_clue import clue + + while True: + if clue.loud_sound(): + clue.pixel.fill((0, 50, 0)) + else: + clue.pixel.fill(0) + + You may find that the code is not responding how you would like. + If this is the case, you can change the loud sound threshold to + make it more or less responsive. Setting it to a higher number + means it will take a louder sound to trigger. Setting it to a + lower number will take a quieter sound to trigger. The following + example shows the threshold being set to a higher number than + the default. + + .. code-block:: python + + from adafruit_clue import clue + + while True: + if clue.loud_sound(sound_threshold=300): + clue.pixel.fill((0, 50, 0)) + else: + clue.pixel.fill(0) + """ + + return self.sound_level > sound_threshold + + @staticmethod + def display_clue_data(title="CLUE Sensor Data", title_color=(255, 255, 255), title_scale=1, # pylint: disable=too-many-arguments + num_lines=1, clue_data_scale=1, font=None, colors=None): + """Display CLUE data as lines of text. + + Setup occurs before the loop. For data to be dynamically updated on the display, you must + include the data call in the loop by using ``.text =``. For example, if setup is saved as + ``clue_data = display_clue_data()`` then ``clue_data[0].text = clue.proximity`` must be + inside the ``while True:`` loop for the proximity data displayed to update as the + values change. + + :param str title: The title displayed above the data. Defaults to "CLUE Sensor Data". + :param title_color: The color of the displayed title. Defaults to white 255, 255, 255). + :param int title_scale: Scale the size of the title. Defaults to 1. + :param int num_lines: The number of lines of data you intend to display. Defaults to 1. + :param int clue_data_scale: Scale the size of the data lines. Scales the title as well. + Defaults to 1. + :param str font: The font to use to display the title and data. Defaults to built in + ``terminalio.FONT``. + :param colors: A list of colors for the lines of data on the display. If you provide a + single color, all lines will be that color. Otherwise it will alternate the + list you provide if the list is less than the number of lines displayed. + Default colors are used if ``colors`` is not set. For example, if creating + two lines of data, ``colors=((255, 255, 255), (255, 0, 0))`` would set the + first line white and the second line red, and if you created four lines of + data with the same setup, it would alternate white and red. + + .. image :: ../docs/_static/display_clue_data.jpg + :alt: Display Clue Data demo + + This example displays three lines with acceleration, gyro and magnetic data on the display. + + .. code-block:: python + + from adafruit_clue import clue + + clue_data = clue.display_clue_data(title="CLUE Sensor Data!", title_scale=2, num_lines=3) + + while True: + clue_data[0].text = "Acceleration: {:.2f} {:.2f} {:.2f}".format(*clue.acceleration) + clue_data[1].text = "Gyro: {:.2f} {:.2f} {:.2f}".format(*clue.gyro) + clue_data[2].text = "Magnetic: {:.3f} {:.3f} {:.3f}".format(*clue.magnetic) + """ + return _DisplayClueData(title=title, title_color=title_color, title_scale=title_scale, + num_lines=num_lines, clue_data_scale=clue_data_scale, font=font, + colors=colors) + + +clue = Clue() # pylint: disable=invalid-name +"""Object that is automatically created on import. + + To use, simply import it from the module: + + .. code-block:: python + + from adafruit_clue import clue +""" diff --git a/docs/_static/accelerometer.jpg b/docs/_static/accelerometer.jpg new file mode 100644 index 0000000..f08d171 Binary files /dev/null and b/docs/_static/accelerometer.jpg differ diff --git a/docs/_static/button_a.jpg b/docs/_static/button_a.jpg new file mode 100644 index 0000000..e7e9398 Binary files /dev/null and b/docs/_static/button_a.jpg differ diff --git a/docs/_static/button_b.jpg b/docs/_static/button_b.jpg new file mode 100644 index 0000000..a6fa8a6 Binary files /dev/null and b/docs/_static/button_b.jpg differ diff --git a/docs/_static/display_clue_data.jpg b/docs/_static/display_clue_data.jpg new file mode 100644 index 0000000..bff72d9 Binary files /dev/null and b/docs/_static/display_clue_data.jpg differ diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico new file mode 100644 index 0000000..5aca983 Binary files /dev/null and b/docs/_static/favicon.ico differ diff --git a/docs/_static/humidity.jpg b/docs/_static/humidity.jpg new file mode 100644 index 0000000..356f739 Binary files /dev/null and b/docs/_static/humidity.jpg differ diff --git a/docs/_static/magnetometer.jpg b/docs/_static/magnetometer.jpg new file mode 100644 index 0000000..636c30d Binary files /dev/null and b/docs/_static/magnetometer.jpg differ diff --git a/docs/_static/microphone.jpg b/docs/_static/microphone.jpg new file mode 100644 index 0000000..9bf030f Binary files /dev/null and b/docs/_static/microphone.jpg differ diff --git a/docs/_static/neopixel.jpg b/docs/_static/neopixel.jpg new file mode 100644 index 0000000..d5444f1 Binary files /dev/null and b/docs/_static/neopixel.jpg differ diff --git a/docs/_static/pad_0.jpg b/docs/_static/pad_0.jpg new file mode 100644 index 0000000..ed19913 Binary files /dev/null and b/docs/_static/pad_0.jpg differ diff --git a/docs/_static/pad_1.jpg b/docs/_static/pad_1.jpg new file mode 100644 index 0000000..bde8b3c Binary files /dev/null and b/docs/_static/pad_1.jpg differ diff --git a/docs/_static/pad_2.jpg b/docs/_static/pad_2.jpg new file mode 100644 index 0000000..d5a6b29 Binary files /dev/null and b/docs/_static/pad_2.jpg differ diff --git a/docs/_static/pressure.jpg b/docs/_static/pressure.jpg new file mode 100644 index 0000000..677b3c3 Binary files /dev/null and b/docs/_static/pressure.jpg differ diff --git a/docs/_static/proximity.jpg b/docs/_static/proximity.jpg new file mode 100644 index 0000000..1f561da Binary files /dev/null and b/docs/_static/proximity.jpg differ diff --git a/docs/_static/red_led.jpg b/docs/_static/red_led.jpg new file mode 100644 index 0000000..3612cb1 Binary files /dev/null and b/docs/_static/red_led.jpg differ diff --git a/docs/_static/speaker.jpg b/docs/_static/speaker.jpg new file mode 100644 index 0000000..25384a4 Binary files /dev/null and b/docs/_static/speaker.jpg differ diff --git a/docs/_static/white_leds.jpg b/docs/_static/white_leds.jpg new file mode 100644 index 0000000..38d38c9 Binary files /dev/null and b/docs/_static/white_leds.jpg differ diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 0000000..69e2c21 --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,8 @@ + +.. If you created a package, create one automodule per module in the package. + +.. 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" + +.. automodule:: adafruit_clue + :members: diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..bbd753c --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,162 @@ +# -*- coding: utf-8 -*- + +import os +import sys +sys.path.insert(0, os.path.abspath('..')) + +# -- General configuration ------------------------------------------------ + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.intersphinx', + 'sphinx.ext.napoleon', + 'sphinx.ext.todo', +] + +# TODO: Please Read! +# Uncomment the below if you use native CircuitPython modules such as +# digitalio, micropython and busio. List the modules you use. Without it, the +# autodoc module docs will fail to generate with a warning. +autodoc_mock_imports = ["board", "digitalio", "audiobusio", "audiopwmio", "audiocore", "gamepad", + "touchio", "neopixel", "adafruit_apds9960", "adafruit_bmp280", + "adafruit_lis3mdl", "adafruit_lsm6ds", "adafruit_sht31d"] + + +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)} + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'Adafruit CLUE Library' +copyright = u'2020 Kattni Rembor' +author = u'Kattni Rembor' + +# 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' +# The full version, including alpha/beta/rc tags. +release = u'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 + +# 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'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# +default_role = "any" + +# If true, '()' will be appended to :func: etc. cross-reference text. +# +add_function_parentheses = True + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + +# If this is True, todo emits a warning for each TODO entries. The default is False. +todo_emit_warnings = True + +napoleon_numpy_docstring = False + +# -- Options for HTML output ---------------------------------------------- + +# 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 = ['.'] + +# 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'] + +# 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' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'AdafruitClueLibrarydoc' + +# -- 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', +} + +# 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, 'AdafruitCLUELibrary.tex', u'AdafruitCLUE Library Documentation', + author, 'manual'), +] + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'AdafruitCLUElibrary', u'Adafruit CLUE Library Documentation', + [author], 1) +] + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'AdafruitCLUELibrary', u'Adafruit CLUE Library Documentation', + author, 'AdafruitCLUELibrary', 'One line description of project.', + 'Miscellaneous'), +] diff --git a/docs/examples.rst b/docs/examples.rst new file mode 100644 index 0000000..9ae43b6 --- /dev/null +++ b/docs/examples.rst @@ -0,0 +1,8 @@ +Simple test +------------ + +Ensure your device works with this simple test. + +.. literalinclude:: ../examples/clue_simpletest.py + :caption: examples/clue_simpletest.py + :linenos: diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..56d75d0 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,48 @@ +.. include:: ../README.rst + +Table of Contents +================= + +.. toctree:: + :maxdepth: 4 + :hidden: + + self + +.. toctree:: + :caption: Examples + + examples + +.. toctree:: + :caption: API Reference + :maxdepth: 3 + + api + +.. toctree:: + :caption: Tutorials + + +.. toctree:: + :caption: Related Products + + Adafruit CLUE - nRF52840 Express with Bluetooth LE + +.. toctree:: + :caption: Other Links + + Download + CircuitPython Reference Documentation + CircuitPython Support Forum + Discord Chat + Adafruit Learning System + Adafruit Blog + Adafruit Store + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/examples/clue_simpletest.py b/examples/clue_simpletest.py new file mode 100644 index 0000000..90b3831 --- /dev/null +++ b/examples/clue_simpletest.py @@ -0,0 +1,23 @@ +from adafruit_clue import clue + +clue.sea_level_pressure = 1020 + +clue_data = clue.display_clue_data(title="CLUE Sensor Data!", title_scale=2, num_lines=15) + +while True: + clue_data[0].text = "Acceleration: {:.2f} {:.2f} {:.2f}".format(*clue.acceleration) + clue_data[1].text = "Gyro: {:.2f} {:.2f} {:.2f}".format(*clue.gyro) + clue_data[2].text = "Magnetic: {:.3f} {:.3f} {:.3f}".format(*clue.magnetic) + clue_data[3].text = "Pressure: {:.3f}hPa".format(clue.pressure) + clue_data[4].text = "Altitude: {:.1f}m".format(clue.altitude) + clue_data[5].text = "Temperature: {:.1f}C".format(clue.temperature) + clue_data[6].text = "Humidity: {:.1f}%".format(clue.humidity) + clue_data[7].text = "Proximity: {}".format(clue.proximity) + clue_data[8].text = "Gesture: {}".format(clue.gesture) + clue_data[9].text = "Color: R: {} G: {} B: {} C: {}".format(*clue.color) + clue_data[10].text = "Button A: {}".format(clue.button_a) + clue_data[11].text = "Button B: {}".format(clue.button_b) + clue_data[12].text = "Touch 0: {}".format(clue.touch_0) + clue_data[13].text = "Touch 1: {}".format(clue.touch_1) + clue_data[14].text = "Touch 2: {}".format(clue.touch_2) + clue_data.show() diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..397a144 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,10 @@ +Adafruit-Blinka +adafruit-circuitpython-busdevice +adafruit-circuitpython-register +adafruit-circuitpython-neopixel +adafruit-circuitpython-sht31d +adafruit-circuitpython-lsm6ds +adafruit-circuitpython-lis3mdl +adafruit-circuitpython-display-text +adafuit-circuitpython-bmp280 +adafruit-circuitpython-apds9960 diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..ff36b6e --- /dev/null +++ b/setup.py @@ -0,0 +1,73 @@ +"""A setuptools based setup module. + +See: +https://packaging.python.org/en/latest/distributing.html +https://github.com/pypa/sampleproject +""" + +from setuptools import setup, find_packages +# To use a consistent encoding +from codecs import open +from os import path + +here = path.abspath(path.dirname(__file__)) + +# Get the long description from the README file +with open(path.join(here, 'README.rst'), encoding='utf-8') as f: + long_description = f.read() + +setup( + name='adafruit-circuitpython-clue', + + use_scm_version=True, + setup_requires=['setuptools_scm'], + + description='A high level library representing all the features of the Adafruit CLUE.', + long_description=long_description, + long_description_content_type='text/x-rst', + + # The project's main homepage. + url='https://github.com/adafruit/Adafruit_CircuitPython_CLUE', + + # Author details + author='Adafruit Industries', + author_email='circuitpython@adafruit.com', + + install_requires=[ + 'Adafruit-Blinka', + 'adafruit-circuitpython-busdevice', + 'adafruit-circuitpython-register', + 'adafruit-circuitpython-neopixel', + 'adafruit-circuitpython-sht31d', + 'adafruit-circuitpython-lsm6ds', + 'adafruit-circuitpython-lis3mdl', + 'adafruit-circuitpython-display-text', + 'adafuit-circuitpython-bmp280', + 'adafruit-circuitpython-apds9960' + ], + + # Choose your license + license='MIT', + + # See https://pypi.python.org/pypi?%3Aaction=list_classifiers + classifiers=[ + 'Development Status :: 3 - Alpha', + 'Intended Audience :: Developers', + 'Topic :: Software Development :: Libraries', + 'Topic :: System :: Hardware', + 'License :: OSI Approved :: MIT License', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.4', + 'Programming Language :: Python :: 3.5', + ], + + # What does your project relate to? + keywords='adafruit blinka circuitpython micropython clue sensor humidity temperature ' + 'pressure altitude color proximity gesture light sensors gyro acceleration sound', + + # You can just specify the packages manually here if your project is + # simple. Or you can use find_packages(). + # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER, + # CHANGE `py_modules=['...']` TO `packages=['...']` + py_modules=['adafruit_clue'], +)