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/workflows/build.yml b/.github/workflows/build.yml index ca35544..041a337 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -10,66 +10,5 @@ jobs: test: runs-on: ubuntu-latest steps: - - name: Dump GitHub context - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - run: echo "$GITHUB_CONTEXT" - - name: Translate Repo Name For Build Tools filename_prefix - id: repo-name - run: | - echo ::set-output name=repo-name::$( - echo ${{ github.repository }} | - awk -F '\/' '{ print tolower($2) }' | - tr '_' '-' - ) - - name: Set up Python 3.7 - uses: actions/setup-python@v1 - with: - python-version: 3.7 - - name: Versions - run: | - python3 --version - - name: Checkout Current Repo - uses: actions/checkout@v1 - with: - submodules: true - - name: Checkout tools repo - uses: actions/checkout@v2 - with: - repository: adafruit/actions-ci-circuitpython-libs - path: actions-ci - - name: Install dependencies - # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.) - run: | - source actions-ci/install.sh - - name: Pip install Sphinx, pre-commit - run: | - pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit - - name: Library version - run: git describe --dirty --always --tags - - name: Pre-commit hooks - run: | - pre-commit run --all-files - - name: Build assets - run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - - name: Archive bundles - uses: actions/upload-artifact@v2 - with: - name: bundles - path: ${{ github.workspace }}/bundles/ - - name: Build docs - working-directory: docs - run: sphinx-build -E -W -b html . _build/html - - name: Check For setup.py - id: need-pypi - run: | - echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) - - name: Build Python package - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - run: | - pip install --upgrade setuptools wheel twine readme_renderer testresources - python setup.py sdist - python setup.py bdist_wheel --universal - twine check dist/* - - name: Setup problem matchers - uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 + - name: Run Build CI workflow + uses: adafruit/workflows-circuitpython-libs/build@main diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index 6d0015a..0000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,85 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -name: Release Actions - -on: - release: - types: [published] - -jobs: - upload-release-assets: - runs-on: ubuntu-latest - steps: - - name: Dump GitHub context - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - run: echo "$GITHUB_CONTEXT" - - name: Translate Repo Name For Build Tools filename_prefix - id: repo-name - run: | - echo ::set-output name=repo-name::$( - echo ${{ github.repository }} | - awk -F '\/' '{ print tolower($2) }' | - tr '_' '-' - ) - - name: Set up Python 3.6 - uses: actions/setup-python@v1 - with: - python-version: 3.6 - - name: Versions - run: | - python3 --version - - name: Checkout Current Repo - uses: actions/checkout@v1 - with: - submodules: true - - name: Checkout tools repo - uses: actions/checkout@v2 - with: - repository: adafruit/actions-ci-circuitpython-libs - path: actions-ci - - name: Install deps - run: | - source actions-ci/install.sh - - name: Build assets - run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - - name: Upload Release Assets - # the 'official' actions version does not yet support dynamically - # supplying asset names to upload. @csexton's version chosen based on - # discussion in the issue below, as its the simplest to implement and - # allows for selecting files with a pattern. - # https://github.com/actions/upload-release-asset/issues/4 - #uses: actions/upload-release-asset@v1.0.1 - uses: csexton/release-asset-action@master - with: - pattern: "bundles/*" - github-token: ${{ secrets.GITHUB_TOKEN }} - - upload-pypi: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v1 - - name: Check For setup.py - id: need-pypi - run: | - echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) - - name: Set up Python - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - uses: actions/setup-python@v1 - with: - python-version: '3.x' - - name: Install dependencies - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - run: | - python -m pip install --upgrade pip - pip install setuptools wheel twine - - name: Build and publish - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - env: - TWINE_USERNAME: ${{ secrets.pypi_username }} - TWINE_PASSWORD: ${{ secrets.pypi_password }} - run: | - python setup.py sdist - twine upload dist/* diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml new file mode 100644 index 0000000..9acec60 --- /dev/null +++ b/.github/workflows/release_gh.yml @@ -0,0 +1,19 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: GitHub Release Actions + +on: + release: + types: [published] + +jobs: + upload-release-assets: + runs-on: ubuntu-latest + steps: + - name: Run GitHub Release CI workflow + uses: adafruit/workflows-circuitpython-libs/release-gh@main + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + upload-url: ${{ github.event.release.upload_url }} diff --git a/.github/workflows/release_pypi.yml b/.github/workflows/release_pypi.yml new file mode 100644 index 0000000..65775b7 --- /dev/null +++ b/.github/workflows/release_pypi.yml @@ -0,0 +1,19 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: PyPI Release Actions + +on: + release: + types: [published] + +jobs: + upload-release-assets: + runs-on: ubuntu-latest + steps: + - name: Run PyPI Release CI workflow + uses: adafruit/workflows-circuitpython-libs/release-pypi@main + with: + pypi-username: ${{ secrets.pypi_username }} + pypi-password: ${{ secrets.pypi_password }} diff --git a/.gitignore b/.gitignore index 9bfdd9d..db3d538 100644 --- a/.gitignore +++ b/.gitignore @@ -1,10 +1,48 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Kattni Rembor, written for Adafruit Industries # -# SPDX-License-Identifier: Unlicense +# SPDX-License-Identifier: MIT +# Do not include files and directories created by your personal work environment, such as the IDE +# you use, except for those already listed here. Pull requests including changes to this file will +# not be accepted. + +# This .gitignore file contains rules for files generated by working with CircuitPython libraries, +# including building Sphinx, testing with pip, and creating a virual environment, as well as the +# MacOS and IDE-specific files generated by using MacOS in general, or the PyCharm or VSCode IDEs. + +# If you find that there are files being generated on your machine that should not be included in +# your git commit, you should create a .gitignore_global file on your computer to include the +# files created by your personal setup. To do so, follow the two steps below. + +# First, create a file called .gitignore_global somewhere convenient for you, and add rules for +# the files you want to exclude from git commits. + +# Second, configure Git to use the exclude file for all Git repositories by running the +# following via commandline, replacing "path/to/your/" with the actual path to your newly created +# .gitignore_global file: +# git config --global core.excludesfile path/to/your/.gitignore_global + +# CircuitPython-specific files +*.mpy + +# 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 + +# IDE-specific files .idea +.vscode +*~ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 43d1385..ff19dde 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,42 +1,21 @@ -# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries # # SPDX-License-Identifier: Unlicense repos: -- repo: https://github.com/python/black - rev: 20.8b1 + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.5.0 hooks: - - id: black -- repo: https://github.com/fsfe/reuse-tool - rev: v0.12.1 + - id: check-yaml + - id: end-of-file-fixer + - id: trailing-whitespace + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.3.4 hooks: - - id: reuse -- repo: https://github.com/pre-commit/pre-commit-hooks - rev: v2.3.0 + - id: ruff-format + - id: ruff + args: ["--fix"] + - repo: https://github.com/fsfe/reuse-tool + rev: v3.0.1 hooks: - - id: check-yaml - - id: end-of-file-fixer - - id: trailing-whitespace -- repo: https://github.com/pycqa/pylint - rev: v2.11.1 - hooks: - - id: pylint - name: pylint (library code) - types: [python] - args: - - --disable=consider-using-f-string,duplicate-code - exclude: "^(docs/|examples/|tests/|setup.py$)" - - id: pylint - name: pylint (example code) - description: Run pylint rules on "examples/*.py" files - types: [python] - files: "^examples/" - args: - - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code - - id: pylint - name: pylint (test code) - description: Run pylint rules on "tests/*.py" files - types: [python] - files: "^tests/" - args: - - --disable=missing-docstring,consider-using-f-string,duplicate-code + - id: reuse diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index cfd1c41..0000000 --- a/.pylintrc +++ /dev/null @@ -1,436 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -[MASTER] - -# A comma-separated list of package or module names from where C extensions may -# be loaded. Extensions are loading into the active Python interpreter and may -# run arbitrary code -extension-pkg-whitelist= - -# Add files or directories to the blacklist. They should be base names, not -# paths. -ignore=CVS - -# Add files or directories matching the regex patterns to the blacklist. The -# regex matches against base names, not paths. -ignore-patterns= - -# Python code to execute, usually for sys.path manipulation such as -# pygtk.require(). -#init-hook= - -# Use multiple processes to speed up Pylint. -jobs=1 - -# List of plugins (as comma separated values of python modules names) to load, -# usually to register additional checkers. -load-plugins= - -# Pickle collected data for later comparisons. -persistent=yes - -# Specify a configuration file. -#rcfile= - -# Allow loading of arbitrary C extensions. Extensions are imported into the -# active Python interpreter and may run arbitrary code. -unsafe-load-any-extension=no - - -[MESSAGES CONTROL] - -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED -confidence= - -# Disable the message, report, category or checker with the given id(s). You -# can either give multiple identifiers separated by comma (,) or put this -# option multiple times (only on the command line, not in the configuration -# file where it should appear only once).You can also use "--disable=all" to -# disable everything first and then reenable specific checks. For example, if -# you want to run only the similarities checker, you can use "--disable=all -# --enable=similarities". If you want to run only the classes checker, but have -# no Warning level messages displayed, use"--disable=all --enable=classes -# --disable=W" -# disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call -disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation,unspecified-encoding - -# Enable the message, report, category or checker with the given id(s). You can -# either give multiple identifier separated by comma (,) or put this option -# multiple time (only on the command line, not in the configuration file where -# it should appear only once). See also the "--disable" option for examples. -enable= - - -[REPORTS] - -# Python expression which should return a note less than 10 (10 is the highest -# note). You have access to the variables errors warning, statement which -# respectively contain the number of errors / warnings messages and the total -# number of statements analyzed. This is used by the global evaluation report -# (RP0004). -evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) - -# Template used to display messages. This is a python new-style format string -# used to format the message information. See doc for all details -#msg-template= - -# Set the output format. Available formats are text, parseable, colorized, json -# and msvs (visual studio).You can also give a reporter class, eg -# mypackage.mymodule.MyReporterClass. -output-format=text - -# Tells whether to display a full report or only the messages -reports=no - -# Activate the evaluation score. -score=yes - - -[REFACTORING] - -# Maximum number of nested blocks for function / method body -max-nested-blocks=5 - - -[LOGGING] - -# Logging modules to check that the string format arguments are in logging -# function parameter format -logging-modules=logging - - -[SPELLING] - -# Spelling dictionary name. Available dictionaries: none. To make it working -# install python-enchant package. -spelling-dict= - -# List of comma separated words that should not be checked. -spelling-ignore-words= - -# A path to a file that contains private dictionary; one word per line. -spelling-private-dict-file= - -# Tells whether to store unknown words to indicated private dictionary in -# --spelling-private-dict-file option instead of raising a message. -spelling-store-unknown-words=no - - -[MISCELLANEOUS] - -# List of note tags to take in consideration, separated by a comma. -# notes=FIXME,XXX,TODO -notes=FIXME,XXX - - -[TYPECHECK] - -# List of decorators that produce context managers, such as -# contextlib.contextmanager. Add to this list to register other decorators that -# produce valid context managers. -contextmanager-decorators=contextlib.contextmanager - -# List of members which are set dynamically and missed by pylint inference -# system, and so shouldn't trigger E1101 when accessed. Python regular -# expressions are accepted. -generated-members= - -# Tells whether missing members accessed in mixin class should be ignored. A -# mixin class is detected if its name ends with "mixin" (case insensitive). -ignore-mixin-members=yes - -# This flag controls whether pylint should warn about no-member and similar -# checks whenever an opaque object is returned when inferring. The inference -# can return multiple potential results while evaluating a Python object, but -# some branches might not be evaluated, which results in partial inference. In -# that case, it might be useful to still emit no-member and other checks for -# the rest of the inferred objects. -ignore-on-opaque-inference=yes - -# List of class names for which member attributes should not be checked (useful -# for classes with dynamically set attributes). This supports the use of -# qualified names. -ignored-classes=optparse.Values,thread._local,_thread._local - -# List of module names for which member attributes should not be checked -# (useful for modules/projects where namespaces are manipulated during runtime -# and thus existing member attributes cannot be deduced by static analysis. It -# supports qualified module names, as well as Unix pattern matching. -ignored-modules=board - -# Show a hint with possible names when a member name was not found. The aspect -# of finding the hint is based on edit distance. -missing-member-hint=yes - -# The minimum edit distance a name should have in order to be considered a -# similar match for a missing member name. -missing-member-hint-distance=1 - -# The total number of similar names that should be taken in consideration when -# showing a hint for a missing member. -missing-member-max-choices=1 - - -[VARIABLES] - -# List of additional names supposed to be defined in builtins. Remember that -# you should avoid to define new builtins when possible. -additional-builtins= - -# Tells whether unused global variables should be treated as a violation. -allow-global-unused-variables=yes - -# List of strings which can identify a callback function by name. A callback -# name must start or end with one of those strings. -callbacks=cb_,_cb - -# A regular expression matching the name of dummy variables (i.e. expectedly -# not used). -dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ - -# Argument names that match this expression will be ignored. Default to name -# with leading underscore -ignored-argument-names=_.*|^ignored_|^unused_ - -# Tells whether we should check for unused import in __init__ files. -init-import=no - -# List of qualified module names which can have objects that can redefine -# builtins. -redefining-builtins-modules=six.moves,future.builtins - - -[FORMAT] - -# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. -# expected-line-ending-format= -expected-line-ending-format=LF - -# Regexp for a line that is allowed to be longer than the limit. -ignore-long-lines=^\s*(# )??$ - -# Number of spaces of indent required inside a hanging or continued line. -indent-after-paren=4 - -# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 -# tab). -indent-string=' ' - -# Maximum number of characters on a single line. -max-line-length=100 - -# Maximum number of lines in a module -max-module-lines=1000 - -# List of optional constructs for which whitespace checking is disabled. `dict- -# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. -# `trailing-comma` allows a space between comma and closing bracket: (a, ). -# `empty-line` allows space-only lines. -no-space-check=trailing-comma,dict-separator - -# Allow the body of a class to be on the same line as the declaration if body -# contains single statement. -single-line-class-stmt=no - -# Allow the body of an if to be on the same line as the test if there is no -# else. -single-line-if-stmt=no - - -[SIMILARITIES] - -# Ignore comments when computing similarities. -ignore-comments=yes - -# Ignore docstrings when computing similarities. -ignore-docstrings=yes - -# Ignore imports when computing similarities. -ignore-imports=yes - -# Minimum lines number of a similarity. -min-similarity-lines=4 - - -[BASIC] - -# Naming hint for argument names -argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct argument names -argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Naming hint for attribute names -attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct attribute names -attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Bad variable names which should always be refused, separated by a comma -bad-names=foo,bar,baz,toto,tutu,tata - -# Naming hint for class attribute names -class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Regular expression matching correct class attribute names -class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Naming hint for class names -# class-name-hint=[A-Z_][a-zA-Z0-9]+$ -class-name-hint=[A-Z_][a-zA-Z0-9_]+$ - -# Regular expression matching correct class names -# class-rgx=[A-Z_][a-zA-Z0-9]+$ -class-rgx=[A-Z_][a-zA-Z0-9_]+$ - -# Naming hint for constant names -const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - -# Regular expression matching correct constant names -const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - -# Minimum line length for functions/classes that require docstrings, shorter -# ones are exempt. -docstring-min-length=-1 - -# Naming hint for function names -function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct function names -function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Good variable names which should always be accepted, separated by a comma -# good-names=i,j,k,ex,Run,_ -good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ - -# Include a hint for the correct naming format with invalid-name -include-naming-hint=no - -# Naming hint for inline iteration names -inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ - -# Regular expression matching correct inline iteration names -inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ - -# Naming hint for method names -method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct method names -method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Naming hint for module names -module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ - -# Regular expression matching correct module names -module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ - -# Colon-delimited sets of names that determine each other's naming style when -# the name regexes allow several styles. -name-group= - -# Regular expression which should only match function or class names that do -# not require a docstring. -no-docstring-rgx=^_ - -# List of decorators that produce properties, such as abc.abstractproperty. Add -# to this list to register other decorators that produce valid properties. -property-classes=abc.abstractproperty - -# Naming hint for variable names -variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct variable names -variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - - -[IMPORTS] - -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no - -# Analyse import fallback blocks. This can be used to support both Python 2 and -# 3 compatible code, which means that the block might have code that exists -# only in one or another interpreter, leading to false positives when analysed. -analyse-fallback-blocks=no - -# Deprecated modules which should not be used, separated by a comma -deprecated-modules=optparse,tkinter.tix - -# Create a graph of external dependencies in the given file (report RP0402 must -# not be disabled) -ext-import-graph= - -# Create a graph of every (i.e. internal and external) dependencies in the -# given file (report RP0402 must not be disabled) -import-graph= - -# Create a graph of internal dependencies in the given file (report RP0402 must -# not be disabled) -int-import-graph= - -# Force import order to recognize a module as part of the standard -# compatibility libraries. -known-standard-library= - -# Force import order to recognize a module as part of a third party library. -known-third-party=enchant - - -[CLASSES] - -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__,__new__,setUp - -# List of member names, which should be excluded from the protected access -# warning. -exclude-protected=_asdict,_fields,_replace,_source,_make - -# List of valid names for the first argument in a class method. -valid-classmethod-first-arg=cls - -# List of valid names for the first argument in a metaclass class method. -valid-metaclass-classmethod-first-arg=mcs - - -[DESIGN] - -# Maximum number of arguments for function / method -max-args=5 - -# Maximum number of attributes for a class (see R0902). -# max-attributes=7 -max-attributes=11 - -# Maximum number of boolean expressions in a if statement -max-bool-expr=5 - -# Maximum number of branch for function / method body -max-branches=12 - -# Maximum number of locals for function / method body -max-locals=15 - -# Maximum number of parents for a class (see R0901). -max-parents=7 - -# Maximum number of public methods for a class (see R0904). -max-public-methods=20 - -# Maximum number of return / yield for function / method body -max-returns=6 - -# Maximum number of statements in function / method body -max-statements=50 - -# Minimum number of public methods for a class (see R0903). -min-public-methods=1 - - -[EXCEPTIONS] - -# Exceptions that will emit a warning when being caught. Defaults to -# "Exception" -overgeneral-exceptions=Exception diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 95ec218..88bca9f 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,8 +8,15 @@ # Required version: 2 +sphinx: + configuration: docs/conf.py + +build: + os: ubuntu-20.04 + tools: + python: "3" + python: - version: "3.6" install: - requirements: docs/requirements.txt - requirements: requirements.txt diff --git a/README.rst b/README.rst index 6a8c1e1..680cea2 100644 --- a/README.rst +++ b/README.rst @@ -2,10 +2,10 @@ Introduction ============ .. image:: https://readthedocs.org/projects/adafruit_circuitpython_led_animation/badge/?version=latest - :target: https://circuitpython.readthedocs.io/projects/led-animation/en/latest/ + :target: https://docs.circuitpython.org/projects/led-animation/en/latest/ :alt: Documentation Status -.. image:: https://img.shields.io/discord/327254708534116352.svg +.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg :target: https://adafru.it/discord :alt: Discord @@ -13,6 +13,10 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation/actions :alt: Build Status +.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json + :target: https://github.com/astral-sh/ruff + :alt: Code Style: Ruff + Perform a variety of LED animation tasks Dependencies @@ -46,8 +50,8 @@ To install in a virtual environment in your current project: .. code-block:: shell mkdir project-name && cd project-name - python3 -m venv .env - source .env/bin/activate + python3 -m venv .venv + source .venv/bin/activate pip3 install adafruit-circuitpython-led-animation Usage Example @@ -57,7 +61,7 @@ Usage Example import board import neopixel - from adafruit_led_animation.animation import Blink + from adafruit_led_animation.animation.blink import Blink import adafruit_led_animation.color as color # Works on Circuit Playground Express and Bluefruit. @@ -75,7 +79,9 @@ Usage Example Documentation ============= -API documentation for this library can be found on `Read the Docs `_. +API documentation for this library can be found on `Read the Docs `_. + +For information on building library documentation, please check out `this guide `_. Contributing ============ @@ -95,15 +101,15 @@ To build this library locally you'll need to install the .. code-block:: shell - python3 -m venv .env - source .env/bin/activate + python3 -m venv .venv + source .venv/bin/activate pip install circuitpython-build-tools Once installed, make sure you are in the virtual environment: .. code-block:: shell - source .env/bin/activate + source .venv/bin/activate Then run the build: @@ -119,8 +125,8 @@ install dependencies (feel free to reuse the virtual environment from above): .. code-block:: shell - python3 -m venv .env - source .env/bin/activate + python3 -m venv .venv + source .venv/bin/activate pip install Sphinx sphinx-rtd-theme Now, once you have the virtual environment activated: diff --git a/adafruit_led_animation/__init__.py b/adafruit_led_animation/__init__.py index 1442e90..a9d8a8c 100644 --- a/adafruit_led_animation/__init__.py +++ b/adafruit_led_animation/__init__.py @@ -12,7 +12,7 @@ from micropython import const except ImportError: - def const(value): # pylint: disable=missing-docstring + def const(value): return value @@ -27,7 +27,6 @@ def monotonic_ms(): """ return monotonic_ns() // NANOS_PER_MS - except (ImportError, NotImplementedError): import time diff --git a/adafruit_led_animation/animation/__init__.py b/adafruit_led_animation/animation/__init__.py index e870b5f..76d0af3 100644 --- a/adafruit_led_animation/animation/__init__.py +++ b/adafruit_led_animation/animation/__init__.py @@ -25,20 +25,19 @@ """ -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation.git" from adafruit_led_animation import MS_PER_SECOND, monotonic_ms class Animation: - # pylint: disable=too-many-instance-attributes """ Base class for animations. """ + on_cycle_complete_supported = False - # pylint: disable=too-many-arguments def __init__(self, pixel_object, speed, color, peers=None, paused=False, name=None): self.pixel_object = pixel_object self.pixel_object.auto_write = False @@ -61,7 +60,7 @@ def __init__(self, pixel_object, speed, color, peers=None, paused=False, name=No """Number of animation cycles completed.""" def __str__(self): - return "<%s: %s>" % (self.__class__.__name__, self.name) + return f"<{self.__class__.__name__}: {self.name}>" def animate(self, show=True): """ diff --git a/adafruit_led_animation/animation/blink.py b/adafruit_led_animation/animation/blink.py index 34de026..0cba0a5 100644 --- a/adafruit_led_animation/animation/blink.py +++ b/adafruit_led_animation/animation/blink.py @@ -37,10 +37,14 @@ class Blink(ColorCycle): :param pixel_object: The initialised LED object. :param float speed: Animation speed in seconds, e.g. ``0.1``. :param color: Animation color in ``(r, g, b)`` tuple, or ``0x000000`` hex format. + :param background_color: Background color in ``(r, g, b)`` tuple, or ``0x000000`` + hex format. Defaults to BLACK. + :param name: A human-readable name for the Animation. Used by the string function. """ - def __init__(self, pixel_object, speed, color, name=None): - super().__init__(pixel_object, speed, [color, BLACK], name=name) + def __init__(self, pixel_object, speed, color, background_color=BLACK, name=None): + self._background_color = background_color + super().__init__(pixel_object, speed, [color, background_color], name=name) def _set_color(self, color): - self.colors = [color, BLACK] + self.colors = [color, self._background_color] diff --git a/adafruit_led_animation/animation/chase.py b/adafruit_led_animation/animation/chase.py index dbcedd3..5437ad5 100644 --- a/adafruit_led_animation/animation/chase.py +++ b/adafruit_led_animation/animation/chase.py @@ -43,10 +43,7 @@ class Chase(Animation): :param reverse: Reverse direction of movement. """ - # pylint: disable=too-many-arguments - def __init__( - self, pixel_object, speed, color, size=2, spacing=3, reverse=False, name=None - ): + def __init__(self, pixel_object, speed, color, size=2, spacing=3, reverse=False, name=None): self._size = size self._spacing = spacing self._repeat_width = size + spacing @@ -96,13 +93,13 @@ def bar_colors(): bar_no += 1 colorgen = bar_colors() - self.pixel_object[:] = [next(colorgen) for _ in self.pixel_object] + self.pixel_object[:] = [next(colorgen) for _ in range(len(self.pixel_object))] if self.draw_count % len(self.pixel_object) == 0: self.cycle_complete = True self._offset = (self._offset + self._direction) % self._repeat_width - def bar_color(self, n, pixel_no=0): # pylint: disable=unused-argument + def bar_color(self, n, pixel_no=0): """ Generate the color for the n'th bar_color in the Chase @@ -111,7 +108,8 @@ def bar_color(self, n, pixel_no=0): # pylint: disable=unused-argument """ return self.color - def space_color(self, n, pixel_no=0): # pylint: disable=unused-argument,no-self-use + @staticmethod + def space_color(n, pixel_no=0): """ Generate the spacing color for the n'th bar_color in the Chase diff --git a/adafruit_led_animation/animation/colorcycle.py b/adafruit_led_animation/animation/colorcycle.py index 5f27954..1f5908e 100644 --- a/adafruit_led_animation/animation/colorcycle.py +++ b/adafruit_led_animation/animation/colorcycle.py @@ -38,12 +38,14 @@ class ColorCycle(Animation): :param float speed: Animation speed in seconds, e.g. ``0.1``. :param colors: A list of colors to cycle through in ``(r, g, b)`` tuple, or ``0x000000`` hex format. Defaults to a rainbow color cycle. + :param start_color: An index (from 0) for which color to start from. Default 0 (first color). """ - def __init__(self, pixel_object, speed, colors=RAINBOW, name=None): + def __init__(self, pixel_object, speed, colors=RAINBOW, name=None, start_color=0): self.colors = colors - super().__init__(pixel_object, speed, colors[0], name=name) - self._generator = self._color_generator() + self.start_color = start_color + super().__init__(pixel_object, speed, colors[start_color], name=name) + self._generator = self._color_generator(start_color) next(self._generator) on_cycle_complete_supported = True @@ -52,17 +54,17 @@ def draw(self): self.pixel_object.fill(self.color) next(self._generator) - def _color_generator(self): - index = 0 + def _color_generator(self, start_color): + index = start_color while True: self._color = self.colors[index] yield index = (index + 1) % len(self.colors) - if index == 0: + if index == start_color: self.cycle_complete = True def reset(self): """ Resets to the first color. """ - self._generator = self._color_generator() + self._generator = self._color_generator(self.start_color) diff --git a/adafruit_led_animation/animation/comet.py b/adafruit_led_animation/animation/comet.py index 7252c98..8f80391 100644 --- a/adafruit_led_animation/animation/comet.py +++ b/adafruit_led_animation/animation/comet.py @@ -37,20 +37,24 @@ class Comet(Animation): :param pixel_object: The initialised LED object. :param float speed: Animation speed in seconds, e.g. ``0.1``. :param color: Animation color in ``(r, g, b)`` tuple, or ``0x000000`` hex format. + :param background_color: Background color in ``(r, g, b)`` tuple, or ``0x000000`` hex format. + Defaults to BLACK. :param int tail_length: The length of the comet. Defaults to 25% of the length of the ``pixel_object``. Automatically compensates for a minimum of 2 and a maximum of the length of the ``pixel_object``. :param bool reverse: Animates the comet in the reverse order. Defaults to ``False``. - :param bool bounce: Comet will bounce back and forth. Defaults to ``True``. + :param bool bounce: Comet will bounce back and forth. Defaults to ``False``. + :param Optional[string] name: A human-readable name for the Animation. + Used by the to string function. :param bool ring: Ring mode. Defaults to ``False``. """ - # pylint: disable=too-many-arguments,too-many-instance-attributes def __init__( self, pixel_object, speed, color, + background_color=BLACK, tail_length=0, reverse=False, bounce=False, @@ -68,6 +72,7 @@ def __init__( self._color_step = 0.95 / tail_length self._comet_colors = None self._computed_color = color + self._background_color = background_color self._num_pixels = len(pixel_object) self._direction = -1 if reverse else 1 self._left_side = -self._tail_length @@ -82,11 +87,9 @@ def __init__( on_cycle_complete_supported = True def _set_color(self, color): - self._comet_colors = [BLACK] + self._comet_colors = [self._background_color] for n in range(self._tail_length): - self._comet_colors.append( - calculate_intensity(color, n * self._color_step + 0.05) - ) + self._comet_colors.append(calculate_intensity(color, n * self._color_step + 0.05)) self._computed_color = color @property @@ -120,14 +123,24 @@ def draw(self): colors = self._comet_colors if self.reverse: colors = reversed(colors) - for pixel_no, color in enumerate(colors): - draw_at = self._tail_start + pixel_no - if draw_at < 0 or draw_at >= self._num_pixels: - if not self._ring: - continue - draw_at = draw_at % self._num_pixels - - self.pixel_object[draw_at] = color + + pixels = self.pixel_object + start = self._tail_start + npixels = len(pixels) + if self._ring: + start %= npixels + for color in colors: + pixels[start] = color + start += 1 + if start == npixels: + start = 0 + else: + for color in colors: + if start >= npixels: + break + if start >= 0: + pixels[start] = color + start += 1 self._tail_start += self._direction diff --git a/adafruit_led_animation/animation/customcolorchase.py b/adafruit_led_animation/animation/customcolorchase.py index 3fd0ee6..d1fc15d 100644 --- a/adafruit_led_animation/animation/customcolorchase.py +++ b/adafruit_led_animation/animation/customcolorchase.py @@ -43,7 +43,6 @@ class CustomColorChase(Chase): :param reverse: Reverse direction of movement. """ - # pylint: disable=too-many-arguments def __init__( self, pixel_object, diff --git a/adafruit_led_animation/animation/grid_rain.py b/adafruit_led_animation/animation/grid_rain.py index c08196d..1b3b64d 100644 --- a/adafruit_led_animation/animation/grid_rain.py +++ b/adafruit_led_animation/animation/grid_rain.py @@ -26,12 +26,13 @@ """ import random + from adafruit_led_animation.animation import Animation -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation.git" -from adafruit_led_animation.color import BLACK, colorwheel, calculate_intensity, GREEN +from adafruit_led_animation.color import BLACK, GREEN, calculate_intensity, colorwheel class Rain(Animation): @@ -46,10 +47,7 @@ class Rain(Animation): :param background: Background color (Default BLACK). """ - # pylint: disable=too-many-arguments - def __init__( - self, grid_object, speed, color, count=1, length=3, background=BLACK, name=None - ): + def __init__(self, grid_object, speed, color, count=1, length=3, background=BLACK, name=None): self._count = count self._length = length self._background = background @@ -57,7 +55,6 @@ def __init__( super().__init__(grid_object, speed, color, name=name) def draw(self): - # Move raindrops down keep = [] for raindrop in self._raindrops: @@ -83,7 +80,7 @@ def draw(self): if y >= 0: self.pixel_object[x, y] = color - def _generate_droplet(self, x, length): # pylint: disable=unused-argument + def _generate_droplet(self, x, length): return [[n, self.color] for n in range(-length, 0)] @@ -92,9 +89,7 @@ class RainbowRain(Rain): Rainbow Rain animation. """ - def __init__( # pylint: disable=too-many-arguments - self, grid_object, speed, count=1, length=3, background=BLACK, name=None - ): + def __init__(self, grid_object, speed, count=1, length=3, background=BLACK, name=None): super().__init__(grid_object, speed, BLACK, count, length, background, name) def _generate_droplet(self, x, length): @@ -110,7 +105,7 @@ class MatrixRain(Rain): The Matrix style animation. """ - def __init__( # pylint: disable=too-many-arguments + def __init__( self, grid_object, speed, diff --git a/adafruit_led_animation/animation/multicolor_comet.py b/adafruit_led_animation/animation/multicolor_comet.py new file mode 100644 index 0000000..784ce52 --- /dev/null +++ b/adafruit_led_animation/animation/multicolor_comet.py @@ -0,0 +1,114 @@ +# SPDX-FileCopyrightText: 2022 Tim Cocks +# +# SPDX-License-Identifier: MIT + +""" +`adafruit_led_animation.animation.multicolor_comet` +================================================================================ + +Multi-color Comet animation for CircuitPython helper library for LED animations. + +* Author(s): Kattni Rembor, Tim Cocks + +Implementation Notes +-------------------- + +**Hardware:** + +* `Adafruit NeoPixels `_ +* `Adafruit DotStars `_ + +**Software and Dependencies:** + +* Adafruit CircuitPython firmware for the supported boards: + https://circuitpython.org/downloads + + +""" + +from adafruit_led_animation.animation.comet import Comet +from adafruit_led_animation.color import BLACK + + +class MulticolorComet(Comet): + """ + A multi-color comet animation. + + :param pixel_object: The initialised LED object. + :param float speed: Animation speed in seconds, e.g. ``0.1``. + :param colors: Animation colors in a list or tuple of entries in + ``(r, g, b)`` tuple, or ``0x000000`` hex format. + :param int tail_length: The length of the comet. Defaults to 25% of the length of the + ``pixel_object``. Automatically compensates for a minimum of 2 and a + maximum of the length of the ``pixel_object``. + :param bool reverse: Animates the comet in the reverse order. Defaults to ``False``. + :param bool bounce: Comet will bounce back and forth. Defaults to ``True``. + :param Optional[string] name: A human-readable name for the Animation. + Used by the to string function. + :param bool ring: Ring mode. Defaults to ``False``. + :param bool off_pixels: Turn pixels off after the animation passes them. Defaults to ``True``. + Setting to False will result in all pixels not currently in the comet + to remain on and set to a color after the comet passes. + """ + + def __init__( + self, + pixel_object, + speed, + colors, + *, + tail_length=0, + reverse=False, + bounce=False, + name=None, + ring=False, + off_pixels=True, + ): + if tail_length == 0: + tail_length = len(pixel_object) // 4 + if bounce and ring: + raise ValueError("Cannot combine bounce and ring mode") + self.bounce = bounce + self._reverse = reverse + self._initial_reverse = reverse + self._tail_length = tail_length + + self._comet_colors = None + + self._num_pixels = len(pixel_object) + self._direction = -1 if reverse else 1 + self._left_side = -self._tail_length + self._right_side = self._num_pixels + self._tail_start = 0 + self._ring = ring + self._colors = colors + if colors is None or len(colors) < 2: + raise ValueError("Must pass at least two colors.") + + self._off_pixels = off_pixels + if ring: + self._left_side = 0 + self.reset() + super().__init__( + pixel_object, + speed, + 0x0, + name=name, + tail_length=tail_length, + bounce=bounce, + ring=ring, + reverse=reverse, + ) + + on_cycle_complete_supported = True + + def _set_color(self, color): + if self._off_pixels: + self._comet_colors = [BLACK] + else: + self._comet_colors = [] + + for n in range(self._tail_length): + _float_index = ((len(self._colors)) / self._tail_length) * n + _color_index = int(_float_index) + self._comet_colors.append(self._colors[_color_index]) diff --git a/adafruit_led_animation/animation/pacman.py b/adafruit_led_animation/animation/pacman.py new file mode 100644 index 0000000..ebf6e1d --- /dev/null +++ b/adafruit_led_animation/animation/pacman.py @@ -0,0 +1,126 @@ +# SPDX-FileCopyrightText: 2025 Bob Loeffler +# SPDX-FileCopyrightText: 2025 Jose D. Montoya +# +# SPDX-License-Identifier: MIT + +""" +`adafruit_led_animation.animation.pacman` +================================================================================ + +PacMan Animation for CircuitPython helper library for LED animations. +PACMAN ANIMATION Adapted from https://github.com/wled-dev/WLED/pull/4536 # by BobLoeffler68 + +* Author(s): Bob Loeffler, Jose D. Montoya + +Implementation Notes +-------------------- + +**Software and Dependencies:** + +* Adafruit CircuitPython firmware for the supported boards: + https://circuitpython.org/downloads + + +""" + +import time + +from adafruit_led_animation.animation import Animation +from adafruit_led_animation.color import ( + BLACK, + BLUE, + CYAN, + ORANGE, + PURPLE, + RED, + WHITE, + YELLOW, +) + +ORANGEYELLOW = (255, 136, 0) + + +class Pacman(Animation): + """ + Simulate the Pacman game in a single led strip. + + :param pixel_object: The initialised LED object. + :param float speed: Animation speed rate in seconds, e.g. ``0.1``. + """ + + def __init__( + self, + pixel_object, + speed, + color=WHITE, + name=None, + ): + self.num_leds = len(pixel_object) + self.pacman = [YELLOW, 10] + self.ghosts_original = [[RED, 6], [PURPLE, 4], [CYAN, 2], [ORANGE, 0]] + self.ghosts = [[RED, 6], [PURPLE, 4], [CYAN, 2], [ORANGE, 0]] + self.direction = 1 + self.black_dir = -1 + self.flag = "beep" + self.power_pellet = [ORANGEYELLOW, self.num_leds] + self.ghost_timer = time.monotonic() + if self.num_leds > 150: + self.start_blinking_ghosts = self.num_leds // 4 + else: + self.start_blinking_ghosts = self.num_leds // 3 + + super().__init__(pixel_object, speed, color, name=name) + + on_cycle_complete_supported = True + + def draw(self): + """ + Draw the Pacman animation. + :param led_object: led object + :param neopixel_list: list of neopixel colors + :param int num_leds: number of leds. + :param int duration: duration in seconds. Default is 15 seconds + """ + pixel_list = self.pixel_object + pixel_list[-1] = self.power_pellet[0] + + delta = time.monotonic() - self.ghost_timer + if delta > 1: + if self.power_pellet[0] == ORANGEYELLOW: + self.power_pellet[0] = BLACK + else: + self.power_pellet[0] = ORANGEYELLOW + pixel_list[self.power_pellet[1] - 1] = self.power_pellet[0] + + self.ghost_timer = time.monotonic() + + if self.pacman[1] >= self.num_leds - 2: + self.direction = self.direction * -1 + self.black_dir = self.black_dir * -1 + for ghost in self.ghosts: + ghost[0] = BLUE + + pixel_list[self.pacman[1]] = self.pacman[0] + pixel_list[self.pacman[1] + self.black_dir] = BLACK + self.pacman[1] += self.direction + + if self.ghosts[3][1] <= self.start_blinking_ghosts and self.direction == -1: + if self.flag == "beep": + for i, ghost in enumerate(self.ghosts): + ghost[0] = BLACK + self.flag = "bop" + else: + for i, ghost in enumerate(self.ghosts): + ghost[0] = self.ghosts_original[i][0] + self.flag = "beep" + + for i, ghost in enumerate(self.ghosts): + pixel_list[ghost[1]] = ghost[0] + pixel_list[ghost[1] + self.black_dir] = BLACK + ghost[1] += self.direction + + if self.ghosts[3][1] <= 0: + self.direction = self.direction * -1 + self.black_dir = self.black_dir * -1 + for i, ghost in enumerate(self.ghosts): + ghost[0] = self.ghosts_original[i][0] diff --git a/adafruit_led_animation/animation/pulse.py b/adafruit_led_animation/animation/pulse.py index fdd4a7c..0f7c7d9 100644 --- a/adafruit_led_animation/animation/pulse.py +++ b/adafruit_led_animation/animation/pulse.py @@ -37,12 +37,27 @@ class Pulse(Animation): :param float speed: Animation refresh rate in seconds, e.g. ``0.1``. :param color: Animation color in ``(r, g, b)`` tuple, or ``0x000000`` hex format. :param period: Period to pulse the LEDs over. Default 5. + :param breath: Duration to hold minimum and maximum intensity levels. Default 0. + :param min_intensity: Lowest brightness level of the pulse. Default 0. + :param max_intensity: Highest brightness level of the pulse. Default 1. """ - # pylint: disable=too-many-arguments - def __init__(self, pixel_object, speed, color, period=5, name=None): + def __init__( + self, + pixel_object, + speed, + color, + period=5, + breath=0, + min_intensity=0, + max_intensity=1, + name=None, + ): super().__init__(pixel_object, speed, color, name=name) self._period = period + self.breath = breath + self.min_intensity = min_intensity + self.max_intensity = max_intensity self._generator = None self.reset() @@ -56,11 +71,21 @@ def reset(self): """ Resets the animation. """ - dotstar = len(self.pixel_object[0]) == 4 and isinstance( - self.pixel_object[0][-1], float - ) - from adafruit_led_animation.helper import ( # pylint: disable=import-outside-toplevel + dotstar = len(self.pixel_object[0]) == 4 and isinstance(self.pixel_object[0][-1], float) + from adafruit_led_animation.pulse_generator import ( pulse_generator, ) self._generator = pulse_generator(self._period, self, dotstar_pwm=dotstar) + + @property + def period(self): + """ + Period to pulse the LEDs over in seconds + """ + return self._period + + @period.setter + def period(self, new_value): + self._period = new_value + self.reset() diff --git a/adafruit_led_animation/animation/rainbow.py b/adafruit_led_animation/animation/rainbow.py index aaa87c0..fdf53a5 100644 --- a/adafruit_led_animation/animation/rainbow.py +++ b/adafruit_led_animation/animation/rainbow.py @@ -25,11 +25,11 @@ """ +from adafruit_led_animation import MS_PER_SECOND, monotonic_ms from adafruit_led_animation.animation import Animation from adafruit_led_animation.color import BLACK, colorwheel -from adafruit_led_animation import MS_PER_SECOND, monotonic_ms -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation.git" @@ -46,10 +46,7 @@ class Rainbow(Animation): (default True). """ - # pylint: disable=too-many-arguments - def __init__( - self, pixel_object, speed, period=5, step=1, name=None, precompute_rainbow=True - ): + def __init__(self, pixel_object, speed, period=5, step=1, name=None, precompute_rainbow=True): super().__init__(pixel_object, speed, BLACK, name=name) self._period = period self._step = step @@ -85,9 +82,9 @@ def _color_wheel_generator(self): if pos < last_pos: cycle_completed = True last_pos = pos - wheel_index = int((pos / period) * len(self.colors)) if self.colors: + wheel_index = int((pos / period) * len(self.colors)) self._draw_precomputed(num_pixels, wheel_index) else: wheel_index = int((pos / period) * 256) @@ -107,13 +104,9 @@ def _draw_precomputed(self, num_pixels, wheel_index): if wheel_index + num > len(self.colors): colors_left = len(self.colors) - wheel_index self.pixel_object[i : i + colors_left] = self.colors[wheel_index:] - self.pixel_object[i + colors_left : i + num] = self.colors[ - : num - colors_left - ] + self.pixel_object[i + colors_left : i + num] = self.colors[: num - colors_left] else: - self.pixel_object[i : i + num] = self.colors[ - wheel_index : wheel_index + num - ] + self.pixel_object[i : i + num] = self.colors[wheel_index : wheel_index + num] def draw(self): next(self._generator) @@ -123,3 +116,15 @@ def reset(self): Resets the animation. """ self._generator = self._color_wheel_generator() + + @property + def period(self) -> float: + """ + Period to cycle the rainbow over in seconds. + """ + return self._period + + @period.setter + def period(self, new_value: float) -> None: + self._period = new_value + self.reset() diff --git a/adafruit_led_animation/animation/rainbowchase.py b/adafruit_led_animation/animation/rainbowchase.py index 3f84828..6c5956d 100644 --- a/adafruit_led_animation/animation/rainbowchase.py +++ b/adafruit_led_animation/animation/rainbowchase.py @@ -26,8 +26,8 @@ """ -from adafruit_led_animation.color import colorwheel from adafruit_led_animation.animation.chase import Chase +from adafruit_led_animation.color import colorwheel class RainbowChase(Chase): @@ -43,7 +43,6 @@ class RainbowChase(Chase): :param step: How many colors to skip in ``colorwheel`` per bar (default 8) """ - # pylint: disable=too-many-arguments def __init__( self, pixel_object, diff --git a/adafruit_led_animation/animation/rainbowcomet.py b/adafruit_led_animation/animation/rainbowcomet.py index 1099307..cc5c5b2 100644 --- a/adafruit_led_animation/animation/rainbowcomet.py +++ b/adafruit_led_animation/animation/rainbowcomet.py @@ -27,7 +27,7 @@ """ from adafruit_led_animation.animation.comet import Comet -from adafruit_led_animation.color import colorwheel, BLACK, calculate_intensity +from adafruit_led_animation.color import BLACK, calculate_intensity, colorwheel class RainbowComet(Comet): @@ -40,13 +40,12 @@ class RainbowComet(Comet): pixels present in the pixel object, e.g. if the strip is 30 pixels long, the ``tail_length`` cannot exceed 30 pixels. :param bool reverse: Animates the comet in the reverse order. Defaults to ``False``. - :param bool bounce: Comet will bounce back and forth. Defaults to ``True``. + :param bool bounce: Comet will bounce back and forth. Defaults to ``False``. :param int colorwheel_offset: Offset from start of colorwheel (0-255). :param int step: Colorwheel step (defaults to automatic). :param bool ring: Ring mode. Defaults to ``False``. """ - # pylint: disable=too-many-arguments def __init__( self, pixel_object, @@ -60,13 +59,11 @@ def __init__( ring=False, ): if step == 0: - self._colorwheel_step = int(256 / tail_length) + self._colorwheel_step = max(256 // tail_length, 1) else: self._colorwheel_step = step self._colorwheel_offset = colorwheel_offset - super().__init__( - pixel_object, speed, 0, tail_length, reverse, bounce, name, ring - ) + super().__init__(pixel_object, speed, 0, 0, tail_length, reverse, bounce, name, ring) def _set_color(self, color): self._comet_colors = [BLACK] @@ -75,8 +72,7 @@ def _set_color(self, color): self._comet_colors.append( calculate_intensity( colorwheel( - int((invert * self._colorwheel_step) + self._colorwheel_offset) - % 256 + int((invert * self._colorwheel_step) + self._colorwheel_offset) % 256 ), n * self._color_step + 0.05, ) diff --git a/adafruit_led_animation/animation/rainbowsparkle.py b/adafruit_led_animation/animation/rainbowsparkle.py index 0be7a71..a87c8f5 100644 --- a/adafruit_led_animation/animation/rainbowsparkle.py +++ b/adafruit_led_animation/animation/rainbowsparkle.py @@ -26,6 +26,7 @@ """ import random + from adafruit_led_animation.animation.rainbow import Rainbow @@ -45,7 +46,6 @@ class RainbowSparkle(Rainbow): (default True). """ - # pylint: disable=too-many-arguments def __init__( self, pixel_object, @@ -91,10 +91,7 @@ def generate_rainbow(self): def after_draw(self): self.show() - pixels = [ - random.randint(0, len(self.pixel_object) - 1) - for n in range(self._num_sparkles) - ] + pixels = [random.randint(0, len(self.pixel_object) - 1) for n in range(self._num_sparkles)] for pixel in pixels: self.pixel_object[pixel] = self._bright_colors[ (self._wheel_index + pixel) % len(self._bright_colors) diff --git a/adafruit_led_animation/animation/sparkle.py b/adafruit_led_animation/animation/sparkle.py index cbe8a80..d067220 100644 --- a/adafruit_led_animation/animation/sparkle.py +++ b/adafruit_led_animation/animation/sparkle.py @@ -26,9 +26,10 @@ """ import random + from adafruit_led_animation.animation import Animation -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation.git" @@ -43,10 +44,7 @@ class Sparkle(Animation): :param mask: array to limit sparkles within range of the mask """ - # pylint: disable=too-many-arguments - def __init__( - self, pixel_object, speed, color, num_sparkles=1, name=None, mask=None - ): + def __init__(self, pixel_object, speed, color, num_sparkles=1, name=None, mask=None): if len(pixel_object) < 2: raise ValueError("Sparkle needs at least 2 pixels") if mask: @@ -66,9 +64,7 @@ def __init__( def _set_color(self, color): half_color = tuple(color[rgb] // 4 for rgb in range(len(color))) dim_color = tuple(color[rgb] // 10 for rgb in range(len(color))) - for pixel in range( # pylint: disable=consider-using-enumerate - len(self.pixel_object) - ): + for pixel in range(len(self.pixel_object)): if self.pixel_object[pixel] == self._half_color: self.pixel_object[pixel] = half_color elif self.pixel_object[pixel] == self._dim_color: diff --git a/adafruit_led_animation/animation/sparklepulse.py b/adafruit_led_animation/animation/sparklepulse.py index efb0d1d..8f915a3 100644 --- a/adafruit_led_animation/animation/sparklepulse.py +++ b/adafruit_led_animation/animation/sparklepulse.py @@ -27,7 +27,7 @@ """ from adafruit_led_animation.animation.sparkle import Sparkle -from adafruit_led_animation.helper import pulse_generator +from adafruit_led_animation.pulse_generator import pulse_generator class SparklePulse(Sparkle): @@ -38,28 +38,28 @@ class SparklePulse(Sparkle): :param int speed: Animation refresh rate in seconds, e.g. ``0.1``. :param color: Animation color in ``(r, g, b)`` tuple, or ``0x000000`` hex format. :param period: Period to pulse the LEDs over. Default 5. + :param breath: Duration to hold minimum and maximum intensity. Default 0. :param max_intensity: The maximum intensity to pulse, between 0 and 1.0. Default 1. :param min_intensity: The minimum intensity to pulse, between 0 and 1.0. Default 0. """ - # pylint: disable=too-many-arguments def __init__( self, pixel_object, speed, color, period=5, + breath=0, max_intensity=1, min_intensity=0, name=None, ): - self._max_intensity = max_intensity - self._min_intensity = min_intensity self._period = period + self.breath = breath + self.min_intensity = min_intensity + self.max_intensity = max_intensity dotstar = len(pixel_object) == 4 and isinstance(pixel_object[0][-1], float) - super().__init__( - pixel_object, speed=speed, color=color, num_sparkles=1, name=name - ) + super().__init__(pixel_object, speed=speed, color=color, num_sparkles=1, name=name) self._generator = pulse_generator(self._period, self, dotstar_pwm=dotstar) def _set_color(self, color): @@ -71,3 +71,19 @@ def draw(self): def after_draw(self): self.show() + + @property + def period(self): + """ + Period to pulse the LEDs over in seconds + """ + return self._period + + @period.setter + def period(self, new_value): + self._period = new_value + self.reset() + + def reset(self): + dotstar = len(self.pixel_object) == 4 and isinstance(self.pixel_object[0][-1], float) + self._generator = pulse_generator(self._period, self, dotstar_pwm=dotstar) diff --git a/adafruit_led_animation/animation/volume.py b/adafruit_led_animation/animation/volume.py new file mode 100644 index 0000000..e4b8ded --- /dev/null +++ b/adafruit_led_animation/animation/volume.py @@ -0,0 +1,111 @@ +# SPDX-FileCopyrightText: 2020 Gamblor21 +# +# SPDX-License-Identifier: MIT +""" +`adafruit_led_animation.animation.volume` +================================================================================ +Volume animation for CircuitPython helper library for LED animations. +* Author(s): Mark Komus +Implementation Notes +-------------------- +**Hardware:** +* `Adafruit NeoPixels `_ +* `Adafruit DotStars `_ +**Software and Dependencies:** +* Adafruit CircuitPython firmware for the supported boards: + https://circuitpython.org/downloads +""" + +from adafruit_led_animation.animation import Animation + + +def map_range(x, in_min, in_max, out_min, out_max): + """ + Maps a number from one range to another. + :return: Returns value mapped to new range + :rtype: float + """ + mapped = (x - in_min) * (out_max - out_min) / (in_max - in_min) + out_min + if out_min <= out_max: + return max(min(mapped, out_max), out_min) + + return min(max(mapped, out_max), out_min) + + +class Volume(Animation): + """ + Animate the brightness and number of pixels based on volume. + :param pixel_object: The initialised LED object. + :param float speed: Animation update speed in seconds, e.g. ``0.1``. + :param brightest_color: Color at max volume ``(r, g, b)`` tuple, or ``0x000000`` hex format + :param decoder: a MP3Decoder object that the volume will be taken from + :param float max_volume: what volume is considered maximum where everything is lit up + """ + + def __init__( + self, + pixel_object, + speed, + brightest_color, + decoder, + max_volume=500, + name=None, + ): + self._decoder = decoder + self._num_pixels = len(pixel_object) + self._max_volume = max_volume + self._brightest_color = brightest_color + super().__init__(pixel_object, speed, brightest_color, name=name) + + def set_brightest_color(self, brightest_color): + """ + Animate the brightness and number of pixels based on volume. + :param brightest_color: Color at max volume ``(r, g, b)`` tuple, or ``0x000000`` hex format + """ + self._brightest_color = brightest_color + + def draw(self): + red = int( + map_range( + self._decoder.rms_level, + 0, + self._max_volume, + 0, + self._brightest_color[0], + ) + ) + green = int( + map_range( + self._decoder.rms_level, + 0, + self._max_volume, + 0, + self._brightest_color[1], + ) + ) + blue = int( + map_range( + self._decoder.rms_level, + 0, + self._max_volume, + 0, + self._brightest_color[2], + ) + ) + + lit_pixels = int( + map_range( + self._decoder.rms_level, + 0, + self._max_volume, + 0, + self._num_pixels, + ) + ) + if lit_pixels > self._num_pixels: + lit_pixels = self._num_pixels + + self.pixel_object[0:lit_pixels] = [(red, green, blue)] * lit_pixels + self.pixel_object[lit_pixels : self._num_pixels] = [(0, 0, 0)] * ( + self._num_pixels - lit_pixels + ) diff --git a/adafruit_led_animation/color.py b/adafruit_led_animation/color.py index 9f8b17a..25aa950 100644 --- a/adafruit_led_animation/color.py +++ b/adafruit_led_animation/color.py @@ -23,8 +23,9 @@ * Adafruit CircuitPython firmware for the supported boards: https://circuitpython.org/downloads """ + # Makes colorwheel() available. -from rainbowio import colorwheel # pylint: disable=unused-import +from rainbowio import colorwheel RED = (255, 0, 0) """Red.""" diff --git a/adafruit_led_animation/grid.py b/adafruit_led_animation/grid.py index b15254c..736ebe9 100644 --- a/adafruit_led_animation/grid.py +++ b/adafruit_led_animation/grid.py @@ -24,11 +24,11 @@ https://circuitpython.org/downloads """ + from micropython import const from .helper import PixelMap, horizontal_strip_gridmap, vertical_strip_gridmap - HORIZONTAL = const(1) VERTICAL = const(2) @@ -79,7 +79,7 @@ def __init__( reverse_y=False, top=0, bottom=0, - ): # pylint: disable=too-many-arguments,too-many-locals + ): self._pixels = strip self._x = [] self.height = height @@ -154,7 +154,6 @@ def brightness(self): @brightness.setter def brightness(self, brightness): - # pylint: disable=attribute-defined-outside-init self._pixels.brightness = min(max(brightness, 0.0), 1.0) def fill(self, color): diff --git a/adafruit_led_animation/group.py b/adafruit_led_animation/group.py index ba1111f..fe4cd7f 100644 --- a/adafruit_led_animation/group.py +++ b/adafruit_led_animation/group.py @@ -26,7 +26,7 @@ """ -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation.git" from adafruit_led_animation.animation import Animation @@ -107,9 +107,9 @@ def __init__(self, *members, sync=False, name=None): self.on_cycle_complete_supported = self._members[-1].on_cycle_complete_supported def __str__(self): - return "" % (self.__class__.__name__, self.name) + return f"" - def _group_done(self, animation): # pylint: disable=unused-argument + def _group_done(self, animation): self.on_cycle_complete() def on_cycle_complete(self): @@ -152,7 +152,11 @@ def animate(self, show=True): member.show() return result - return any(item.animate(show) for item in self._members) + ret = False + for item in self._members: + if item.animate(show): + ret = True + return ret @property def color(self): diff --git a/adafruit_led_animation/helper.py b/adafruit_led_animation/helper.py index 126ea74..e24609f 100644 --- a/adafruit_led_animation/helper.py +++ b/adafruit_led_animation/helper.py @@ -27,9 +27,6 @@ import math -from . import MS_PER_SECOND, monotonic_ms -from .color import calculate_intensity - class PixelMap: """ @@ -168,7 +165,6 @@ def brightness(self): @brightness.setter def brightness(self, brightness): - # pylint: disable=attribute-defined-outside-init self._pixels.brightness = min(max(brightness, 0.0), 1.0) def fill(self, color): @@ -313,39 +309,3 @@ def __init__(self, pixel_object, start, end): pixel_ranges=[[n] for n in range(start, end)], individual_pixels=True, ) - - -def pulse_generator(period: float, animation_object, dotstar_pwm=False): - """ - Generates a sequence of colors for a pulse, based on the time period specified. - :param period: Pulse duration in seconds. - :param animation_object: An animation object to interact with. - :param dotstar_pwm: Whether to use the dostar per pixel PWM value for brightness control. - """ - period = int(period * MS_PER_SECOND) - half_period = period // 2 - - last_update = monotonic_ms() - cycle_position = 0 - last_pos = 0 - while True: - now = monotonic_ms() - time_since_last_draw = now - last_update - last_update = now - pos = cycle_position = (cycle_position + time_since_last_draw) % period - if pos < last_pos: - animation_object.cycle_complete = True - last_pos = pos - if pos > half_period: - pos = period - pos - intensity = pos / half_period - if dotstar_pwm: - fill_color = ( - animation_object.color[0], - animation_object.color[1], - animation_object.color[2], - intensity, - ) - yield fill_color - continue - yield calculate_intensity(animation_object.color, intensity) diff --git a/adafruit_led_animation/pulse_generator.py b/adafruit_led_animation/pulse_generator.py new file mode 100644 index 0000000..e29b04f --- /dev/null +++ b/adafruit_led_animation/pulse_generator.py @@ -0,0 +1,74 @@ +# SPDX-FileCopyrightText: 2019 Kattni Rembor for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +""" +`adafruit_led_animation.pulse_generator` +================================================================================ + +Helper method for pulse generation + +* Author(s): Kattni Rembor + +Implementation Notes +-------------------- + +**Hardware:** + +* `Adafruit NeoPixels `_ +* `Adafruit DotStars `_ + +**Software and Dependencies:** + +* Adafruit CircuitPython firmware for the supported boards: + https://circuitpython.org/downloads + +""" + +from . import MS_PER_SECOND, monotonic_ms +from .color import calculate_intensity + + +def pulse_generator(period: float, animation_object, dotstar_pwm=False): + """ + Generates a sequence of colors for a pulse, based on the time period specified. + :param period: Pulse duration in seconds. + :param animation_object: An animation object to interact with. + :param dotstar_pwm: Whether to use the dostar per pixel PWM value for brightness control. + """ + period = int((period + (animation_object.breath * 2)) * MS_PER_SECOND) + half_breath = int(animation_object.breath * MS_PER_SECOND // 2) + half_period = period // 2 + + last_update = monotonic_ms() + cycle_position = 0 + last_pos = 0 + while True: + now = monotonic_ms() + time_since_last_draw = now - last_update + last_update = now + pos = cycle_position = (cycle_position + time_since_last_draw) % period + if pos < last_pos: + animation_object.cycle_complete = True + last_pos = pos + if pos > half_period: + pos = period - pos + if pos < half_breath: + intensity = animation_object.min_intensity + elif pos > (half_period - half_breath): + intensity = animation_object.max_intensity + else: + intensity = animation_object.min_intensity + ( + ((pos - half_breath) / (half_period - (half_breath * 2))) + * (animation_object.max_intensity - animation_object.min_intensity) + ) + if dotstar_pwm: + fill_color = ( + animation_object.color[0], + animation_object.color[1], + animation_object.color[2], + intensity, + ) + yield fill_color + continue + yield calculate_intensity(animation_object.color, intensity) diff --git a/adafruit_led_animation/sequence.py b/adafruit_led_animation/sequence.py index 1765bf2..6d35e07 100644 --- a/adafruit_led_animation/sequence.py +++ b/adafruit_led_animation/sequence.py @@ -27,10 +27,12 @@ """ import random + from adafruit_led_animation.color import BLACK + from . import MS_PER_SECOND, monotonic_ms -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation.git" @@ -73,7 +75,6 @@ class AnimationSequence: animations.animate() """ - # pylint: disable=too-many-instance-attributes def __init__( self, *members, @@ -82,16 +83,12 @@ def __init__( random_order=False, auto_reset=False, advance_on_cycle_complete=False, - name=None + name=None, ): if advance_interval and advance_on_cycle_complete: - raise ValueError( - "Cannot use both advance_interval and advance_on_cycle_complete." - ) + raise ValueError("Cannot use both advance_interval and advance_on_cycle_complete.") self._members = members - self._advance_interval = ( - advance_interval * MS_PER_SECOND if advance_interval else None - ) + self._advance_interval = advance_interval * MS_PER_SECOND if advance_interval else None self._last_advance = monotonic_ms() self._current = 0 self.auto_clear = auto_clear @@ -115,7 +112,7 @@ def __init__( on_cycle_complete_supported = True def __str__(self): - return "<%s: %s>" % (self.__class__.__name__, self.name) + return f"<{self.__class__.__name__}: {self.name}>" def on_cycle_complete(self): """ @@ -128,7 +125,7 @@ def on_cycle_complete(self): for callback in self._also_notify: callback(self) - def _sequence_complete(self, animation): # pylint: disable=unused-argument + def _sequence_complete(self, animation): if self.advance_on_cycle_complete: self._advance() @@ -179,6 +176,13 @@ def next(self): self.on_cycle_complete() self.activate(current % len(self._members)) + def previous(self): + """ + Jump to the previous animation. + """ + current = self._current - 1 + self.activate(current % len(self._members)) + def random(self): """ Jump to a random animation. diff --git a/adafruit_led_animation/timedsequence.py b/adafruit_led_animation/timedsequence.py new file mode 100644 index 0000000..19feaa4 --- /dev/null +++ b/adafruit_led_animation/timedsequence.py @@ -0,0 +1,82 @@ +# SPDX-FileCopyrightText: 2020 Gamblor21 +# +# SPDX-License-Identifier: MIT +""" +`adafruit_led_animation.timedsequence` +================================================================================ + +Animation timed sequence helper for CircuitPython helper library for LED animations. + + +* Author(s): Mark Komus + +Implementation Notes +-------------------- + +**Hardware:** + +* `Adafruit NeoPixels `_ +* `Adafruit DotStars `_ + +**Software and Dependencies:** + +* Adafruit CircuitPython firmware for the supported boards: + https://circuitpython.org/downloads + +""" + +from adafruit_led_animation.sequence import AnimationSequence + +from . import MS_PER_SECOND + + +class TimedAnimationSequence(AnimationSequence): + """ + A sequence of Animations to run in succession, each animation running for an + individual amount of time. + :param members: The animation objects or groups followed by how long the animation + should run in seconds. + :param bool auto_clear: Clear the pixels between animations. If ``True``, the current animation + will be cleared from the pixels before the next one starts. + Defaults to ``False``. + :param bool random_order: Activate the animations in a random order. Defaults to ``False``. + :param bool auto_reset: Automatically call reset() on animations when changing animations. + .. code-block:: python + import board + import neopixel + from adafruit_led_animation.timedsequence import TimedAnimationSequence + import adafruit_led_animation.animation.comet as comet_animation + import adafruit_led_animation.animation.sparkle as sparkle_animation + import adafruit_led_animation.animation.blink as blink_animation + import adafruit_led_animation.color as color + strip_pixels = neopixel.NeoPixel(board.A1, 30, brightness=1, auto_write=False) + blink = blink_animation.Blink(strip_pixels, 0.2, color.RED) + comet = comet_animation.Comet(strip_pixels, 0.1, color.BLUE) + sparkle = sparkle_animation.Sparkle(strip_pixels, 0.05, color.GREEN) + animations = TimedAnimationSequence(blink, 5, comet, 3, sparkle, 7) + while True: + animations.animate() + """ + + def __init__(self, *members, auto_clear=True, random_order=False, auto_reset=False, name=None): + self._animation_members = [] + self._animation_timings = [] + for x, item in enumerate(members): + if not x % 2: + self._animation_members.append(item) + else: + self._animation_timings.append(item) + + super().__init__( + *self._animation_members, + auto_clear=auto_clear, + random_order=random_order, + auto_reset=auto_reset, + advance_on_cycle_complete=False, + name=name, + ) + self._advance_interval = self._animation_timings[self._current] * MS_PER_SECOND + + def activate(self, index): + super().activate(index) + self._advance_interval = self._animation_timings[self._current] * MS_PER_SECOND diff --git a/docs/api.rst b/docs/api.rst index b4aa897..875d317 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,6 +4,9 @@ .. 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_led_animation.animation :members: diff --git a/docs/conf.py b/docs/conf.py index ded1695..e330ab0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,9 +1,8 @@ -# -*- coding: utf-8 -*- - # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries # # SPDX-License-Identifier: MIT +import datetime import os import sys @@ -16,6 +15,7 @@ # ones. extensions = [ "sphinx.ext.autodoc", + "sphinxcontrib.jquery", "sphinx.ext.intersphinx", "sphinx.ext.napoleon", "sphinx.ext.todo", @@ -29,8 +29,8 @@ intersphinx_mapping = { - "python": ("https://docs.python.org/3.4", None), - "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None), + "python": ("https://docs.python.org/3", None), + "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None), } # Add any paths that contain templates here, relative to this directory. @@ -43,7 +43,12 @@ # General information about the project. project = "LED_Animation Library" -copyright = "2020 Kattni Rembor" +creation_year = "2020" +current_year = str(datetime.datetime.now().year) +year_duration = ( + current_year if current_year == creation_year else creation_year + " - " + current_year +) +copyright = year_duration + " Kattni Rembor" author = "Kattni Rembor" # The version info for the project you're documenting, acts as replacement for @@ -60,7 +65,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -92,19 +97,9 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -on_rtd = os.environ.get("READTHEDOCS", None) == "True" - -if not on_rtd: # only import and set the theme if we're building docs locally - try: - import sphinx_rtd_theme - - html_theme = "sphinx_rtd_theme" - html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] - except: - html_theme = "default" - html_theme_path = ["."] -else: - html_theme_path = ["."] +import sphinx_rtd_theme + +html_theme = "sphinx_rtd_theme" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/docs/examples.rst b/docs/examples.rst index f45d96d..7bb45dd 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -61,6 +61,14 @@ Demonstrates the blink animation. :caption: examples/led_animation_blink.py :linenos: +Blink with a selcted background color +---------------------------------------- +Demonstrates the blink animation with an user defined background color. + +.. literalinclude:: ../examples/led_animation_blink_with_background.py + :caption: examples/led_animation_blink_with_background.py + :linenos: + Comet ----- @@ -96,3 +104,12 @@ Demonstrates the sparkle animations. .. literalinclude:: ../examples/led_animation_sparkle_animations.py :caption: examples/led_animation_sparkle_animations.py :linenos: + +Pacman +------ + +Demonstrates the pacman animation. + +.. literalinclude:: ../examples/led_animation_pacman.py + :caption: examples/led_animation_pacman.py + :linenos: diff --git a/docs/index.rst b/docs/index.rst index 23d7f74..5012312 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -36,8 +36,9 @@ Table of Contents .. toctree:: :caption: Other Links - Download - CircuitPython Reference Documentation + Download from GitHub + Download Library Bundle + CircuitPython Reference Documentation CircuitPython Support Forum Discord Chat Adafruit Learning System diff --git a/docs/requirements.txt b/docs/requirements.txt index 88e6733..979f568 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,4 +2,6 @@ # # SPDX-License-Identifier: Unlicense -sphinx>=4.0.0 +sphinx +sphinxcontrib-jquery +sphinx-rtd-theme diff --git a/examples/led_animation_all_animations.py b/examples/led_animation_all_animations.py index fdb9824..b6e4560 100644 --- a/examples/led_animation_all_animations.py +++ b/examples/led_animation_all_animations.py @@ -9,24 +9,25 @@ This example does not work on SAMD21 (M0) boards. """ + import board import neopixel from adafruit_led_animation.animation.blink import Blink -from adafruit_led_animation.animation.sparklepulse import SparklePulse -from adafruit_led_animation.animation.comet import Comet from adafruit_led_animation.animation.chase import Chase +from adafruit_led_animation.animation.colorcycle import ColorCycle +from adafruit_led_animation.animation.comet import Comet +from adafruit_led_animation.animation.customcolorchase import CustomColorChase from adafruit_led_animation.animation.pulse import Pulse -from adafruit_led_animation.animation.sparkle import Sparkle +from adafruit_led_animation.animation.rainbow import Rainbow from adafruit_led_animation.animation.rainbowchase import RainbowChase -from adafruit_led_animation.animation.rainbowsparkle import RainbowSparkle from adafruit_led_animation.animation.rainbowcomet import RainbowComet +from adafruit_led_animation.animation.rainbowsparkle import RainbowSparkle from adafruit_led_animation.animation.solid import Solid -from adafruit_led_animation.animation.colorcycle import ColorCycle -from adafruit_led_animation.animation.rainbow import Rainbow -from adafruit_led_animation.animation.customcolorchase import CustomColorChase +from adafruit_led_animation.animation.sparkle import Sparkle +from adafruit_led_animation.animation.sparklepulse import SparklePulse +from adafruit_led_animation.color import AMBER, JADE, MAGENTA, ORANGE, PURPLE, WHITE from adafruit_led_animation.sequence import AnimationSequence -from adafruit_led_animation.color import PURPLE, WHITE, AMBER, JADE, MAGENTA, ORANGE # Update to match the pin connected to your NeoPixels pixel_pin = board.D6 diff --git a/examples/led_animation_basic_animations.py b/examples/led_animation_basic_animations.py index cfacf25..d86c23d 100644 --- a/examples/led_animation_basic_animations.py +++ b/examples/led_animation_basic_animations.py @@ -9,26 +9,27 @@ This example may not work on SAMD21 (M0) boards. """ + import board import neopixel -from adafruit_led_animation.animation.solid import Solid -from adafruit_led_animation.animation.colorcycle import ColorCycle from adafruit_led_animation.animation.blink import Blink -from adafruit_led_animation.animation.comet import Comet from adafruit_led_animation.animation.chase import Chase +from adafruit_led_animation.animation.colorcycle import ColorCycle +from adafruit_led_animation.animation.comet import Comet from adafruit_led_animation.animation.pulse import Pulse -from adafruit_led_animation.sequence import AnimationSequence +from adafruit_led_animation.animation.solid import Solid from adafruit_led_animation.color import ( - PURPLE, - WHITE, AMBER, JADE, - TEAL, - PINK, MAGENTA, ORANGE, + PINK, + PURPLE, + TEAL, + WHITE, ) +from adafruit_led_animation.sequence import AnimationSequence # Update to match the pin connected to your NeoPixels pixel_pin = board.D6 diff --git a/examples/led_animation_blink.py b/examples/led_animation_blink.py index bc7033f..3419100 100755 --- a/examples/led_animation_blink.py +++ b/examples/led_animation_blink.py @@ -10,6 +10,7 @@ This example will run on SAMD21 (M0) Express boards (such as Circuit Playground Express or QT Py Haxpress), but not on SAMD21 non-Express boards (such as QT Py or Trinket). """ + import board import neopixel diff --git a/examples/led_animation_blink_with_background.py b/examples/led_animation_blink_with_background.py new file mode 100644 index 0000000..6483c28 --- /dev/null +++ b/examples/led_animation_blink_with_background.py @@ -0,0 +1,30 @@ +# SPDX-FileCopyrightText: 2025 Jose D. Montoya +# SPDX-License-Identifier: MIT + +""" +This example blinks the LEDs purple with a yellow background at a 0.5 second interval. + +For QT Py Haxpress and a NeoPixel strip. Update pixel_pin and pixel_num to match your wiring if +using a different board or form of NeoPixels. + +This example will run on SAMD21 (M0) Express boards (such as Circuit Playground Express or QT Py +Haxpress), but not on SAMD21 non-Express boards (such as QT Py or Trinket). +""" + +import board +import neopixel + +from adafruit_led_animation.animation.blink import Blink +from adafruit_led_animation.color import PURPLE, YELLOW + +# Update to match the pin connected to your NeoPixels +pixel_pin = board.A3 +# Update to match the number of NeoPixels you have connected +pixel_num = 30 + +pixels = neopixel.NeoPixel(pixel_pin, pixel_num, brightness=0.5, auto_write=False) + +blink = Blink(pixels, speed=0.5, color=PURPLE, background_color=YELLOW) + +while True: + blink.animate() diff --git a/examples/led_animation_chase.py b/examples/led_animation_chase.py index ec38234..c859ccf 100755 --- a/examples/led_animation_chase.py +++ b/examples/led_animation_chase.py @@ -11,6 +11,7 @@ This example will run on SAMD21 (M0) Express boards (such as Circuit Playground Express or QT Py Haxpress), but not on SAMD21 non-Express boards (such as QT Py or Trinket). """ + import board import neopixel diff --git a/examples/led_animation_comet.py b/examples/led_animation_comet.py index 5c4c0d1..167aa7e 100755 --- a/examples/led_animation_comet.py +++ b/examples/led_animation_comet.py @@ -10,6 +10,7 @@ This example will run on SAMD21 (M0) Express boards (such as Circuit Playground Express or QT Py Haxpress), but not on SAMD21 non-Express boards (such as QT Py or Trinket). """ + import board import neopixel diff --git a/examples/led_animation_customcolorchase.py b/examples/led_animation_customcolorchase.py index 9e0397e..1bfa674 100644 --- a/examples/led_animation_customcolorchase.py +++ b/examples/led_animation_customcolorchase.py @@ -9,17 +9,16 @@ This example may not work on SAMD21 (M0) boards. """ + import board import neopixel from adafruit_led_animation.animation.customcolorchase import CustomColorChase -from adafruit_led_animation.sequence import AnimationSequence # colorwheel only needed for rainbowchase example -from adafruit_led_animation.color import colorwheel - # Colors for customcolorchase examples -from adafruit_led_animation.color import PINK, GREEN, RED, BLUE +from adafruit_led_animation.color import BLUE, GREEN, PINK, RED, colorwheel +from adafruit_led_animation.sequence import AnimationSequence # Update to match the pin connected to your NeoPixels pixel_pin = board.D5 @@ -27,15 +26,11 @@ pixel_num = 30 brightness = 0.3 -pixels = neopixel.NeoPixel( - pixel_pin, pixel_num, brightness=brightness, auto_write=False -) +pixels = neopixel.NeoPixel(pixel_pin, pixel_num, brightness=brightness, auto_write=False) # colors default to RAINBOW as defined in color.py custom_color_chase_rainbow = CustomColorChase(pixels, speed=0.1, size=2, spacing=3) -custom_color_chase_rainbow_r = CustomColorChase( - pixels, speed=0.1, size=3, spacing=3, reverse=True -) +custom_color_chase_rainbow_r = CustomColorChase(pixels, speed=0.1, size=3, spacing=3, reverse=True) # Example with same colors as RainbowChase steps = 30 diff --git a/examples/led_animation_cycle_animations.py b/examples/led_animation_cycle_animations.py new file mode 100644 index 0000000..7dc98f8 --- /dev/null +++ b/examples/led_animation_cycle_animations.py @@ -0,0 +1,46 @@ +# SPDX-FileCopyrightText: 2021 Alec Delaney +# SPDX-License-Identifier: MIT + +""" +This example uses AnimationsSequence along with a connected push button to cycle through +two animations + +For NeoPixel FeatherWing. Update pixel_pin and pixel_num to match your wiring if using +a different form of NeoPixels. +""" + +import time + +import board +import neopixel +from digitalio import DigitalInOut, Direction, Pull + +from adafruit_led_animation.animation.solid import Solid +from adafruit_led_animation.color import BLUE, RED +from adafruit_led_animation.sequence import AnimationSequence + +# Update to match the pin connected to your NeoPixels +pixel_pin = board.D6 +# Update to match the number of NeoPixels you have connected +pixel_num = 32 + +# Update to matchpin connected to button that connect logic high when pushed +button_pin = board.D3 + +pixels = neopixel.NeoPixel(pixel_pin, pixel_num, brightness=0.5, auto_write=False) +button = DigitalInOut(button_pin) +button.direction = Direction.INPUT +button.pull = Pull.UP + +solid_blue = Solid(pixels, color=BLUE) +solid_red = Solid(pixels, color=RED) +animation_sequence = AnimationSequence(solid_blue, solid_red, auto_clear=True) + +while True: + animation_sequence.animate() + + # Pressing the button pauses the animation permanently + if not button.value: + animation_sequence.next() + while button.value: + time.sleep(0.1) # Used for button debouncing diff --git a/examples/led_animation_freeze_animation.py b/examples/led_animation_freeze_animation.py new file mode 100644 index 0000000..531f55f --- /dev/null +++ b/examples/led_animation_freeze_animation.py @@ -0,0 +1,39 @@ +# SPDX-FileCopyrightText: 2021 Alec Delaney +# SPDX-License-Identifier: MIT + +""" +This example uses Pulse animation along with a connected push button to freeze +the animation permanently when pressed + +For NeoPixel FeatherWing. Update pixel_pin and pixel_num to match your wiring if using +a different form of NeoPixels. +""" + +import board +import neopixel +from digitalio import DigitalInOut, Direction, Pull + +from adafruit_led_animation.animation.pulse import Pulse +from adafruit_led_animation.color import RED + +# Update to match the pin connected to your NeoPixels +pixel_pin = board.D6 +# Update to match the number of NeoPixels you have connected +pixel_num = 32 + +# Update to matchpin connected to button that connect logic high when pushed +button_pin = board.D3 + +pixels = neopixel.NeoPixel(pixel_pin, pixel_num, brightness=0.5, auto_write=False) +button = DigitalInOut(button_pin) +button.direction = Direction.INPUT +button.pull = Pull.UP + +pulse_animation = Pulse(pixels, speed=0.1, period=1, color=RED) + +while True: + pulse_animation.animate() + + # Pressing the button pauses the animation permanently + if not button.value: + pulse_animation.freeze() diff --git a/examples/led_animation_group.py b/examples/led_animation_group.py index c9a4b5a..beb70ab 100644 --- a/examples/led_animation_group.py +++ b/examples/led_animation_group.py @@ -10,19 +10,18 @@ This example is written for Circuit Playground Bluefruit and a 30-pixel NeoPixel strip connected to pad A1. It does not work on Circuit Playground Express. """ + import board import neopixel from adafruit_circuitplayground import cp +from adafruit_led_animation import color from adafruit_led_animation.animation.blink import Blink -from adafruit_led_animation.animation.comet import Comet from adafruit_led_animation.animation.chase import Chase - +from adafruit_led_animation.animation.comet import Comet from adafruit_led_animation.group import AnimationGroup from adafruit_led_animation.sequence import AnimationSequence -from adafruit_led_animation import color - strip_pixels = neopixel.NeoPixel(board.A1, 30, brightness=0.5, auto_write=False) cp.pixels.brightness = 0.5 diff --git a/examples/led_animation_multicolor_comet.py b/examples/led_animation_multicolor_comet.py new file mode 100644 index 0000000..8354e9c --- /dev/null +++ b/examples/led_animation_multicolor_comet.py @@ -0,0 +1,65 @@ +# SPDX-FileCopyrightText: 2022 Tim Cocks +# +# SPDX-License-Identifier: MIT +""" +This example animates a red, yellow, and green gradient comet that bounces +from end to end of the strip. + +For QT Py Haxpress and a NeoPixel strip. Update pixel_pin and pixel_num to match your wiring if +using a different board or form of NeoPixels. + +This example will run on SAMD21 (M0) Express boards (such as Circuit Playground Express or QT Py +Haxpress), but not on SAMD21 non-Express boards (such as QT Py or Trinket). +""" + +import board +import neopixel + +from adafruit_led_animation.animation.multicolor_comet import MulticolorComet + +# Update to match the pin connected to your NeoPixels +pixel_pin = board.D9 +# Update to match the number of NeoPixels you have connected +pixel_num = 96 +brightness = 0.02 + +pixels = neopixel.NeoPixel( + pixel_pin, + pixel_num, + brightness=brightness, + auto_write=True, + pixel_order=neopixel.RGB, +) + +comet_colors = [ + 0xFF0000, + 0xFD2000, + 0xF93E00, + 0xF45B00, + 0xEC7500, + 0xE28D00, + 0xD5A200, + 0xC6B500, + 0xB5C600, + 0xA2D500, + 0x8DE200, + 0x75EC00, + 0x5BF400, + 0x3EF900, + 0x20FD00, + 0x00FF00, +] + + +comet = MulticolorComet( + pixels, + colors=comet_colors, + speed=0.01, + tail_length=20, + bounce=True, + ring=False, + reverse=False, +) + +while True: + comet.animate() diff --git a/examples/led_animation_pacman.py b/examples/led_animation_pacman.py new file mode 100644 index 0000000..797b134 --- /dev/null +++ b/examples/led_animation_pacman.py @@ -0,0 +1,34 @@ +# SPDX-FileCopyrightText: 2025 Jose D. Montoya +# SPDX-License-Identifier: MIT + +""" +This example animates a Pacman on a NeoPixel strip. +""" + +import board +import neopixel + +from adafruit_led_animation.animation.pacman import Pacman +from adafruit_led_animation.color import WHITE + +# Update to match the pin connected to your NeoPixels +pixel_pin = board.D6 +# Update to match the number of NeoPixels you have connected +num_pixels = 50 + +# Create the NeoPixel object +ORDER = neopixel.GRB +pixels = neopixel.NeoPixel( + pixel_pin, + num_pixels, + brightness=0.5, + auto_write=False, + pixel_order=ORDER, +) + +# Create the Pacman animation object +pacman = Pacman(pixels, speed=0.1, color=WHITE) + +# Main loop +while True: + pacman.animate() diff --git a/examples/led_animation_pixel_map.py b/examples/led_animation_pixel_map.py index 692b11e..e7b6332 100644 --- a/examples/led_animation_pixel_map.py +++ b/examples/led_animation_pixel_map.py @@ -11,17 +11,18 @@ This example does not work on SAMD21 (M0) boards. """ + import board import neopixel -from adafruit_led_animation.animation.comet import Comet -from adafruit_led_animation.animation.rainbowcomet import RainbowComet -from adafruit_led_animation.animation.rainbowchase import RainbowChase +from adafruit_led_animation import helper from adafruit_led_animation.animation.chase import Chase +from adafruit_led_animation.animation.comet import Comet from adafruit_led_animation.animation.rainbow import Rainbow +from adafruit_led_animation.animation.rainbowchase import RainbowChase +from adafruit_led_animation.animation.rainbowcomet import RainbowComet +from adafruit_led_animation.color import AMBER, JADE, PURPLE from adafruit_led_animation.sequence import AnimationSequence -from adafruit_led_animation import helper -from adafruit_led_animation.color import PURPLE, JADE, AMBER # Update to match the pin connected to your NeoPixels pixel_pin = board.D6 @@ -37,17 +38,11 @@ pixels, 8, 4, helper.horizontal_strip_gridmap(8, alternating=False) ) -comet_h = Comet( - pixel_wing_horizontal, speed=0.1, color=PURPLE, tail_length=3, bounce=True -) +comet_h = Comet(pixel_wing_horizontal, speed=0.1, color=PURPLE, tail_length=3, bounce=True) comet_v = Comet(pixel_wing_vertical, speed=0.1, color=AMBER, tail_length=6, bounce=True) chase_h = Chase(pixel_wing_horizontal, speed=0.1, size=3, spacing=6, color=JADE) -rainbow_chase_v = RainbowChase( - pixel_wing_vertical, speed=0.1, size=3, spacing=2, step=8 -) -rainbow_comet_v = RainbowComet( - pixel_wing_vertical, speed=0.1, tail_length=7, bounce=True -) +rainbow_chase_v = RainbowChase(pixel_wing_vertical, speed=0.1, size=3, spacing=2, step=8) +rainbow_comet_v = RainbowComet(pixel_wing_vertical, speed=0.1, tail_length=7, bounce=True) rainbow_v = Rainbow(pixel_wing_vertical, speed=0.1, period=2) rainbow_chase_h = RainbowChase(pixel_wing_horizontal, speed=0.1, size=3, spacing=3) diff --git a/examples/led_animation_rainbow_animations.py b/examples/led_animation_rainbow_animations.py index c4c36b4..77facb0 100644 --- a/examples/led_animation_rainbow_animations.py +++ b/examples/led_animation_rainbow_animations.py @@ -10,6 +10,7 @@ This example does not work on SAMD21 (M0) boards. """ + import board import neopixel diff --git a/examples/led_animation_resume_animation.py b/examples/led_animation_resume_animation.py new file mode 100644 index 0000000..637dbb7 --- /dev/null +++ b/examples/led_animation_resume_animation.py @@ -0,0 +1,41 @@ +# SPDX-FileCopyrightText: 2021 Alec Delaney +# SPDX-License-Identifier: MIT + +""" +This example uses Pulse animation along with a connected push button to start +the animation when pressed + +For NeoPixel FeatherWing. Update pixel_pin and pixel_num to match your wiring if using +a different form of NeoPixels. +""" + +import board +import neopixel +from digitalio import DigitalInOut, Direction, Pull + +from adafruit_led_animation.animation.pulse import Pulse +from adafruit_led_animation.color import RED + +# Update to match the pin connected to your NeoPixels +pixel_pin = board.D6 +# Update to match the number of NeoPixels you have connected +pixel_num = 32 + +# Update to matchpin connected to button that connect logic high when pushed +button_pin = board.D3 + +pixels = neopixel.NeoPixel(pixel_pin, pixel_num, brightness=0.5, auto_write=False) +button = DigitalInOut(button_pin) +button.direction = Direction.INPUT +button.pull = Pull.UP + +# Create the animation and freeze it afterwards +pulse_animation = Pulse(pixels, speed=0.1, period=1, color=RED) +pulse_animation.freeze() + +while True: + pulse_animation.animate() + + # Pressing the button resumes (or in this case starts) the animation permanently + if not button.value: + pulse_animation.resume() diff --git a/examples/led_animation_samd21_reset_interval.py b/examples/led_animation_samd21_reset_interval.py index 50e4764..f842678 100755 --- a/examples/led_animation_samd21_reset_interval.py +++ b/examples/led_animation_samd21_reset_interval.py @@ -16,9 +16,11 @@ This example will run on SAMD21 (M0) Express boards (such as Circuit Playground Express or QT Py Haxpress), but not on SAMD21 non-Express boards (such as QT Py or Trinket). """ + import time -import microcontroller + import board +import microcontroller import neopixel from adafruit_led_animation.animation.comet import Comet @@ -37,4 +39,4 @@ comet.animate() if time.monotonic() > 3600: # After an hour passes, reset the board. - microcontroller.reset() # pylint: disable=no-member + microcontroller.reset() diff --git a/examples/led_animation_sequence.py b/examples/led_animation_sequence.py index a3070e9..a73e92e 100644 --- a/examples/led_animation_sequence.py +++ b/examples/led_animation_sequence.py @@ -8,14 +8,15 @@ For NeoPixel FeatherWing. Update pixel_pin and pixel_num to match your wiring if using a different form of NeoPixels. """ + import board import neopixel from adafruit_led_animation.animation.blink import Blink -from adafruit_led_animation.animation.comet import Comet from adafruit_led_animation.animation.chase import Chase +from adafruit_led_animation.animation.comet import Comet +from adafruit_led_animation.color import AMBER, JADE, PURPLE from adafruit_led_animation.sequence import AnimationSequence -from adafruit_led_animation.color import PURPLE, AMBER, JADE # Update to match the pin connected to your NeoPixels pixel_pin = board.D6 diff --git a/examples/led_animation_simpletest.py b/examples/led_animation_simpletest.py index 86980a4..65cbe69 100644 --- a/examples/led_animation_simpletest.py +++ b/examples/led_animation_simpletest.py @@ -7,8 +7,10 @@ For NeoPixel FeatherWing. Update pixel_pin and pixel_num to match your wiring if using a different form of NeoPixels. """ + import board import neopixel + from adafruit_led_animation.animation.blink import Blink from adafruit_led_animation.color import RED diff --git a/examples/led_animation_sparkle_animations.py b/examples/led_animation_sparkle_animations.py index 01dbb9e..2148ff3 100644 --- a/examples/led_animation_sparkle_animations.py +++ b/examples/led_animation_sparkle_animations.py @@ -8,13 +8,14 @@ For NeoPixel FeatherWing. Update pixel_pin and pixel_num to match your wiring if using a different form of NeoPixels. """ + import board import neopixel from adafruit_led_animation.animation.sparkle import Sparkle from adafruit_led_animation.animation.sparklepulse import SparklePulse -from adafruit_led_animation.sequence import AnimationSequence from adafruit_led_animation.color import AMBER, JADE +from adafruit_led_animation.sequence import AnimationSequence # Update to match the pin connected to your NeoPixels pixel_pin = board.D6 diff --git a/examples/led_animation_sparkle_mask.py b/examples/led_animation_sparkle_mask.py index 27ac98a..ea4fc02 100644 --- a/examples/led_animation_sparkle_mask.py +++ b/examples/led_animation_sparkle_mask.py @@ -7,12 +7,13 @@ For NeoPixel FeatherWing. Update pixel_pin and pixel_num to match your wiring if using a different form of NeoPixels. """ + import board import neopixel from adafruit_led_animation.animation.sparkle import Sparkle +from adafruit_led_animation.color import AQUA, JADE, PINK from adafruit_led_animation.sequence import AnimationSequence -from adafruit_led_animation.color import JADE, AQUA, PINK # Update to match the pin connected to your NeoPixels pixel_pin = board.A1 diff --git a/examples/led_animation_timedsequence.py b/examples/led_animation_timedsequence.py new file mode 100644 index 0000000..543a201 --- /dev/null +++ b/examples/led_animation_timedsequence.py @@ -0,0 +1,23 @@ +# SPDX-FileCopyrightText: 2020 Gamblor21 +# +# SPDX-License-Identifier: MIT +""" +Example for TimedSequence +""" + +import board +import neopixel + +import adafruit_led_animation.animation.blink as blink_animation +import adafruit_led_animation.animation.comet as comet_animation +import adafruit_led_animation.animation.sparkle as sparkle_animation +from adafruit_led_animation import color +from adafruit_led_animation.timedsequence import TimedAnimationSequence + +strip_pixels = neopixel.NeoPixel(board.D6, 32, brightness=0.1, auto_write=False) +blink = blink_animation.Blink(strip_pixels, 0.3, color.RED) +comet = comet_animation.Comet(strip_pixels, 0.1, color.BLUE) +sparkle = sparkle_animation.Sparkle(strip_pixels, 0.05, color.GREEN) +animations = TimedAnimationSequence(blink, 2, comet, 4, sparkle, 5) +while True: + animations.animate() diff --git a/examples/led_animation_volume.py b/examples/led_animation_volume.py new file mode 100644 index 0000000..4fff2e8 --- /dev/null +++ b/examples/led_animation_volume.py @@ -0,0 +1,36 @@ +# SPDX-FileCopyrightText: 2023 Tim Cocks +# +# SPDX-License-Identifier: MIT + +"""Volume Animation Example""" + +import board +import neopixel +from audiomp3 import MP3Decoder + +from adafruit_led_animation.animation import volume + +try: + from audioio import AudioOut +except ImportError: + try: + from audiopwmio import PWMAudioOut as AudioOut + except ImportError: + pass # not always supported by every board! + +# Fill in your own MP3 file or use the one from the learn guide: +# https://learn.adafruit.com/circuitpython-essentials/circuitpython-mp3-audio#installing-project-code-3067700 +mp3file = "happy.mp3" +with open(mp3file, "rb") as mp3: + decoder = MP3Decoder(mp3) + audio = AudioOut(board.SPEAKER) + + strip_pixels = neopixel.NeoPixel(board.D4, 30, brightness=0.1, auto_write=False) + volume_anim = volume.Volume(strip_pixels, 0.3, (0, 255, 0), decoder, 400) + + while True: + audio.play(decoder) + print("playing", mp3file) + + while audio.playing: + volume_anim.animate() 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..6dd3e29 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,48 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +[build-system] +requires = [ + "setuptools", + "wheel", + "setuptools-scm", +] + +[project] +name = "adafruit-circuitpython-led-animation" +description = "CircuitPython helper for LED colors and animations." +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_LED_Animation"} +keywords = [ + "adafruit", + "blinka", + "circuitpython", + "micropython", + "led", + "animation", + "led", + "colors", + "animations", +] +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_led_animation"] + +[tool.setuptools.dynamic] +dependencies = {file = ["requirements.txt"]} +optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} diff --git a/requirements.txt b/requirements.txt index 17a850d..7a984a4 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries # # SPDX-License-Identifier: Unlicense diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..73e9efc --- /dev/null +++ b/ruff.toml @@ -0,0 +1,108 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +target-version = "py38" +line-length = 100 + +[lint] +preview = true +select = ["I", "PL", "UP"] + +extend-select = [ + "D419", # empty-docstring + "E501", # line-too-long + "W291", # trailing-whitespace + "PLC0414", # useless-import-alias + "PLC2401", # non-ascii-name + "PLC2801", # unnecessary-dunder-call + "PLC3002", # unnecessary-direct-lambda-call + "E999", # syntax-error + "PLE0101", # return-in-init + "F706", # return-outside-function + "F704", # yield-outside-function + "PLE0116", # continue-in-finally + "PLE0117", # nonlocal-without-binding + "PLE0241", # duplicate-bases + "PLE0302", # unexpected-special-method-signature + "PLE0604", # invalid-all-object + "PLE0605", # invalid-all-format + "PLE0643", # potential-index-error + "PLE0704", # misplaced-bare-raise + "PLE1141", # dict-iter-missing-items + "PLE1142", # await-outside-async + "PLE1205", # logging-too-many-args + "PLE1206", # logging-too-few-args + "PLE1307", # bad-string-format-type + "PLE1310", # bad-str-strip-call + "PLE1507", # invalid-envvar-value + "PLE2502", # bidirectional-unicode + "PLE2510", # invalid-character-backspace + "PLE2512", # invalid-character-sub + "PLE2513", # invalid-character-esc + "PLE2514", # invalid-character-nul + "PLE2515", # invalid-character-zero-width-space + "PLR0124", # comparison-with-itself + "PLR0202", # no-classmethod-decorator + "PLR0203", # no-staticmethod-decorator + "UP004", # useless-object-inheritance + "PLR0206", # property-with-parameters + "PLR0904", # too-many-public-methods + "PLR0911", # too-many-return-statements + "PLR0912", # too-many-branches + "PLR0913", # too-many-arguments + "PLR0914", # too-many-locals + "PLR0915", # too-many-statements + "PLR0916", # too-many-boolean-expressions + "PLR1702", # too-many-nested-blocks + "PLR1704", # redefined-argument-from-local + "PLR1711", # useless-return + "C416", # unnecessary-comprehension + "PLR1733", # unnecessary-dict-index-lookup + "PLR1736", # unnecessary-list-index-lookup + + # ruff reports this rule is unstable + #"PLR6301", # no-self-use + + "PLW0108", # unnecessary-lambda + "PLW0120", # useless-else-on-loop + "PLW0127", # self-assigning-variable + "PLW0129", # assert-on-string-literal + "B033", # duplicate-value + "PLW0131", # named-expr-without-context + "PLW0245", # super-without-brackets + "PLW0406", # import-self + "PLW0602", # global-variable-not-assigned + "PLW0603", # global-statement + "PLW0604", # global-at-module-level + + # fails on the try: import typing used by libraries + #"F401", # unused-import + + "F841", # unused-variable + "E722", # bare-except + "PLW0711", # binary-op-exception + "PLW1501", # bad-open-mode + "PLW1508", # invalid-envvar-default + "PLW1509", # subprocess-popen-preexec-fn + "PLW2101", # useless-with-lock + "PLW3301", # nested-min-max +] + +ignore = [ + "PLR2004", # magic-value-comparison + "UP030", # format literals + "PLW1514", # unspecified-encoding + "PLR0913", # too-many-arguments + "PLR0915", # too-many-statements + "PLR0917", # too-many-positional-arguments + "PLR0904", # too-many-public-methods + "PLR0912", # too-many-branches + "PLR0916", # too-many-boolean-expressions + "PLR6301", # could-be-static no-self-use + "PLC0415", # import outside toplevel + "PLC2701", # private import +] + +[format] +line-ending = "lf" diff --git a/setup.py b/setup.py deleted file mode 100644 index 7a2e0b9..0000000 --- a/setup.py +++ /dev/null @@ -1,59 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -"""A setuptools based setup module. - -See: -https://packaging.python.org/en/latest/distributing.html -https://github.com/pypa/sampleproject -""" - -from setuptools import setup, find_packages - -# To use a consistent encoding -from codecs import open -from os import path - -here = path.abspath(path.dirname(__file__)) - -# Get the long description from the README file -with open(path.join(here, "README.rst"), encoding="utf-8") as f: - long_description = f.read() - -setup( - name="adafruit-circuitpython-led-animation", - use_scm_version=True, - setup_requires=["setuptools_scm"], - description="CircuitPython helper for LED colors and animations.", - long_description=long_description, - long_description_content_type="text/x-rst", - # The project's main homepage. - url="https://github.com/adafruit/Adafruit_CircuitPython_LED_Animation", - # Author details - author="Adafruit Industries", - author_email="circuitpython@adafruit.com", - install_requires=[ - "Adafruit-Blinka", - ], - # 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 led animation led colors animations", - # 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=['...']` - packages=["adafruit_led_animation", "adafruit_led_animation.animation"], -)