Initial commit
This commit is contained in:
commit
5a16f94881
13
.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md
vendored
Normal file
13
.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md
vendored
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
# SPDX-FileCopyrightText: 2021 Adafruit Industries
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
Thank you for contributing! Before you submit a pull request, please read the following.
|
||||||
|
|
||||||
|
Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://circuitpython.readthedocs.io/en/latest/docs/design_guide.html
|
||||||
|
|
||||||
|
If your changes are to documentation, please verify that the documentation builds locally by following the steps found here: https://adafru.it/build-docs
|
||||||
|
|
||||||
|
Before submitting the pull request, make sure you've run Pylint and Black locally on your code. You can do this manually or using pre-commit. Instructions are available here: https://adafru.it/check-your-code
|
||||||
|
|
||||||
|
Please remove all of this text before submitting. Include an explanation or list of changes included in your PR, as well as, if applicable, a link to any related issues.
|
80
.github/workflows/build.yml
vendored
Normal file
80
.github/workflows/build.yml
vendored
Normal file
@ -0,0 +1,80 @@
|
|||||||
|
# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
name: Build CI
|
||||||
|
|
||||||
|
on: [pull_request, push]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
test:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: 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 pylint, Sphinx, pre-commit
|
||||||
|
run: |
|
||||||
|
pip install --force-reinstall pylint Sphinx sphinx-rtd-theme pre-commit
|
||||||
|
- name: Library version
|
||||||
|
run: git describe --dirty --always --tags
|
||||||
|
- name: Setup problem matchers
|
||||||
|
uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1
|
||||||
|
- 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: Check For docs folder
|
||||||
|
id: need-docs
|
||||||
|
run: |
|
||||||
|
echo ::set-output name=docs::$( find . -wholename './docs' )
|
||||||
|
- name: Build docs
|
||||||
|
if: contains(steps.need-docs.outputs.docs, '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/*
|
19
.github/workflows/failure-help-text.yml
vendored
Normal file
19
.github/workflows/failure-help-text.yml
vendored
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
# SPDX-FileCopyrightText: 2021 Scott Shawcroft for Adafruit Industries
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
name: Failure help text
|
||||||
|
|
||||||
|
on:
|
||||||
|
workflow_run:
|
||||||
|
workflows: ["Build CI"]
|
||||||
|
types:
|
||||||
|
- completed
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
post-help:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
if: ${{ github.event.workflow_run.conclusion == 'failure' && github.event.workflow_run.event == 'pull_request' }}
|
||||||
|
steps:
|
||||||
|
- name: Post comment to help
|
||||||
|
uses: adafruit/circuitpython-action-library-ci-failed@v1
|
99
.github/workflows/release.yml
vendored
Normal file
99
.github/workflows/release.yml
vendored
Normal file
@ -0,0 +1,99 @@
|
|||||||
|
# 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
|
||||||
|
# After the dist file is packaged, extract it, update the __version__
|
||||||
|
# lines and repackage it.
|
||||||
|
cd dist
|
||||||
|
ZIP_FILE=`ls | sed -e "s/\.tar\.gz$//"`
|
||||||
|
echo "ZIP FILE = ${ZIP_FILE}"
|
||||||
|
tar xzf "${ZIP_FILE}.tar.gz"
|
||||||
|
echo The latest release version is \"${{github.event.release.tag_name}}\".
|
||||||
|
# Don't descend into ./.env, ./.eggs, or ./docs
|
||||||
|
for file in $(find -not -path "./.*" -not -path "./docs*" -name "*.py"); do
|
||||||
|
sed -i -e "s/0.0.0-auto.0/${{github.event.release.tag_name}}/" $file;
|
||||||
|
done;
|
||||||
|
tar czf "${ZIP_FILE}.tar.gz" "${ZIP_FILE}"
|
||||||
|
rm -rf "${ZIP_FILE}"
|
||||||
|
cd ..
|
||||||
|
twine upload dist/*
|
18
.gitignore
vendored
Normal file
18
.gitignore
vendored
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: Unlicense
|
||||||
|
|
||||||
|
*.mpy
|
||||||
|
.idea
|
||||||
|
__pycache__
|
||||||
|
_build
|
||||||
|
*.pyc
|
||||||
|
.env
|
||||||
|
.python-version
|
||||||
|
build*/
|
||||||
|
bundles
|
||||||
|
*.DS_Store
|
||||||
|
.eggs
|
||||||
|
dist
|
||||||
|
**/*.egg-info
|
||||||
|
.vscode
|
40
.pre-commit-config.yaml
Normal file
40
.pre-commit-config.yaml
Normal file
@ -0,0 +1,40 @@
|
|||||||
|
# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: Unlicense
|
||||||
|
|
||||||
|
repos:
|
||||||
|
- repo: https://github.com/python/black
|
||||||
|
rev: 20.8b1
|
||||||
|
hooks:
|
||||||
|
- id: black
|
||||||
|
- repo: https://github.com/fsfe/reuse-tool
|
||||||
|
rev: v0.12.1
|
||||||
|
hooks:
|
||||||
|
- id: reuse
|
||||||
|
- repo: https://github.com/pre-commit/pre-commit-hooks
|
||||||
|
rev: v2.3.0
|
||||||
|
hooks:
|
||||||
|
- id: check-yaml
|
||||||
|
- id: end-of-file-fixer
|
||||||
|
- id: trailing-whitespace
|
||||||
|
- repo: https://github.com/pycqa/pylint
|
||||||
|
rev: pylint-2.7.1
|
||||||
|
hooks:
|
||||||
|
- id: pylint
|
||||||
|
name: pylint (library code)
|
||||||
|
types: [python]
|
||||||
|
exclude: "^(docs/|examples/|tests/|setup.py$)"
|
||||||
|
- repo: local
|
||||||
|
hooks:
|
||||||
|
- id: pylint_examples
|
||||||
|
name: pylint (examples code)
|
||||||
|
description: Run pylint rules on "examples/*.py" files
|
||||||
|
entry: /usr/bin/env bash -c
|
||||||
|
args: ['([[ ! -d "examples" ]] || for example in $(find . -path "./examples/*.py"); do pylint --disable=missing-docstring,invalid-name $example; done)']
|
||||||
|
language: system
|
||||||
|
- id: pylint_tests
|
||||||
|
name: pylint (tests code)
|
||||||
|
description: Run pylint rules on "tests/*.py" files
|
||||||
|
entry: /usr/bin/env bash -c
|
||||||
|
args: ['([[ ! -d "tests" ]] || for test in $(find . -path "./tests/*.py"); do pylint --disable=missing-docstring $test; done)']
|
||||||
|
language: system
|
436
.pylintrc
Normal file
436
.pylintrc
Normal file
@ -0,0 +1,436 @@
|
|||||||
|
# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written 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 ignore-list. They should be base names, not
|
||||||
|
# paths.
|
||||||
|
ignore=CVS
|
||||||
|
|
||||||
|
# Add files or directories matching the regex patterns to the ignore-list. 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,pointless-string-statement
|
||||||
|
|
||||||
|
# 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*(# )?<?https?://\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=12
|
||||||
|
|
||||||
|
|
||||||
|
[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
|
7
.readthedocs.yml
Normal file
7
.readthedocs.yml
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: Unlicense
|
||||||
|
|
||||||
|
python:
|
||||||
|
version: 3
|
||||||
|
requirements_file: requirements.txt
|
138
CODE_OF_CONDUCT.md
Normal file
138
CODE_OF_CONDUCT.md
Normal file
@ -0,0 +1,138 @@
|
|||||||
|
<!--
|
||||||
|
SPDX-FileCopyrightText: 2014 Coraline Ada Ehmke
|
||||||
|
SPDX-FileCopyrightText: 2019-2021 Kattni Rembor
|
||||||
|
|
||||||
|
SPDX-License-Identifier: CC-BY-4.0
|
||||||
|
-->
|
||||||
|
# CircuitPython Community Code of Conduct
|
||||||
|
|
||||||
|
## Our Pledge
|
||||||
|
|
||||||
|
In the interest of fostering an open and welcoming environment, we as
|
||||||
|
contributors and leaders pledge to making participation in our project and
|
||||||
|
our community a harassment-free experience for everyone, regardless of age, body
|
||||||
|
size, disability, ethnicity, gender identity and expression, level or type of
|
||||||
|
experience, education, socio-economic status, nationality, personal appearance,
|
||||||
|
race, religion, or sexual identity and orientation.
|
||||||
|
|
||||||
|
## Our Standards
|
||||||
|
|
||||||
|
We are committed to providing a friendly, safe and welcoming environment for
|
||||||
|
all.
|
||||||
|
|
||||||
|
Examples of behavior that contributes to creating a positive environment
|
||||||
|
include:
|
||||||
|
|
||||||
|
* Be kind and courteous to others
|
||||||
|
* Using welcoming and inclusive language
|
||||||
|
* Being respectful of differing viewpoints and experiences
|
||||||
|
* Collaborating with other community members
|
||||||
|
* Gracefully accepting constructive criticism
|
||||||
|
* Focusing on what is best for the community
|
||||||
|
* Showing empathy towards other community members
|
||||||
|
|
||||||
|
Examples of unacceptable behavior by participants include:
|
||||||
|
|
||||||
|
* The use of sexualized language or imagery and sexual attention or advances
|
||||||
|
* The use of inappropriate images, including in a community member's avatar
|
||||||
|
* The use of inappropriate language, including in a community member's nickname
|
||||||
|
* Any spamming, flaming, baiting or other attention-stealing behavior
|
||||||
|
* Excessive or unwelcome helping; answering outside the scope of the question
|
||||||
|
asked
|
||||||
|
* Discussion or promotion of activities or projects that intend or pose a risk of
|
||||||
|
significant harm
|
||||||
|
* Trolling, insulting/derogatory comments, and personal or political attacks
|
||||||
|
* Promoting or spreading disinformation, lies, or conspiracy theories against
|
||||||
|
a person, group, organisation, project, or community
|
||||||
|
* Public or private harassment
|
||||||
|
* Publishing others' private information, such as a physical or electronic
|
||||||
|
address, without explicit permission
|
||||||
|
* Other conduct which could reasonably be considered inappropriate
|
||||||
|
|
||||||
|
The goal of the standards and moderation guidelines outlined here is to build
|
||||||
|
and maintain a respectful community. We ask that you don’t just aim to be
|
||||||
|
"technically unimpeachable", but rather try to be your best self.
|
||||||
|
|
||||||
|
We value many things beyond technical expertise, including collaboration and
|
||||||
|
supporting others within our community. Providing a positive experience for
|
||||||
|
other community members can have a much more significant impact than simply
|
||||||
|
providing the correct answer.
|
||||||
|
|
||||||
|
## Our Responsibilities
|
||||||
|
|
||||||
|
Project leaders are responsible for clarifying the standards of acceptable
|
||||||
|
behavior and are expected to take appropriate and fair corrective action in
|
||||||
|
response to any instances of unacceptable behavior.
|
||||||
|
|
||||||
|
Project leaders have the right and responsibility to remove, edit, or
|
||||||
|
reject messages, comments, commits, code, issues, and other contributions
|
||||||
|
that are not aligned to this Code of Conduct, or to ban temporarily or
|
||||||
|
permanently any community member for other behaviors that they deem
|
||||||
|
inappropriate, threatening, offensive, or harmful.
|
||||||
|
|
||||||
|
## Moderation
|
||||||
|
|
||||||
|
Instances of behaviors that violate the CircuitPython Community Code of Conduct
|
||||||
|
may be reported by any member of the community. Community members are
|
||||||
|
encouraged to report these situations, including situations they witness
|
||||||
|
involving other community members.
|
||||||
|
|
||||||
|
You may report in the following ways:
|
||||||
|
|
||||||
|
In any situation, you may email the project maintainer.
|
||||||
|
|
||||||
|
Email reports will be kept confidential.
|
||||||
|
|
||||||
|
In situations on GitHub where the issue is particularly offensive, possibly
|
||||||
|
illegal, requires immediate action, or violates the GitHub terms of service,
|
||||||
|
you should also report the message directly to GitHub via the comment, or via
|
||||||
|
[GitHub Support](https://support.github.com/contact/report-abuse?category=report-abuse&report=other&report_type=unspecified).
|
||||||
|
|
||||||
|
These are the steps for upholding our community’s standards of conduct.
|
||||||
|
|
||||||
|
1. Any member of the community may report any situation that violates the
|
||||||
|
CircuitPython Community Code of Conduct. All reports will be reviewed and
|
||||||
|
investigated.
|
||||||
|
2. If the behavior is a severe violation, the community member who
|
||||||
|
committed the violation may be banned immediately, without warning.
|
||||||
|
3. Otherwise, moderators will first respond to such behavior with a warning.
|
||||||
|
4. Moderators follow a soft "three strikes" policy - the community member may
|
||||||
|
be given another chance, if they are receptive to the warning and change their
|
||||||
|
behavior.
|
||||||
|
5. If the community member is unreceptive or unreasonable when warned by a
|
||||||
|
moderator, or the warning goes unheeded, they may be banned for a first or
|
||||||
|
second offense. Repeated offenses will result in the community member being
|
||||||
|
banned.
|
||||||
|
6. Disciplinary actions (warnings, bans, etc) for Code of Conduct violations apply
|
||||||
|
to the platform where the violation occurred. However, depending on the severity
|
||||||
|
of the violation, the disciplinary action may be applied across CircuitPython's
|
||||||
|
other community platforms. For example, a severe violation in one Community forum
|
||||||
|
may result in a ban on not only the CircuitPython GitHub organisation,
|
||||||
|
but also on the CircuitPython Twitter, live stream text chats, etc.
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
This Code of Conduct and the enforcement policies listed above apply to all
|
||||||
|
CircuitPython Community venues. This includes but is not limited to any community
|
||||||
|
spaces (both public and private), and CircuitPython repositories. Examples of
|
||||||
|
CircuitPython Community spaces include but are not limited to meet-ups, issue
|
||||||
|
threads on GitHub, text chats during a live stream, or interaction at a conference.
|
||||||
|
|
||||||
|
This Code of Conduct applies both within project spaces and in public spaces
|
||||||
|
when an individual is representing the project or its community. As a community
|
||||||
|
member, you are representing our community, and are expected to behave
|
||||||
|
accordingly.
|
||||||
|
|
||||||
|
## Attribution
|
||||||
|
|
||||||
|
This Code of Conduct is adapted from the
|
||||||
|
[Adafruit Community Code of Conduct](https://github.com/adafruit/Adafruit_Community_Code_of_Conduct),
|
||||||
|
which is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/),
|
||||||
|
version 1.4, available on [contributor-covenant.org](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html),
|
||||||
|
and the [Rust Code of Conduct](https://www.rust-lang.org/en-US/conduct.html).
|
||||||
|
|
||||||
|
For other projects adopting the CircuitPython Community Code of
|
||||||
|
Conduct, please contact the maintainers of those projects for enforcement.
|
||||||
|
If you wish to use this code of conduct for your own project, consider
|
||||||
|
explicitly mentioning your moderation policy or making a copy with your
|
||||||
|
own moderation policy so as to avoid confusion.
|
21
LICENSE
Normal file
21
LICENSE
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright (c) 2021 Arofarn
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
324
LICENSES/CC-BY-4.0.txt
Normal file
324
LICENSES/CC-BY-4.0.txt
Normal file
@ -0,0 +1,324 @@
|
|||||||
|
Creative Commons Attribution 4.0 International Creative Commons Corporation
|
||||||
|
("Creative Commons") is not a law firm and does not provide legal services
|
||||||
|
or legal advice. Distribution of Creative Commons public licenses does not
|
||||||
|
create a lawyer-client or other relationship. Creative Commons makes its licenses
|
||||||
|
and related information available on an "as-is" basis. Creative Commons gives
|
||||||
|
no warranties regarding its licenses, any material licensed under their terms
|
||||||
|
and conditions, or any related information. Creative Commons disclaims all
|
||||||
|
liability for damages resulting from their use to the fullest extent possible.
|
||||||
|
|
||||||
|
Using Creative Commons Public Licenses
|
||||||
|
|
||||||
|
Creative Commons public licenses provide a standard set of terms and conditions
|
||||||
|
that creators and other rights holders may use to share original works of
|
||||||
|
authorship and other material subject to copyright and certain other rights
|
||||||
|
specified in the public license below. The following considerations are for
|
||||||
|
informational purposes only, are not exhaustive, and do not form part of our
|
||||||
|
licenses.
|
||||||
|
|
||||||
|
Considerations for licensors: Our public licenses are intended for use by
|
||||||
|
those authorized to give the public permission to use material in ways otherwise
|
||||||
|
restricted by copyright and certain other rights. Our licenses are irrevocable.
|
||||||
|
Licensors should read and understand the terms and conditions of the license
|
||||||
|
they choose before applying it. Licensors should also secure all rights necessary
|
||||||
|
before applying our licenses so that the public can reuse the material as
|
||||||
|
expected. Licensors should clearly mark any material not subject to the license.
|
||||||
|
This includes other CC-licensed material, or material used under an exception
|
||||||
|
or limitation to copyright. More considerations for licensors : wiki.creativecommons.org/Considerations_for_licensors
|
||||||
|
|
||||||
|
Considerations for the public: By using one of our public licenses, a licensor
|
||||||
|
grants the public permission to use the licensed material under specified
|
||||||
|
terms and conditions. If the licensor's permission is not necessary for any
|
||||||
|
reason–for example, because of any applicable exception or limitation to copyright–then
|
||||||
|
that use is not regulated by the license. Our licenses grant only permissions
|
||||||
|
under copyright and certain other rights that a licensor has authority to
|
||||||
|
grant. Use of the licensed material may still be restricted for other reasons,
|
||||||
|
including because others have copyright or other rights in the material. A
|
||||||
|
licensor may make special requests, such as asking that all changes be marked
|
||||||
|
or described. Although not required by our licenses, you are encouraged to
|
||||||
|
respect those requests where reasonable. More considerations for the public
|
||||||
|
: wiki.creativecommons.org/Considerations_for_licensees Creative Commons Attribution
|
||||||
|
4.0 International Public License
|
||||||
|
|
||||||
|
By exercising the Licensed Rights (defined below), You accept and agree to
|
||||||
|
be bound by the terms and conditions of this Creative Commons Attribution
|
||||||
|
4.0 International Public License ("Public License"). To the extent this Public
|
||||||
|
License may be interpreted as a contract, You are granted the Licensed Rights
|
||||||
|
in consideration of Your acceptance of these terms and conditions, and the
|
||||||
|
Licensor grants You such rights in consideration of benefits the Licensor
|
||||||
|
receives from making the Licensed Material available under these terms and
|
||||||
|
conditions.
|
||||||
|
|
||||||
|
Section 1 – Definitions.
|
||||||
|
|
||||||
|
a. Adapted Material means material subject to Copyright and Similar Rights
|
||||||
|
that is derived from or based upon the Licensed Material and in which the
|
||||||
|
Licensed Material is translated, altered, arranged, transformed, or otherwise
|
||||||
|
modified in a manner requiring permission under the Copyright and Similar
|
||||||
|
Rights held by the Licensor. For purposes of this Public License, where the
|
||||||
|
Licensed Material is a musical work, performance, or sound recording, Adapted
|
||||||
|
Material is always produced where the Licensed Material is synched in timed
|
||||||
|
relation with a moving image.
|
||||||
|
|
||||||
|
b. Adapter's License means the license You apply to Your Copyright and Similar
|
||||||
|
Rights in Your contributions to Adapted Material in accordance with the terms
|
||||||
|
and conditions of this Public License.
|
||||||
|
|
||||||
|
c. Copyright and Similar Rights means copyright and/or similar rights closely
|
||||||
|
related to copyright including, without limitation, performance, broadcast,
|
||||||
|
sound recording, and Sui Generis Database Rights, without regard to how the
|
||||||
|
rights are labeled or categorized. For purposes of this Public License, the
|
||||||
|
rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
|
||||||
|
|
||||||
|
d. Effective Technological Measures means those measures that, in the absence
|
||||||
|
of proper authority, may not be circumvented under laws fulfilling obligations
|
||||||
|
under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996,
|
||||||
|
and/or similar international agreements.
|
||||||
|
|
||||||
|
e. Exceptions and Limitations means fair use, fair dealing, and/or any other
|
||||||
|
exception or limitation to Copyright and Similar Rights that applies to Your
|
||||||
|
use of the Licensed Material.
|
||||||
|
|
||||||
|
f. Licensed Material means the artistic or literary work, database, or other
|
||||||
|
material to which the Licensor applied this Public License.
|
||||||
|
|
||||||
|
g. Licensed Rights means the rights granted to You subject to the terms and
|
||||||
|
conditions of this Public License, which are limited to all Copyright and
|
||||||
|
Similar Rights that apply to Your use of the Licensed Material and that the
|
||||||
|
Licensor has authority to license.
|
||||||
|
|
||||||
|
h. Licensor means the individual(s) or entity(ies) granting rights under this
|
||||||
|
Public License.
|
||||||
|
|
||||||
|
i. Share means to provide material to the public by any means or process that
|
||||||
|
requires permission under the Licensed Rights, such as reproduction, public
|
||||||
|
display, public performance, distribution, dissemination, communication, or
|
||||||
|
importation, and to make material available to the public including in ways
|
||||||
|
that members of the public may access the material from a place and at a time
|
||||||
|
individually chosen by them.
|
||||||
|
|
||||||
|
j. Sui Generis Database Rights means rights other than copyright resulting
|
||||||
|
from Directive 96/9/EC of the European Parliament and of the Council of 11
|
||||||
|
March 1996 on the legal protection of databases, as amended and/or succeeded,
|
||||||
|
as well as other essentially equivalent rights anywhere in the world.
|
||||||
|
|
||||||
|
k. You means the individual or entity exercising the Licensed Rights under
|
||||||
|
this Public License. Your has a corresponding meaning.
|
||||||
|
|
||||||
|
Section 2 – Scope.
|
||||||
|
|
||||||
|
a. License grant.
|
||||||
|
|
||||||
|
1. Subject to the terms and conditions of this Public License, the Licensor
|
||||||
|
hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive,
|
||||||
|
irrevocable license to exercise the Licensed Rights in the Licensed Material
|
||||||
|
to:
|
||||||
|
|
||||||
|
A. reproduce and Share the Licensed Material, in whole or in part; and
|
||||||
|
|
||||||
|
B. produce, reproduce, and Share Adapted Material.
|
||||||
|
|
||||||
|
2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions
|
||||||
|
and Limitations apply to Your use, this Public License does not apply, and
|
||||||
|
You do not need to comply with its terms and conditions.
|
||||||
|
|
||||||
|
3. Term. The term of this Public License is specified in Section 6(a).
|
||||||
|
|
||||||
|
4. Media and formats; technical modifications allowed. The Licensor authorizes
|
||||||
|
You to exercise the Licensed Rights in all media and formats whether now known
|
||||||
|
or hereafter created, and to make technical modifications necessary to do
|
||||||
|
so. The Licensor waives and/or agrees not to assert any right or authority
|
||||||
|
to forbid You from making technical modifications necessary to exercise the
|
||||||
|
Licensed Rights, including technical modifications necessary to circumvent
|
||||||
|
Effective Technological Measures. For purposes of this Public License, simply
|
||||||
|
making modifications authorized by this Section 2(a)(4) never produces Adapted
|
||||||
|
Material.
|
||||||
|
|
||||||
|
5. Downstream recipients.
|
||||||
|
|
||||||
|
A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed
|
||||||
|
Material automatically receives an offer from the Licensor to exercise the
|
||||||
|
Licensed Rights under the terms and conditions of this Public License.
|
||||||
|
|
||||||
|
B. No downstream restrictions. You may not offer or impose any additional
|
||||||
|
or different terms or conditions on, or apply any Effective Technological
|
||||||
|
Measures to, the Licensed Material if doing so restricts exercise of the Licensed
|
||||||
|
Rights by any recipient of the Licensed Material.
|
||||||
|
|
||||||
|
6. No endorsement. Nothing in this Public License constitutes or may be construed
|
||||||
|
as permission to assert or imply that You are, or that Your use of the Licensed
|
||||||
|
Material is, connected with, or sponsored, endorsed, or granted official status
|
||||||
|
by, the Licensor or others designated to receive attribution as provided in
|
||||||
|
Section 3(a)(1)(A)(i).
|
||||||
|
|
||||||
|
b. Other rights.
|
||||||
|
|
||||||
|
1. Moral rights, such as the right of integrity, are not licensed under this
|
||||||
|
Public License, nor are publicity, privacy, and/or other similar personality
|
||||||
|
rights; however, to the extent possible, the Licensor waives and/or agrees
|
||||||
|
not to assert any such rights held by the Licensor to the limited extent necessary
|
||||||
|
to allow You to exercise the Licensed Rights, but not otherwise.
|
||||||
|
|
||||||
|
2. Patent and trademark rights are not licensed under this Public License.
|
||||||
|
|
||||||
|
3. To the extent possible, the Licensor waives any right to collect royalties
|
||||||
|
from You for the exercise of the Licensed Rights, whether directly or through
|
||||||
|
a collecting society under any voluntary or waivable statutory or compulsory
|
||||||
|
licensing scheme. In all other cases the Licensor expressly reserves any right
|
||||||
|
to collect such royalties.
|
||||||
|
|
||||||
|
Section 3 – License Conditions.
|
||||||
|
|
||||||
|
Your exercise of the Licensed Rights is expressly made subject to the following
|
||||||
|
conditions.
|
||||||
|
|
||||||
|
a. Attribution.
|
||||||
|
|
||||||
|
1. If You Share the Licensed Material (including in modified form), You must:
|
||||||
|
|
||||||
|
A. retain the following if it is supplied by the Licensor with the Licensed
|
||||||
|
Material:
|
||||||
|
|
||||||
|
i. identification of the creator(s) of the Licensed Material and any others
|
||||||
|
designated to receive attribution, in any reasonable manner requested by the
|
||||||
|
Licensor (including by pseudonym if designated);
|
||||||
|
|
||||||
|
ii. a copyright notice;
|
||||||
|
|
||||||
|
iii. a notice that refers to this Public License;
|
||||||
|
|
||||||
|
iv. a notice that refers to the disclaimer of warranties;
|
||||||
|
|
||||||
|
v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
|
||||||
|
|
||||||
|
B. indicate if You modified the Licensed Material and retain an indication
|
||||||
|
of any previous modifications; and
|
||||||
|
|
||||||
|
C. indicate the Licensed Material is licensed under this Public License, and
|
||||||
|
include the text of, or the URI or hyperlink to, this Public License.
|
||||||
|
|
||||||
|
2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner
|
||||||
|
based on the medium, means, and context in which You Share the Licensed Material.
|
||||||
|
For example, it may be reasonable to satisfy the conditions by providing a
|
||||||
|
URI or hyperlink to a resource that includes the required information.
|
||||||
|
|
||||||
|
3. If requested by the Licensor, You must remove any of the information required
|
||||||
|
by Section 3(a)(1)(A) to the extent reasonably practicable.
|
||||||
|
|
||||||
|
4. If You Share Adapted Material You produce, the Adapter's License You apply
|
||||||
|
must not prevent recipients of the Adapted Material from complying with this
|
||||||
|
Public License.
|
||||||
|
|
||||||
|
Section 4 – Sui Generis Database Rights.
|
||||||
|
|
||||||
|
Where the Licensed Rights include Sui Generis Database Rights that apply to
|
||||||
|
Your use of the Licensed Material:
|
||||||
|
|
||||||
|
a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract,
|
||||||
|
reuse, reproduce, and Share all or a substantial portion of the contents of
|
||||||
|
the database;
|
||||||
|
|
||||||
|
b. if You include all or a substantial portion of the database contents in
|
||||||
|
a database in which You have Sui Generis Database Rights, then the database
|
||||||
|
in which You have Sui Generis Database Rights (but not its individual contents)
|
||||||
|
is Adapted Material; and
|
||||||
|
|
||||||
|
c. You must comply with the conditions in Section 3(a) if You Share all or
|
||||||
|
a substantial portion of the contents of the database.
|
||||||
|
|
||||||
|
For the avoidance of doubt, this Section 4 supplements and does not replace
|
||||||
|
Your obligations under this Public License where the Licensed Rights include
|
||||||
|
other Copyright and Similar Rights.
|
||||||
|
|
||||||
|
Section 5 – Disclaimer of Warranties and Limitation of Liability.
|
||||||
|
|
||||||
|
a. Unless otherwise separately undertaken by the Licensor, to the extent possible,
|
||||||
|
the Licensor offers the Licensed Material as-is and as-available, and makes
|
||||||
|
no representations or warranties of any kind concerning the Licensed Material,
|
||||||
|
whether express, implied, statutory, or other. This includes, without limitation,
|
||||||
|
warranties of title, merchantability, fitness for a particular purpose, non-infringement,
|
||||||
|
absence of latent or other defects, accuracy, or the presence or absence of
|
||||||
|
errors, whether or not known or discoverable. Where disclaimers of warranties
|
||||||
|
are not allowed in full or in part, this disclaimer may not apply to You.
|
||||||
|
|
||||||
|
b. To the extent possible, in no event will the Licensor be liable to You
|
||||||
|
on any legal theory (including, without limitation, negligence) or otherwise
|
||||||
|
for any direct, special, indirect, incidental, consequential, punitive, exemplary,
|
||||||
|
or other losses, costs, expenses, or damages arising out of this Public License
|
||||||
|
or use of the Licensed Material, even if the Licensor has been advised of
|
||||||
|
the possibility of such losses, costs, expenses, or damages. Where a limitation
|
||||||
|
of liability is not allowed in full or in part, this limitation may not apply
|
||||||
|
to You.
|
||||||
|
|
||||||
|
c. The disclaimer of warranties and limitation of liability provided above
|
||||||
|
shall be interpreted in a manner that, to the extent possible, most closely
|
||||||
|
approximates an absolute disclaimer and waiver of all liability.
|
||||||
|
|
||||||
|
Section 6 – Term and Termination.
|
||||||
|
|
||||||
|
a. This Public License applies for the term of the Copyright and Similar Rights
|
||||||
|
licensed here. However, if You fail to comply with this Public License, then
|
||||||
|
Your rights under this Public License terminate automatically.
|
||||||
|
|
||||||
|
b. Where Your right to use the Licensed Material has terminated under Section
|
||||||
|
6(a), it reinstates:
|
||||||
|
|
||||||
|
1. automatically as of the date the violation is cured, provided it is cured
|
||||||
|
within 30 days of Your discovery of the violation; or
|
||||||
|
|
||||||
|
2. upon express reinstatement by the Licensor.
|
||||||
|
|
||||||
|
c. For the avoidance of doubt, this Section 6(b) does not affect any right
|
||||||
|
the Licensor may have to seek remedies for Your violations of this Public
|
||||||
|
License.
|
||||||
|
|
||||||
|
d. For the avoidance of doubt, the Licensor may also offer the Licensed Material
|
||||||
|
under separate terms or conditions or stop distributing the Licensed Material
|
||||||
|
at any time; however, doing so will not terminate this Public License.
|
||||||
|
|
||||||
|
e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
|
||||||
|
|
||||||
|
Section 7 – Other Terms and Conditions.
|
||||||
|
|
||||||
|
a. The Licensor shall not be bound by any additional or different terms or
|
||||||
|
conditions communicated by You unless expressly agreed.
|
||||||
|
|
||||||
|
b. Any arrangements, understandings, or agreements regarding the Licensed
|
||||||
|
Material not stated herein are separate from and independent of the terms
|
||||||
|
and conditions of this Public License.
|
||||||
|
|
||||||
|
Section 8 – Interpretation.
|
||||||
|
|
||||||
|
a. For the avoidance of doubt, this Public License does not, and shall not
|
||||||
|
be interpreted to, reduce, limit, restrict, or impose conditions on any use
|
||||||
|
of the Licensed Material that could lawfully be made without permission under
|
||||||
|
this Public License.
|
||||||
|
|
||||||
|
b. To the extent possible, if any provision of this Public License is deemed
|
||||||
|
unenforceable, it shall be automatically reformed to the minimum extent necessary
|
||||||
|
to make it enforceable. If the provision cannot be reformed, it shall be severed
|
||||||
|
from this Public License without affecting the enforceability of the remaining
|
||||||
|
terms and conditions.
|
||||||
|
|
||||||
|
c. No term or condition of this Public License will be waived and no failure
|
||||||
|
to comply consented to unless expressly agreed to by the Licensor.
|
||||||
|
|
||||||
|
d. Nothing in this Public License constitutes or may be interpreted as a limitation
|
||||||
|
upon, or waiver of, any privileges and immunities that apply to the Licensor
|
||||||
|
or You, including from the legal processes of any jurisdiction or authority.
|
||||||
|
|
||||||
|
Creative Commons is not a party to its public licenses. Notwithstanding, Creative
|
||||||
|
Commons may elect to apply one of its public licenses to material it publishes
|
||||||
|
and in those instances will be considered the "Licensor." The text of the
|
||||||
|
Creative Commons public licenses is dedicated to the public domain under the
|
||||||
|
CC0 Public Domain Dedication. Except for the limited purpose of indicating
|
||||||
|
that material is shared under a Creative Commons public license or as otherwise
|
||||||
|
permitted by the Creative Commons policies published at creativecommons.org/policies,
|
||||||
|
Creative Commons does not authorize the use of the trademark "Creative Commons"
|
||||||
|
or any other trademark or logo of Creative Commons without its prior written
|
||||||
|
consent including, without limitation, in connection with any unauthorized
|
||||||
|
modifications to any of its public licenses or any other arrangements, understandings,
|
||||||
|
or agreements concerning use of licensed material. For the avoidance of doubt,
|
||||||
|
this paragraph does not form part of the public licenses.
|
||||||
|
|
||||||
|
Creative Commons may be contacted at creativecommons.org.
|
19
LICENSES/MIT.txt
Normal file
19
LICENSES/MIT.txt
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
MIT License Copyright (c) <year> <copyright holders>
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is furnished
|
||||||
|
to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice (including the next
|
||||||
|
paragraph) shall be included in all copies or substantial portions of the
|
||||||
|
Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||||
|
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
|
||||||
|
OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||||
|
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
|
||||||
|
OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
20
LICENSES/Unlicense.txt
Normal file
20
LICENSES/Unlicense.txt
Normal file
@ -0,0 +1,20 @@
|
|||||||
|
This is free and unencumbered software released into the public domain.
|
||||||
|
|
||||||
|
Anyone is free to copy, modify, publish, use, compile, sell, or distribute
|
||||||
|
this software, either in source code form or as a compiled binary, for any
|
||||||
|
purpose, commercial or non-commercial, and by any means.
|
||||||
|
|
||||||
|
In jurisdictions that recognize copyright laws, the author or authors of this
|
||||||
|
software dedicate any and all copyright interest in the software to the public
|
||||||
|
domain. We make this dedication for the benefit of the public at large and
|
||||||
|
to the detriment of our heirs and successors. We intend this dedication to
|
||||||
|
be an overt act of relinquishment in perpetuity of all present and future
|
||||||
|
rights to this software under copyright law.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
||||||
|
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
|
||||||
|
BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||||
|
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH
|
||||||
|
THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. For more information,
|
||||||
|
please refer to <https://unlicense.org/>
|
120
README.rst
Normal file
120
README.rst
Normal file
@ -0,0 +1,120 @@
|
|||||||
|
Introduction
|
||||||
|
============
|
||||||
|
|
||||||
|
|
||||||
|
.. image:: https://readthedocs.org/projects/circuitpython-trellism4_extended/badge/?version=latest
|
||||||
|
:target: https://circuitpython-trellism4_extended.readthedocs.io/
|
||||||
|
:alt: Documentation Status
|
||||||
|
|
||||||
|
|
||||||
|
.. image:: https://img.shields.io/discord/327254708534116352.svg
|
||||||
|
:target: https://adafru.it/discord
|
||||||
|
:alt: Discord
|
||||||
|
|
||||||
|
|
||||||
|
.. image:: https://github.com/arofarn/CircuitPython_Org_TrellisM4_extended/workflows/Build%20CI/badge.svg
|
||||||
|
:target: https://github.com/arofarn/CircuitPython_Org_TrellisM4_extended/actions
|
||||||
|
:alt: Build Status
|
||||||
|
|
||||||
|
|
||||||
|
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
|
||||||
|
:target: https://github.com/psf/black
|
||||||
|
:alt: Code Style: Black
|
||||||
|
|
||||||
|
CircuitPython library to extended Adafruit NeotrellisM4 board with two Neotrellis seesaw boards (or more !).
|
||||||
|
|
||||||
|
|
||||||
|
Dependencies
|
||||||
|
=============
|
||||||
|
This driver depends on:
|
||||||
|
|
||||||
|
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
|
||||||
|
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
|
||||||
|
|
||||||
|
Please ensure all dependencies are available on the CircuitPython filesystem.
|
||||||
|
This is easily achieved by downloading
|
||||||
|
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`.
|
||||||
|
|
||||||
|
|
||||||
|
Usage Example
|
||||||
|
=============
|
||||||
|
|
||||||
|
::
|
||||||
|
|
||||||
|
import time
|
||||||
|
from board import SCL, SDA
|
||||||
|
import busio
|
||||||
|
from adafruit_neotrellis.neotrellis import NeoTrellis
|
||||||
|
from adafruit_neotrellis.multitrellis import MultiTrellis
|
||||||
|
from neotrellism4 import NeoTrellisM4
|
||||||
|
|
||||||
|
#create the i2c object for the trellis
|
||||||
|
I2C = busio.I2C(SCL, SDA)
|
||||||
|
|
||||||
|
# Create the trellis. This is for a 2x2 array of TrellisM4 (first row) with
|
||||||
|
# 2 Neotrellis (second row).
|
||||||
|
#
|
||||||
|
# [ NeoM4_left | NeoM4_right ]
|
||||||
|
# neotrellis0 | neotrellis1
|
||||||
|
|
||||||
|
trellim4_left = NeoTrellisM4()
|
||||||
|
trellim4_right = NeoTrellisM4(left_part=trellim4_left)
|
||||||
|
trelli = [
|
||||||
|
[trellim4_left, trellim4_right],
|
||||||
|
[NeoTrellis(I2C, False, addr=0x2F), NeoTrellis(I2C, False, addr=0x2E)]
|
||||||
|
]
|
||||||
|
|
||||||
|
trellis = MultiTrellis(trelli)
|
||||||
|
|
||||||
|
#some color definitions
|
||||||
|
OFF = (0, 0, 0)
|
||||||
|
RED = (127, 0, 0)
|
||||||
|
YELLOW = (127, 75, 0)
|
||||||
|
GREEN = (0, 127, 0)
|
||||||
|
CYAN = (0, 127, 127)
|
||||||
|
BLUE = (0, 0, 127)
|
||||||
|
PURPLE = (90, 0, 127)
|
||||||
|
|
||||||
|
#this will be called when button events are received
|
||||||
|
def blink(xcoord, ycoord, edge):
|
||||||
|
#turn the LED on when a rising edge is detected
|
||||||
|
if edge == NeoTrellis.EDGE_RISING:
|
||||||
|
trellis.color(xcoord, ycoord, BLUE)
|
||||||
|
#turn the LED off when a rising edge is detected
|
||||||
|
elif edge == NeoTrellis.EDGE_FALLING:
|
||||||
|
trellis.color(xcoord, ycoord, OFF)
|
||||||
|
|
||||||
|
for y in range(8):
|
||||||
|
for x in range(8):
|
||||||
|
# activate rising edge events on all keys
|
||||||
|
print(x, y)
|
||||||
|
trellis.activate_key(x, y, NeoTrellis.EDGE_RISING)
|
||||||
|
# activate falling edge events on all keys
|
||||||
|
trellis.activate_key(x, y, NeoTrellis.EDGE_FALLING)
|
||||||
|
trellis.set_callback(x, y, blink)
|
||||||
|
trellis.color(x, y, PURPLE)
|
||||||
|
time.sleep(.05)
|
||||||
|
|
||||||
|
for y in range(8):
|
||||||
|
for x in range(8):
|
||||||
|
trellis.color(x, y, OFF)
|
||||||
|
time.sleep(.05)
|
||||||
|
|
||||||
|
while True:
|
||||||
|
#the trellis can only be read every 17 millisecons or so
|
||||||
|
trellis.sync()
|
||||||
|
time.sleep(.02)
|
||||||
|
|
||||||
|
|
||||||
|
Contributing
|
||||||
|
============
|
||||||
|
|
||||||
|
Contributions are welcome! Please read our `Code of Conduct
|
||||||
|
<https://github.com/arofarn/CircuitPython_Org_TrellisM4_extended/blob/HEAD/CODE_OF_CONDUCT.md>`_
|
||||||
|
before contributing to help this project stay welcoming.
|
||||||
|
|
||||||
|
Documentation
|
||||||
|
=============
|
||||||
|
|
||||||
|
For information on building library documentation, please check out
|
||||||
|
`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
|
3
README.rst.license
Normal file
3
README.rst.license
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
|
||||||
|
SPDX-FileCopyrightText: Copyright (c) 2021 Arofarn
|
||||||
|
SPDX-License-Identifier: MIT
|
BIN
docs/_static/favicon.ico
vendored
Normal file
BIN
docs/_static/favicon.ico
vendored
Normal file
Binary file not shown.
After Width: | Height: | Size: 4.3 KiB |
3
docs/_static/favicon.ico.license
vendored
Normal file
3
docs/_static/favicon.ico.license
vendored
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries
|
||||||
|
|
||||||
|
SPDX-License-Identifier: CC-BY-4.0
|
8
docs/api.rst
Normal file
8
docs/api.rst
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
|
||||||
|
.. If you created a package, create one automodule per module in the package.
|
||||||
|
|
||||||
|
.. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py)
|
||||||
|
.. use this format as the module name: "adafruit_foo.foo"
|
||||||
|
|
||||||
|
.. automodule:: trellism4_extended
|
||||||
|
:members:
|
4
docs/api.rst.license
Normal file
4
docs/api.rst.license
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
|
||||||
|
SPDX-FileCopyrightText: Copyright (c) 2021 Arofarn
|
||||||
|
|
||||||
|
SPDX-License-Identifier: MIT
|
188
docs/conf.py
Normal file
188
docs/conf.py
Normal file
@ -0,0 +1,188 @@
|
|||||||
|
# -*- coding: utf-8 -*-
|
||||||
|
|
||||||
|
# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
import os
|
||||||
|
import sys
|
||||||
|
|
||||||
|
sys.path.insert(0, os.path.abspath(".."))
|
||||||
|
|
||||||
|
# -- General configuration ------------------------------------------------
|
||||||
|
|
||||||
|
# Add any Sphinx extension module names here, as strings. They can be
|
||||||
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||||
|
# ones.
|
||||||
|
extensions = [
|
||||||
|
"sphinx.ext.autodoc",
|
||||||
|
"sphinx.ext.intersphinx",
|
||||||
|
"sphinx.ext.napoleon",
|
||||||
|
"sphinx.ext.todo",
|
||||||
|
]
|
||||||
|
|
||||||
|
# TODO: Please Read!
|
||||||
|
# Uncomment the below if you use native CircuitPython modules such as
|
||||||
|
# digitalio, micropython and busio. List the modules you use. Without it, the
|
||||||
|
# autodoc module docs will fail to generate with a warning.
|
||||||
|
# autodoc_mock_imports = ["digitalio", "busio"]
|
||||||
|
|
||||||
|
|
||||||
|
intersphinx_mapping = {
|
||||||
|
"python": ("https://docs.python.org/3.4", None),"BusDevice": ("https://circuitpython.readthedocs.io/projects/busdevice/en/latest/", None),
|
||||||
|
|
||||||
|
"CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None),
|
||||||
|
}
|
||||||
|
|
||||||
|
# Show the docstring from both the class and its __init__() method.
|
||||||
|
autoclass_content = "both"
|
||||||
|
|
||||||
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
|
templates_path = ["_templates"]
|
||||||
|
|
||||||
|
source_suffix = ".rst"
|
||||||
|
|
||||||
|
# The master toctree document.
|
||||||
|
master_doc = "index"
|
||||||
|
|
||||||
|
# General information about the project.
|
||||||
|
project = "CircuitPython TrellisM4_extended Library"
|
||||||
|
copyright = "2021 Arofarn"
|
||||||
|
author = "Arofarn"
|
||||||
|
|
||||||
|
# The version info for the project you're documenting, acts as replacement for
|
||||||
|
# |version| and |release|, also used in various other places throughout the
|
||||||
|
# built documents.
|
||||||
|
#
|
||||||
|
# The short X.Y version.
|
||||||
|
version = "1.0"
|
||||||
|
# The full version, including alpha/beta/rc tags.
|
||||||
|
release = "1.0"
|
||||||
|
|
||||||
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
|
# for a list of supported languages.
|
||||||
|
#
|
||||||
|
# This is also used if you do content translation via gettext catalogs.
|
||||||
|
# Usually you set "language" from the command line for these cases.
|
||||||
|
language = None
|
||||||
|
|
||||||
|
# List of patterns, relative to source directory, that match files and
|
||||||
|
# directories to ignore when looking for source files.
|
||||||
|
# This patterns also effect to html_static_path and html_extra_path
|
||||||
|
exclude_patterns = [
|
||||||
|
"_build",
|
||||||
|
"Thumbs.db",
|
||||||
|
".DS_Store",
|
||||||
|
".env",
|
||||||
|
"CODE_OF_CONDUCT.md",
|
||||||
|
]
|
||||||
|
|
||||||
|
# The reST default role (used for this markup: `text`) to use for all
|
||||||
|
# documents.
|
||||||
|
#
|
||||||
|
default_role = "any"
|
||||||
|
|
||||||
|
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||||
|
#
|
||||||
|
add_function_parentheses = True
|
||||||
|
|
||||||
|
# The name of the Pygments (syntax highlighting) style to use.
|
||||||
|
pygments_style = "sphinx"
|
||||||
|
|
||||||
|
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
||||||
|
todo_include_todos = False
|
||||||
|
|
||||||
|
# If this is True, todo emits a warning for each TODO entries. The default is False.
|
||||||
|
todo_emit_warnings = True
|
||||||
|
|
||||||
|
napoleon_numpy_docstring = False
|
||||||
|
|
||||||
|
# -- Options for HTML output ----------------------------------------------
|
||||||
|
|
||||||
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||||
|
# a list of builtin themes.
|
||||||
|
#
|
||||||
|
on_rtd = os.environ.get("READTHEDOCS", None) == "True"
|
||||||
|
|
||||||
|
if not on_rtd: # only import and set the theme if we're building docs locally
|
||||||
|
try:
|
||||||
|
import sphinx_rtd_theme
|
||||||
|
|
||||||
|
html_theme = "sphinx_rtd_theme"
|
||||||
|
html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
|
||||||
|
except:
|
||||||
|
html_theme = "default"
|
||||||
|
html_theme_path = ["."]
|
||||||
|
else:
|
||||||
|
html_theme_path = ["."]
|
||||||
|
|
||||||
|
# Add any paths that contain custom static files (such as style sheets) here,
|
||||||
|
# relative to this directory. They are copied after the builtin static files,
|
||||||
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||||
|
html_static_path = ["_static"]
|
||||||
|
|
||||||
|
# The name of an image file (relative to this directory) to use as a favicon of
|
||||||
|
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
|
||||||
|
# pixels large.
|
||||||
|
#
|
||||||
|
html_favicon = "_static/favicon.ico"
|
||||||
|
|
||||||
|
# Output file base name for HTML help builder.
|
||||||
|
htmlhelp_basename = "CircuitPython_Trellism4_extended_Librarydoc"
|
||||||
|
|
||||||
|
# -- Options for LaTeX output ---------------------------------------------
|
||||||
|
|
||||||
|
latex_elements = {
|
||||||
|
# The paper size ('letterpaper' or 'a4paper').
|
||||||
|
# 'papersize': 'letterpaper',
|
||||||
|
# The font size ('10pt', '11pt' or '12pt').
|
||||||
|
# 'pointsize': '10pt',
|
||||||
|
# Additional stuff for the LaTeX preamble.
|
||||||
|
# 'preamble': '',
|
||||||
|
# Latex figure (float) alignment
|
||||||
|
# 'figure_align': 'htbp',
|
||||||
|
}
|
||||||
|
|
||||||
|
# Grouping the document tree into LaTeX files. List of tuples
|
||||||
|
# (source start file, target name, title,
|
||||||
|
# author, documentclass [howto, manual, or own class]).
|
||||||
|
latex_documents = [
|
||||||
|
(
|
||||||
|
master_doc,
|
||||||
|
"CircuitPython_TrellisM4_extended_Library.tex",
|
||||||
|
"CircuitPython TrellisM4_extended Library Documentation",
|
||||||
|
author,
|
||||||
|
"manual",
|
||||||
|
),
|
||||||
|
]
|
||||||
|
|
||||||
|
# -- Options for manual page output ---------------------------------------
|
||||||
|
|
||||||
|
# One entry per manual page. List of tuples
|
||||||
|
# (source start file, name, description, authors, manual section).
|
||||||
|
man_pages = [
|
||||||
|
(
|
||||||
|
master_doc,
|
||||||
|
"CircuitPython_TrellisM4_extended_Library",
|
||||||
|
"CircuitPython TrellisM4_extended Library Documentation",
|
||||||
|
[author],
|
||||||
|
1,
|
||||||
|
),
|
||||||
|
]
|
||||||
|
|
||||||
|
# -- Options for Texinfo output -------------------------------------------
|
||||||
|
|
||||||
|
# Grouping the document tree into Texinfo files. List of tuples
|
||||||
|
# (source start file, target name, title, author,
|
||||||
|
# dir menu entry, description, category)
|
||||||
|
texinfo_documents = [
|
||||||
|
(
|
||||||
|
master_doc,
|
||||||
|
"CircuitPython_TrellisM4_extended_Library",
|
||||||
|
"CircuitPython TrellisM4_extended Library Documentation",
|
||||||
|
author,
|
||||||
|
"CircuitPython_TrellisM4_extended_Library",
|
||||||
|
"One line description of project.",
|
||||||
|
"Miscellaneous",
|
||||||
|
),
|
||||||
|
]
|
8
docs/examples.rst
Normal file
8
docs/examples.rst
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
Simple test
|
||||||
|
------------
|
||||||
|
|
||||||
|
Ensure your device works with this simple test.
|
||||||
|
|
||||||
|
.. literalinclude:: ../examples/trellism4_extended_simpletest.py
|
||||||
|
:caption: examples/trellism4_extended_simpletest.py
|
||||||
|
:linenos:
|
4
docs/examples.rst.license
Normal file
4
docs/examples.rst.license
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
|
||||||
|
SPDX-FileCopyrightText: Copyright (c) 2021 Arofarn
|
||||||
|
|
||||||
|
SPDX-License-Identifier: MIT
|
52
docs/index.rst
Normal file
52
docs/index.rst
Normal file
@ -0,0 +1,52 @@
|
|||||||
|
|
||||||
|
.. include:: ../README.rst
|
||||||
|
|
||||||
|
Table of Contents
|
||||||
|
=================
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 4
|
||||||
|
:hidden:
|
||||||
|
|
||||||
|
self
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:caption: Examples
|
||||||
|
|
||||||
|
examples
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:caption: API Reference
|
||||||
|
:maxdepth: 3
|
||||||
|
|
||||||
|
api
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:caption: Tutorials
|
||||||
|
|
||||||
|
.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave
|
||||||
|
the toctree above for use later.
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:caption: Related Products
|
||||||
|
|
||||||
|
.. todo:: Add any product links here. If there are none, then simply delete this todo and leave
|
||||||
|
the toctree above for use later.
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:caption: Other Links
|
||||||
|
|
||||||
|
Download <https://github.com/arofarn/CircuitPython_TrellisM4_extended/releases/latest>
|
||||||
|
CircuitPython Reference Documentation <https://circuitpython.readthedocs.io>
|
||||||
|
CircuitPython Support Forum <https://forums.adafruit.com/viewforum.php?f=60>
|
||||||
|
Discord Chat <https://adafru.it/discord>
|
||||||
|
Adafruit Learning System <https://learn.adafruit.com>
|
||||||
|
Adafruit Blog <https://blog.adafruit.com>
|
||||||
|
Adafruit Store <https://www.adafruit.com>
|
||||||
|
|
||||||
|
Indices and tables
|
||||||
|
==================
|
||||||
|
|
||||||
|
* :ref:`genindex`
|
||||||
|
* :ref:`modindex`
|
||||||
|
* :ref:`search`
|
4
docs/index.rst.license
Normal file
4
docs/index.rst.license
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
|
||||||
|
SPDX-FileCopyrightText: Copyright (c) 2021 Arofarn
|
||||||
|
|
||||||
|
SPDX-License-Identifier: MIT
|
4
examples/trellism4_extended_simpletest.py
Normal file
4
examples/trellism4_extended_simpletest.py
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
|
||||||
|
# SPDX-FileCopyrightText: Copyright (c) 2021 Arofarn
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: Unlicense
|
6
pyproject.toml
Normal file
6
pyproject.toml
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: Unlicense
|
||||||
|
|
||||||
|
[tool.black]
|
||||||
|
target-version = ['py35']
|
9
requirements.txt
Normal file
9
requirements.txt
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
|
||||||
|
# SPDX-FileCopyrightText: Copyright (c) 2021 Arofarn
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
Adafruit-Blinka
|
||||||
|
adafruit-circuitpython-busdevice
|
||||||
|
adafruit_seesaw
|
||||||
|
adafruit_matrixkeypad
|
8
requirements.txt~
Normal file
8
requirements.txt~
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
|
||||||
|
# SPDX-FileCopyrightText: Copyright (c) 2021 Arofarn
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
Adafruit-Blinka
|
||||||
|
adafruit-circuitpython-busdevice
|
||||||
|
adafruit_seesaw
|
9
setup.py.disabled
Normal file
9
setup.py.disabled
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
|
||||||
|
# SPDX-FileCopyrightText: Copyright (c) 2021 Arofarn
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
"""
|
||||||
|
This library is not deployed to PyPI. It is either a board-specific helper library, or
|
||||||
|
does not make sense for use on or is incompatible with single board computers and Linux.
|
||||||
|
"""
|
282
trellism4_extended.py
Normal file
282
trellism4_extended.py
Normal file
@ -0,0 +1,282 @@
|
|||||||
|
# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
|
||||||
|
# SPDX-FileCopyrightText: Copyright (c) 2021 Arofarn
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
"""
|
||||||
|
`trellism4_extended`
|
||||||
|
================================================================================
|
||||||
|
|
||||||
|
CircuitPython library to extended Adafruit NeotrellisM4 board with two Neotrellis seesaw boards (or more !).
|
||||||
|
|
||||||
|
|
||||||
|
* Author(s): arofarn
|
||||||
|
|
||||||
|
Implementation Notes
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
**Hardware:**
|
||||||
|
|
||||||
|
* Adafruit NeoTrellis M4 Express: https://www.adafruit.com/product/3938
|
||||||
|
* Adafruit NeoTrellis RGB Driver PCB for 4x4 Keypad :https://www.adafruit.com/product/3954
|
||||||
|
|
||||||
|
**Software and Dependencies:**
|
||||||
|
|
||||||
|
* Adafruit CircuitPython firmware for the supported boards:
|
||||||
|
https://github.com/adafruit/circuitpython/releases
|
||||||
|
* Adafruit CircuitPython bus_devices library (from Adafruit_CircuitPython_Bundle):
|
||||||
|
https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
# imports
|
||||||
|
|
||||||
|
__version__ = "0.0.0-auto.0"
|
||||||
|
__repo__ = "https://github.com/arofarn/CircuitPython_TrellisM4_extended.git"
|
||||||
|
|
||||||
|
|
||||||
|
import board
|
||||||
|
import digitalio
|
||||||
|
from micropython import const
|
||||||
|
from adafruit_seesaw.keypad import KeyEvent
|
||||||
|
from adafruit_matrixkeypad import Matrix_Keypad
|
||||||
|
from neopixel import NeoPixel
|
||||||
|
|
||||||
|
|
||||||
|
_NEO_TRELLIS_NUM_ROWS = const(4)
|
||||||
|
_NEO_TRELLIS_NUM_COLS = const(4)
|
||||||
|
_NEO_TRELLIS_NUM_KEYS = const(16)
|
||||||
|
|
||||||
|
# _NEO_TRELLIS_MAX_CALLBACKS = const(32)
|
||||||
|
|
||||||
|
_TRELLISM4_LEFT_PART = const(0)
|
||||||
|
_TRELLISM4_RIGHT_PART = const(4)
|
||||||
|
|
||||||
|
|
||||||
|
def _key(xval):
|
||||||
|
return int(int(xval/4)*8 + (xval%4))
|
||||||
|
|
||||||
|
def _seesaw_key(xval):
|
||||||
|
return int(int(xval/8)*4 + (xval%8))
|
||||||
|
|
||||||
|
def _to_seesaw_key(xval):
|
||||||
|
return int(xval + (xval // 4) * 4)
|
||||||
|
|
||||||
|
|
||||||
|
class _TrellisNeoPixel:
|
||||||
|
"""Neopixel driver
|
||||||
|
"""
|
||||||
|
# Lots of stuff come from Adafruit_CircuitPython_seesaw/neopixel.py
|
||||||
|
|
||||||
|
def __init__(self, auto_write=True, brightness=1.0,
|
||||||
|
part=_TRELLISM4_LEFT_PART, left_part=None):
|
||||||
|
if part == _TRELLISM4_LEFT_PART:
|
||||||
|
self.pix = NeoPixel(board.NEOPIXEL, 32, auto_write=False, brightness=brightness)
|
||||||
|
elif part == _TRELLISM4_RIGHT_PART:
|
||||||
|
self.pix = left_part.pix
|
||||||
|
self.auto_write = auto_write
|
||||||
|
self._offset = part
|
||||||
|
|
||||||
|
def __setitem__(self, key, color):
|
||||||
|
self.pix[_key(key) + self._offset] = color
|
||||||
|
if self.auto_write:
|
||||||
|
self.show()
|
||||||
|
|
||||||
|
def __getitem__(self, key):
|
||||||
|
return self.pix[_key(key) + self._offset]
|
||||||
|
|
||||||
|
def fill(self, color):
|
||||||
|
"""Fill method wrapper
|
||||||
|
"""
|
||||||
|
# Suppress auto_write while filling.
|
||||||
|
current_auto_write = self.auto_write
|
||||||
|
self.auto_write = False
|
||||||
|
for i in range(16):
|
||||||
|
self[i] = color
|
||||||
|
if current_auto_write:
|
||||||
|
self.show()
|
||||||
|
self.auto_write = current_auto_write
|
||||||
|
|
||||||
|
def show(self):
|
||||||
|
"""Fill method wrapper
|
||||||
|
"""
|
||||||
|
self.pix.show()
|
||||||
|
|
||||||
|
|
||||||
|
class _TrellisKeypad:
|
||||||
|
"""Simple Keypad object for Trellis M4
|
||||||
|
No pixel, no rotation
|
||||||
|
Key numbers : 0 - 15"""
|
||||||
|
|
||||||
|
def __init__(self, part=_TRELLISM4_LEFT_PART, row_pins=None):
|
||||||
|
self._offset = part
|
||||||
|
col_pins = []
|
||||||
|
for x in range(self._offset, self._offset + _NEO_TRELLIS_NUM_COLS):
|
||||||
|
col_pin = digitalio.DigitalInOut(getattr(board, "COL{}".format(x)))
|
||||||
|
col_pins.append(col_pin)
|
||||||
|
|
||||||
|
if part == _TRELLISM4_LEFT_PART:
|
||||||
|
self.row_pins = []
|
||||||
|
for y in range(_NEO_TRELLIS_NUM_ROWS):
|
||||||
|
row_pin = digitalio.DigitalInOut(getattr(board, "ROW{}".format(y)))
|
||||||
|
self.row_pins.append(row_pin)
|
||||||
|
elif part == _TRELLISM4_RIGHT_PART:
|
||||||
|
if row_pins is None:
|
||||||
|
raise ValueError("Missing row_pins list for the right part")
|
||||||
|
self.row_pins = row_pins
|
||||||
|
else:
|
||||||
|
raise ValueError("part arg should be 0 (left part) or 4 (right part)")
|
||||||
|
|
||||||
|
key_names = []
|
||||||
|
for y in range(4):
|
||||||
|
row = []
|
||||||
|
for x in range(4):
|
||||||
|
row.append(4 * x + y)
|
||||||
|
key_names.append(row) # Keys of each halves is numbered from 0-15
|
||||||
|
|
||||||
|
self._matrix = Matrix_Keypad(col_pins, self.row_pins, key_names)
|
||||||
|
|
||||||
|
@property
|
||||||
|
def pressed_keys(self):
|
||||||
|
"""A list of tuples of currently pressed button coordinates.
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
import time
|
||||||
|
import adafruit_trellism4
|
||||||
|
|
||||||
|
trellis = adafruit_trellism4.TrellisM4Express()
|
||||||
|
|
||||||
|
current_press = set()
|
||||||
|
while True:
|
||||||
|
pressed = set(trellis.pressed_keys)
|
||||||
|
for press in pressed - current_press:
|
||||||
|
print("Pressed:", press)
|
||||||
|
for release in current_press - pressed:
|
||||||
|
print("Released:", release)
|
||||||
|
time.sleep(0.08)
|
||||||
|
current_press = pressed
|
||||||
|
"""
|
||||||
|
return self._matrix.pressed_keys
|
||||||
|
|
||||||
|
|
||||||
|
class NeoTrellisM4:
|
||||||
|
"""Driver for the Adafruit NeoTrellis."""
|
||||||
|
|
||||||
|
EDGE_HIGH = const(0)
|
||||||
|
EDGE_LOW = const(1)
|
||||||
|
EDGE_FALLING = const(2)
|
||||||
|
EDGE_RISING = const(3)
|
||||||
|
|
||||||
|
def __init__(self, left_part=None):
|
||||||
|
if left_part is None:
|
||||||
|
self._offset = _TRELLISM4_LEFT_PART
|
||||||
|
self.pixels = _TrellisNeoPixel()
|
||||||
|
self.keypad = _TrellisKeypad()
|
||||||
|
else:
|
||||||
|
self._offset = _TRELLISM4_RIGHT_PART
|
||||||
|
self.pixels = _TrellisNeoPixel(32,
|
||||||
|
part=_TRELLISM4_RIGHT_PART,
|
||||||
|
left_part=left_part.pixels)
|
||||||
|
self.keypad = _TrellisKeypad(part=_TRELLISM4_RIGHT_PART,
|
||||||
|
row_pins=left_part.keypad.row_pins)
|
||||||
|
|
||||||
|
self._events = [0] * _NEO_TRELLIS_NUM_KEYS
|
||||||
|
self._current_press = set()
|
||||||
|
self._key_edges = [self.EDGE_HIGH] * _NEO_TRELLIS_NUM_KEYS # Keys edges
|
||||||
|
self._current_events = bytearray()
|
||||||
|
self.callbacks = [None] * 16
|
||||||
|
|
||||||
|
@property
|
||||||
|
def interrupt_enabled(self):
|
||||||
|
"""Only for compatibility with neotrellis module
|
||||||
|
interrupts are disable on trellis M4 keypad"""
|
||||||
|
return False
|
||||||
|
|
||||||
|
# pylint: disable=unused-argument, no-self-use
|
||||||
|
@interrupt_enabled.setter
|
||||||
|
def interrupt_enabled(self, value):
|
||||||
|
"""Only for compatibility with neotrellis module
|
||||||
|
interrupts are disable on trellis M4 keypad
|
||||||
|
"""
|
||||||
|
print("Warning: no interrupt with Trellis M4 keypad (method does nothing)")
|
||||||
|
# pylint: enable=unused-argument, no-self-use
|
||||||
|
|
||||||
|
@property
|
||||||
|
def count(self):
|
||||||
|
"""Return the pressed keys count
|
||||||
|
"""
|
||||||
|
self._read_keypad()
|
||||||
|
return len(self._current_events)
|
||||||
|
|
||||||
|
# pylint: disable=unused-argument, no-self-use
|
||||||
|
@count.setter
|
||||||
|
def count(self, value):
|
||||||
|
"""Only for compatibility with neotrellis module
|
||||||
|
"""
|
||||||
|
raise AttributeError("count is read only")
|
||||||
|
# pylint: enable=unused-argument, no-self-use
|
||||||
|
|
||||||
|
def set_event(self, key, edge, enable):
|
||||||
|
"""Set event on a key
|
||||||
|
"""
|
||||||
|
if enable not in (True, False):
|
||||||
|
raise ValueError("event enable must be True or False")
|
||||||
|
if edge > 3 or edge < 0:
|
||||||
|
raise ValueError("invalid edge")
|
||||||
|
|
||||||
|
# Pas besoin de l'écriture sur I2C mais de l'enregistrer dans self._events
|
||||||
|
if enable:
|
||||||
|
self._events[key] = self._events[key] | (1 << edge)
|
||||||
|
else:
|
||||||
|
self._events[key] = self._events[key] & (0xF ^ (1 << edge))
|
||||||
|
|
||||||
|
def read_keypad(self, num):
|
||||||
|
"""Give the n events in the keypad buffer
|
||||||
|
"""
|
||||||
|
while num > len(self._current_events):
|
||||||
|
self._current_events.append(0xFF)
|
||||||
|
return self._current_events[:num]
|
||||||
|
|
||||||
|
def _read_keypad(self):
|
||||||
|
"""Read keypad and update _key_edges and _current_events"""
|
||||||
|
pressed = set(self.keypad.pressed_keys)
|
||||||
|
#default : not pressed => EDGE_HIGH
|
||||||
|
self._key_edges = [self.EDGE_HIGH] * _NEO_TRELLIS_NUM_KEYS
|
||||||
|
for k in pressed:
|
||||||
|
self._key_edges[k] = self.EDGE_LOW
|
||||||
|
for k in pressed - self._current_press:
|
||||||
|
self._key_edges[k] = self.EDGE_RISING
|
||||||
|
for k in self._current_press - pressed:
|
||||||
|
self._key_edges[k] = self.EDGE_FALLING
|
||||||
|
|
||||||
|
self._current_press = pressed
|
||||||
|
self._current_events = bytearray()
|
||||||
|
|
||||||
|
for k in range(_NEO_TRELLIS_NUM_KEYS):
|
||||||
|
if (self._events[k] >> self._key_edges[k]) & 0x1:
|
||||||
|
raw_evt = (_to_seesaw_key(k) << 2) | self._key_edges[k]
|
||||||
|
self._current_events.append(raw_evt)
|
||||||
|
|
||||||
|
|
||||||
|
def activate_key(self, key, edge, enable=True):
|
||||||
|
"""Activate or deactivate a key on the trellis. Key is the key number from
|
||||||
|
0 to 15. Edge specifies what edge to register an event on and can be
|
||||||
|
NeoTrellis.EDGE_FALLING or NeoTrellis.EDGE_RISING. enable should be set
|
||||||
|
to True if the event is to be enabled, or False if the event is to be
|
||||||
|
disabled.
|
||||||
|
"""
|
||||||
|
self.set_event(key, edge, enable)
|
||||||
|
|
||||||
|
|
||||||
|
def sync(self):
|
||||||
|
"""Read any events from the Trellis hardware and call associated
|
||||||
|
callbacks
|
||||||
|
"""
|
||||||
|
available = self.count
|
||||||
|
if available > 0:
|
||||||
|
available = available + 2
|
||||||
|
buf = self.read_keypad(available)
|
||||||
|
for raw in buf:
|
||||||
|
evt = KeyEvent(_seesaw_key((raw >> 2) & 0x3F), raw & 0x3)
|
||||||
|
if evt.number < _NEO_TRELLIS_NUM_KEYS and self.callbacks[evt.number] is not None:
|
||||||
|
self.callbacks[evt.number](evt)
|
282
trellism4_extended.py~
Normal file
282
trellism4_extended.py~
Normal file
@ -0,0 +1,282 @@
|
|||||||
|
# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
|
||||||
|
# SPDX-FileCopyrightText: Copyright (c) 2021 Arofarn
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: MIT
|
||||||
|
"""
|
||||||
|
`trellism4_extended`
|
||||||
|
================================================================================
|
||||||
|
|
||||||
|
CircuitPython library to extended Adafruit NeotrellisM4 board with two Neotrellis seesaw boards (or more !).
|
||||||
|
|
||||||
|
|
||||||
|
* Author(s): arofarn
|
||||||
|
|
||||||
|
Implementation Notes
|
||||||
|
--------------------
|
||||||
|
|
||||||
|
**Hardware:**
|
||||||
|
|
||||||
|
* Adafruit NeoTrellis M4 Express: https://www.adafruit.com/product/3938
|
||||||
|
* Adafruit NeoTrellis RGB Driver PCB for 4x4 Keypad :https://www.adafruit.com/product/3954
|
||||||
|
|
||||||
|
**Software and Dependencies:**
|
||||||
|
|
||||||
|
* Adafruit CircuitPython firmware for the supported boards:
|
||||||
|
https://github.com/adafruit/circuitpython/releases
|
||||||
|
* Adafruit CircuitPython bus_devices library (from Adafruit_CircuitPython_Bundle):
|
||||||
|
https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
# imports
|
||||||
|
|
||||||
|
__version__ = "0.0.0-auto.0"
|
||||||
|
__repo__ = "https://github.com/arofarn/CircuitPython_TrellisM4_extended.git"
|
||||||
|
|
||||||
|
|
||||||
|
import board
|
||||||
|
import digitalio
|
||||||
|
from micropython import const
|
||||||
|
from adafruit_seesaw.keypad import KeyEvent
|
||||||
|
from adafruit_matrixkeypad import Matrix_Keypad
|
||||||
|
from neopixel import NeoPixel
|
||||||
|
|
||||||
|
|
||||||
|
_NEO_TRELLIS_NUM_ROWS = const(4)
|
||||||
|
_NEO_TRELLIS_NUM_COLS = const(4)
|
||||||
|
_NEO_TRELLIS_NUM_KEYS = const(16)
|
||||||
|
|
||||||
|
# _NEO_TRELLIS_MAX_CALLBACKS = const(32)
|
||||||
|
|
||||||
|
_TRELLISM4_LEFT_PART = const(0)
|
||||||
|
_TRELLISM4_RIGHT_PART = const(4)
|
||||||
|
|
||||||
|
|
||||||
|
def _key(xval):
|
||||||
|
return int(int(xval/4)*8 + (xval%4))
|
||||||
|
|
||||||
|
def _seesaw_key(xval):
|
||||||
|
return int(int(xval/8)*4 + (xval%8))
|
||||||
|
|
||||||
|
def _to_seesaw_key(xval):
|
||||||
|
return int(xval + (xval // 4) * 4)
|
||||||
|
|
||||||
|
|
||||||
|
class _TrellisNeoPixel:
|
||||||
|
"""Neopixel driver
|
||||||
|
"""
|
||||||
|
# Lots of stuff come from Adafruit_CircuitPython_seesaw/neopixel.py
|
||||||
|
|
||||||
|
def __init__(self, auto_write=True, brightness=1.0,
|
||||||
|
part=_TRELLISM4_LEFT_PART, left_part=None):
|
||||||
|
if part == _TRELLISM4_LEFT_PART:
|
||||||
|
self.pix = NeoPixel(board.NEOPIXEL, 32, auto_write=False, brightness=brightness)
|
||||||
|
elif part == _TRELLISM4_RIGHT_PART:
|
||||||
|
self.pix = left_part.pix
|
||||||
|
self.auto_write = auto_write
|
||||||
|
self._offset = part
|
||||||
|
|
||||||
|
def __setitem__(self, key, color):
|
||||||
|
self.pix[_key(key) + self._offset] = color
|
||||||
|
if self.auto_write:
|
||||||
|
self.show()
|
||||||
|
|
||||||
|
def __getitem__(self, key):
|
||||||
|
return self.pix[_key(key) + self._offset]
|
||||||
|
|
||||||
|
def fill(self, color):
|
||||||
|
"""Fill method wrapper
|
||||||
|
"""
|
||||||
|
# Suppress auto_write while filling.
|
||||||
|
current_auto_write = self.auto_write
|
||||||
|
self.auto_write = False
|
||||||
|
for i in range(16):
|
||||||
|
self[i] = color
|
||||||
|
if current_auto_write:
|
||||||
|
self.show()
|
||||||
|
self.auto_write = current_auto_write
|
||||||
|
|
||||||
|
def show(self):
|
||||||
|
"""Fill method wrapper
|
||||||
|
"""
|
||||||
|
self.pix.show()
|
||||||
|
|
||||||
|
|
||||||
|
class _TrellisKeypad:
|
||||||
|
"""Simple Keypad object for Trellis M4
|
||||||
|
No pixel, no rotation
|
||||||
|
Key numbers : 0 - 15"""
|
||||||
|
|
||||||
|
def __init__(self, part=_TRELLISM4_LEFT_PART, row_pins=None):
|
||||||
|
self._offset = part
|
||||||
|
col_pins = []
|
||||||
|
for x in range(self._offset, self._offset + _NEO_TRELLIS_NUM_COLS):
|
||||||
|
col_pin = digitalio.DigitalInOut(getattr(board, "COL{}".format(x)))
|
||||||
|
col_pins.append(col_pin)
|
||||||
|
|
||||||
|
if part == _TRELLISM4_LEFT_PART:
|
||||||
|
self.row_pins = []
|
||||||
|
for y in range(_NEO_TRELLIS_NUM_ROWS):
|
||||||
|
row_pin = digitalio.DigitalInOut(getattr(board, "ROW{}".format(y)))
|
||||||
|
self.row_pins.append(row_pin)
|
||||||
|
elif part == _TRELLISM4_RIGHT_PART:
|
||||||
|
if row_pins is None:
|
||||||
|
raise ValueError("Missing row_pins list for the right part")
|
||||||
|
self.row_pins = row_pins
|
||||||
|
else:
|
||||||
|
raise ValueError("part arg should be 0 (left part) or 4 (right part)")
|
||||||
|
|
||||||
|
key_names = []
|
||||||
|
for y in range(4):
|
||||||
|
row = []
|
||||||
|
for x in range(4):
|
||||||
|
row.append(4 * x + y)
|
||||||
|
key_names.append(row) # Keys of each halves is numbered from 0-15
|
||||||
|
|
||||||
|
self._matrix = Matrix_Keypad(col_pins, self.row_pins, key_names)
|
||||||
|
|
||||||
|
@property
|
||||||
|
def pressed_keys(self):
|
||||||
|
"""A list of tuples of currently pressed button coordinates.
|
||||||
|
|
||||||
|
.. code-block:: python
|
||||||
|
|
||||||
|
import time
|
||||||
|
import adafruit_trellism4
|
||||||
|
|
||||||
|
trellis = adafruit_trellism4.TrellisM4Express()
|
||||||
|
|
||||||
|
current_press = set()
|
||||||
|
while True:
|
||||||
|
pressed = set(trellis.pressed_keys)
|
||||||
|
for press in pressed - current_press:
|
||||||
|
print("Pressed:", press)
|
||||||
|
for release in current_press - pressed:
|
||||||
|
print("Released:", release)
|
||||||
|
time.sleep(0.08)
|
||||||
|
current_press = pressed
|
||||||
|
"""
|
||||||
|
return self._matrix.pressed_keys
|
||||||
|
|
||||||
|
|
||||||
|
class NeoTrellisM4:
|
||||||
|
"""Driver for the Adafruit NeoTrellis."""
|
||||||
|
|
||||||
|
EDGE_HIGH = const(0)
|
||||||
|
EDGE_LOW = const(1)
|
||||||
|
EDGE_FALLING = const(2)
|
||||||
|
EDGE_RISING = const(3)
|
||||||
|
|
||||||
|
def __init__(self, left_part=None):
|
||||||
|
if left_part is None:
|
||||||
|
self._offset = _TRELLISM4_LEFT_PART
|
||||||
|
self.pixels = _TrellisNeoPixel()
|
||||||
|
self.keypad = _TrellisKeypad()
|
||||||
|
else:
|
||||||
|
self._offset = _TRELLISM4_RIGHT_PART
|
||||||
|
self.pixels = _TrellisNeoPixel(32,
|
||||||
|
part=_TRELLISM4_RIGHT_PART,
|
||||||
|
left_part=left_part.pixels)
|
||||||
|
self.keypad = _TrellisKeypad(part=_TRELLISM4_RIGHT_PART,
|
||||||
|
row_pins=left_part.keypad.row_pins)
|
||||||
|
|
||||||
|
self._events = [0] * _NEO_TRELLIS_NUM_KEYS
|
||||||
|
self._current_press = set()
|
||||||
|
self._key_edges = [self.EDGE_HIGH] * _NEO_TRELLIS_NUM_KEYS # Keys edges
|
||||||
|
self._current_events = bytearray()
|
||||||
|
self.callbacks = [None] * 16
|
||||||
|
|
||||||
|
@property
|
||||||
|
def interrupt_enabled(self):
|
||||||
|
"""Only for compatibility with neotrellis module
|
||||||
|
interrupts are disable on trellis M4 keypad"""
|
||||||
|
return False
|
||||||
|
|
||||||
|
# pylint: disable=unused-argument, no-self-use
|
||||||
|
@interrupt_enabled.setter
|
||||||
|
def interrupt_enabled(self, value):
|
||||||
|
"""Only for compatibility with neotrellis module
|
||||||
|
interrupts are disable on trellis M4 keypad
|
||||||
|
"""
|
||||||
|
print("Warning: no interrupt with Trellis M4 keypad (method does nothing)")
|
||||||
|
# pylint: enable=unused-argument, no-self-use
|
||||||
|
|
||||||
|
@property
|
||||||
|
def count(self):
|
||||||
|
"""Return the pressed keys count
|
||||||
|
"""
|
||||||
|
self._read_keypad()
|
||||||
|
return len(self._current_events)
|
||||||
|
|
||||||
|
# pylint: disable=unused-argument, no-self-use
|
||||||
|
@count.setter
|
||||||
|
def count(self, value):
|
||||||
|
"""Only for compatibility with neotrellis module
|
||||||
|
"""
|
||||||
|
raise AttributeError("count is read only")
|
||||||
|
# pylint: enable=unused-argument, no-self-use
|
||||||
|
|
||||||
|
def set_event(self, key, edge, enable):
|
||||||
|
"""Set event on a key
|
||||||
|
"""
|
||||||
|
if enable not in (True, False):
|
||||||
|
raise ValueError("event enable must be True or False")
|
||||||
|
if edge > 3 or edge < 0:
|
||||||
|
raise ValueError("invalid edge")
|
||||||
|
|
||||||
|
# Pas besoin de l'écriture sur I2C mais de l'enregistrer dans self._events
|
||||||
|
if enable:
|
||||||
|
self._events[key] = self._events[key] | (1 << edge)
|
||||||
|
else:
|
||||||
|
self._events[key] = self._events[key] & (0xF ^ (1 << edge))
|
||||||
|
|
||||||
|
def read_keypad(self, num):
|
||||||
|
"""Give the n events in the keypad buffer
|
||||||
|
"""
|
||||||
|
while num > len(self._current_events):
|
||||||
|
self._current_events.append(0xFF)
|
||||||
|
return self._current_events[:num]
|
||||||
|
|
||||||
|
def _read_keypad(self):
|
||||||
|
"""Read keypad and update _key_edges and _current_events"""
|
||||||
|
pressed = set(self.keypad.pressed_keys)
|
||||||
|
#default : not pressed => EDGE_HIGH
|
||||||
|
self._key_edges = [self.EDGE_HIGH] * _NEO_TRELLIS_NUM_KEYS
|
||||||
|
for k in pressed:
|
||||||
|
self._key_edges[k] = self.EDGE_LOW
|
||||||
|
for k in pressed - self._current_press:
|
||||||
|
self._key_edges[k] = self.EDGE_RISING
|
||||||
|
for k in self._current_press - pressed:
|
||||||
|
self._key_edges[k] = self.EDGE_FALLING
|
||||||
|
|
||||||
|
self._current_press = pressed
|
||||||
|
self._current_events = bytearray()
|
||||||
|
|
||||||
|
for k in range(_NEO_TRELLIS_NUM_KEYS):
|
||||||
|
if (self._events[k] >> self._key_edges[k]) & 0x1:
|
||||||
|
raw_evt = (_to_seesaw_key(k) << 2) | self._key_edges[k]
|
||||||
|
self._current_events.append(raw_evt)
|
||||||
|
|
||||||
|
|
||||||
|
def activate_key(self, key, edge, enable=True):
|
||||||
|
"""Activate or deactivate a key on the trellis. Key is the key number from
|
||||||
|
0 to 15. Edge specifies what edge to register an event on and can be
|
||||||
|
NeoTrellis.EDGE_FALLING or NeoTrellis.EDGE_RISING. enable should be set
|
||||||
|
to True if the event is to be enabled, or False if the event is to be
|
||||||
|
disabled.
|
||||||
|
"""
|
||||||
|
self.set_event(key, edge, enable)
|
||||||
|
|
||||||
|
|
||||||
|
def sync(self):
|
||||||
|
"""Read any events from the Trellis hardware and call associated
|
||||||
|
callbacks
|
||||||
|
"""
|
||||||
|
available = self.count
|
||||||
|
if available > 0:
|
||||||
|
available = available + 2
|
||||||
|
buf = self.read_keypad(available)
|
||||||
|
for raw in buf:
|
||||||
|
evt = KeyEvent(_seesaw_key((raw >> 2) & 0x3F), raw & 0x3)
|
||||||
|
if evt.number < _NEO_TRELLIS_NUM_KEYS and self.callbacks[evt.number] is not None:
|
||||||
|
self.callbacks[evt.number](evt)
|
Loading…
Reference in New Issue
Block a user