diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..21c125c --- /dev/null +++ b/.gitattributes @@ -0,0 +1,11 @@ +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +.py text eol=lf +.rst text eol=lf +.txt text eol=lf +.yaml text eol=lf +.toml text eol=lf +.license text eol=lf +.md text eol=lf diff --git a/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md new file mode 100644 index 0000000..8de294e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md @@ -0,0 +1,13 @@ +# SPDX-FileCopyrightText: 2021 Adafruit Industries +# +# SPDX-License-Identifier: MIT + +Thank you for contributing! Before you submit a pull request, please read the following. + +Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://docs.circuitpython.org/en/latest/docs/design_guide.html + +If your changes are to documentation, please verify that the documentation builds locally by following the steps found here: https://adafru.it/build-docs + +Before submitting the pull request, make sure you've run Pylint and Black locally on your code. You can do this manually or using pre-commit. Instructions are available here: https://adafru.it/check-your-code + +Please remove all of this text before submitting. Include an explanation or list of changes included in your PR, as well as, if applicable, a link to any related issues. diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index b6977a9..041a337 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + name: Build CI on: [pull_request, push] @@ -6,52 +10,5 @@ jobs: test: runs-on: ubuntu-latest steps: - - name: Dump GitHub context - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - run: echo "$GITHUB_CONTEXT" - - name: Translate Repo Name For Build Tools filename_prefix - id: repo-name - run: | - echo ::set-output name=repo-name::$( - echo ${{ github.repository }} | - awk -F '\/' '{ print tolower($2) }' | - tr '_' '-' - ) - - name: Set up Python 3.6 - uses: actions/setup-python@v1 - with: - python-version: 3.6 - - name: Versions - run: | - python3 --version - - name: Checkout Current Repo - uses: actions/checkout@v1 - with: - submodules: true - - name: Checkout tools repo - uses: actions/checkout@v2 - with: - repository: adafruit/actions-ci-circuitpython-libs - path: actions-ci - - name: Install dependencies - # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.) - run: | - source actions-ci/install.sh - - name: Pip install pylint, black, & Sphinx - run: | - pip install --force-reinstall pylint black==19.10b0 Sphinx sphinx-rtd-theme - - name: Library version - run: git describe --dirty --always --tags - - name: Check formatting - run: | - black --check --target-version=py35 . - - name: PyLint - run: | - pylint $( find . -path './adafruit*.py' ) - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace $( find . -path "./examples/*.py" )) - - name: Build assets - run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - - name: Build docs - working-directory: docs - run: sphinx-build -E -W -b html . _build/html + - name: Run Build CI workflow + uses: adafruit/workflows-circuitpython-libs/build@main diff --git a/.github/workflows/failure-help-text.yml b/.github/workflows/failure-help-text.yml new file mode 100644 index 0000000..0b1194f --- /dev/null +++ b/.github/workflows/failure-help-text.yml @@ -0,0 +1,19 @@ +# SPDX-FileCopyrightText: 2021 Scott Shawcroft for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: Failure help text + +on: + workflow_run: + workflows: ["Build CI"] + types: + - completed + +jobs: + post-help: + runs-on: ubuntu-latest + if: ${{ github.event.workflow_run.conclusion == 'failure' && github.event.workflow_run.event == 'pull_request' }} + steps: + - name: Post comment to help + uses: adafruit/circuitpython-action-library-ci-failed@v1 diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index 18efb9c..0000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,81 +0,0 @@ -name: Release Actions - -on: - release: - types: [published] - -jobs: - upload-release-assets: - runs-on: ubuntu-latest - steps: - - name: Dump GitHub context - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - run: echo "$GITHUB_CONTEXT" - - name: Translate Repo Name For Build Tools filename_prefix - id: repo-name - run: | - echo ::set-output name=repo-name::$( - echo ${{ github.repository }} | - awk -F '\/' '{ print tolower($2) }' | - tr '_' '-' - ) - - name: Set up Python 3.6 - uses: actions/setup-python@v1 - with: - python-version: 3.6 - - name: Versions - run: | - python3 --version - - name: Checkout Current Repo - uses: actions/checkout@v1 - with: - submodules: true - - name: Checkout tools repo - uses: actions/checkout@v2 - with: - repository: adafruit/actions-ci-circuitpython-libs - path: actions-ci - - name: Install deps - run: | - source actions-ci/install.sh - - name: Build assets - run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - - name: Upload Release Assets - # the 'official' actions version does not yet support dynamically - # supplying asset names to upload. @csexton's version chosen based on - # discussion in the issue below, as its the simplest to implement and - # allows for selecting files with a pattern. - # https://github.com/actions/upload-release-asset/issues/4 - #uses: actions/upload-release-asset@v1.0.1 - uses: csexton/release-asset-action@master - with: - pattern: "bundles/*" - github-token: ${{ secrets.GITHUB_TOKEN }} - - upload-pypi: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v1 - - name: Check For setup.py - id: need-pypi - run: | - echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) - - name: Set up Python - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - uses: actions/setup-python@v1 - with: - python-version: '3.x' - - name: Install dependencies - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - run: | - python -m pip install --upgrade pip - pip install setuptools wheel twine - - name: Build and publish - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - env: - TWINE_USERNAME: ${{ secrets.pypi_username }} - TWINE_PASSWORD: ${{ secrets.pypi_password }} - run: | - python setup.py sdist - twine upload dist/* diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml new file mode 100644 index 0000000..9acec60 --- /dev/null +++ b/.github/workflows/release_gh.yml @@ -0,0 +1,19 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: GitHub Release Actions + +on: + release: + types: [published] + +jobs: + upload-release-assets: + runs-on: ubuntu-latest + steps: + - name: Run GitHub Release CI workflow + uses: adafruit/workflows-circuitpython-libs/release-gh@main + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + upload-url: ${{ github.event.release.upload_url }} diff --git a/.github/workflows/release_pypi.yml b/.github/workflows/release_pypi.yml new file mode 100644 index 0000000..65775b7 --- /dev/null +++ b/.github/workflows/release_pypi.yml @@ -0,0 +1,19 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: PyPI Release Actions + +on: + release: + types: [published] + +jobs: + upload-release-assets: + runs-on: ubuntu-latest + steps: + - name: Run PyPI Release CI workflow + uses: adafruit/workflows-circuitpython-libs/release-pypi@main + with: + pypi-username: ${{ secrets.pypi_username }} + pypi-password: ${{ secrets.pypi_password }} diff --git a/.gitignore b/.gitignore index 1be1c4b..db3d538 100644 --- a/.gitignore +++ b/.gitignore @@ -1,11 +1,48 @@ +# SPDX-FileCopyrightText: 2022 Kattni Rembor, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +# Do not include files and directories created by your personal work environment, such as the IDE +# you use, except for those already listed here. Pull requests including changes to this file will +# not be accepted. + +# This .gitignore file contains rules for files generated by working with CircuitPython libraries, +# including building Sphinx, testing with pip, and creating a virual environment, as well as the +# MacOS and IDE-specific files generated by using MacOS in general, or the PyCharm or VSCode IDEs. + +# If you find that there are files being generated on your machine that should not be included in +# your git commit, you should create a .gitignore_global file on your computer to include the +# files created by your personal setup. To do so, follow the two steps below. + +# First, create a file called .gitignore_global somewhere convenient for you, and add rules for +# the files you want to exclude from git commits. + +# Second, configure Git to use the exclude file for all Git repositories by running the +# following via commandline, replacing "path/to/your/" with the actual path to your newly created +# .gitignore_global file: +# git config --global core.excludesfile path/to/your/.gitignore_global + +# CircuitPython-specific files *.mpy -.idea + +# Python-specific files __pycache__ -_build *.pyc + +# Sphinx build-specific files +_build + +# This file results from running `pip -e install .` in a local repository +*.egg-info + +# Virtual environment-specific files .env -bundles +.venv + +# MacOS-specific files *.DS_Store -.eggs -dist -**/*.egg-info + +# IDE-specific files +.idea +.vscode +*~ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..ff19dde --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,21 @@ +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.5.0 + hooks: + - id: check-yaml + - id: end-of-file-fixer + - id: trailing-whitespace + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.3.4 + hooks: + - id: ruff-format + - id: ruff + args: ["--fix"] + - repo: https://github.com/fsfe/reuse-tool + rev: v3.0.1 + hooks: + - id: reuse diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index d8f0ee8..0000000 --- a/.pylintrc +++ /dev/null @@ -1,433 +0,0 @@ -[MASTER] - -# A comma-separated list of package or module names from where C extensions may -# be loaded. Extensions are loading into the active Python interpreter and may -# run arbitrary code -extension-pkg-whitelist= - -# Add files or directories to the blacklist. They should be base names, not -# paths. -ignore=CVS - -# Add files or directories matching the regex patterns to the blacklist. The -# regex matches against base names, not paths. -ignore-patterns= - -# Python code to execute, usually for sys.path manipulation such as -# pygtk.require(). -#init-hook= - -# Use multiple processes to speed up Pylint. -# jobs=1 -jobs=2 - -# List of plugins (as comma separated values of python modules names) to load, -# usually to register additional checkers. -load-plugins= - -# Pickle collected data for later comparisons. -persistent=yes - -# Specify a configuration file. -#rcfile= - -# Allow loading of arbitrary C extensions. Extensions are imported into the -# active Python interpreter and may run arbitrary code. -unsafe-load-any-extension=no - - -[MESSAGES CONTROL] - -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED -confidence= - -# Disable the message, report, category or checker with the given id(s). You -# can either give multiple identifiers separated by comma (,) or put this -# option multiple times (only on the command line, not in the configuration -# file where it should appear only once).You can also use "--disable=all" to -# disable everything first and then reenable specific checks. For example, if -# you want to run only the similarities checker, you can use "--disable=all -# --enable=similarities". If you want to run only the classes checker, but have -# no Warning level messages displayed, use"--disable=all --enable=classes -# --disable=W" -# disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call -disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation - -# Enable the message, report, category or checker with the given id(s). You can -# either give multiple identifier separated by comma (,) or put this option -# multiple time (only on the command line, not in the configuration file where -# it should appear only once). See also the "--disable" option for examples. -enable= - - -[REPORTS] - -# Python expression which should return a note less than 10 (10 is the highest -# note). You have access to the variables errors warning, statement which -# respectively contain the number of errors / warnings messages and the total -# number of statements analyzed. This is used by the global evaluation report -# (RP0004). -evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) - -# Template used to display messages. This is a python new-style format string -# used to format the message information. See doc for all details -#msg-template= - -# Set the output format. Available formats are text, parseable, colorized, json -# and msvs (visual studio).You can also give a reporter class, eg -# mypackage.mymodule.MyReporterClass. -output-format=text - -# Tells whether to display a full report or only the messages -reports=no - -# Activate the evaluation score. -score=yes - - -[REFACTORING] - -# Maximum number of nested blocks for function / method body -max-nested-blocks=5 - - -[LOGGING] - -# Logging modules to check that the string format arguments are in logging -# function parameter format -logging-modules=logging - - -[SPELLING] - -# Spelling dictionary name. Available dictionaries: none. To make it working -# install python-enchant package. -spelling-dict= - -# List of comma separated words that should not be checked. -spelling-ignore-words= - -# A path to a file that contains private dictionary; one word per line. -spelling-private-dict-file= - -# Tells whether to store unknown words to indicated private dictionary in -# --spelling-private-dict-file option instead of raising a message. -spelling-store-unknown-words=no - - -[MISCELLANEOUS] - -# List of note tags to take in consideration, separated by a comma. -# notes=FIXME,XXX,TODO -notes=FIXME,XXX - - -[TYPECHECK] - -# List of decorators that produce context managers, such as -# contextlib.contextmanager. Add to this list to register other decorators that -# produce valid context managers. -contextmanager-decorators=contextlib.contextmanager - -# List of members which are set dynamically and missed by pylint inference -# system, and so shouldn't trigger E1101 when accessed. Python regular -# expressions are accepted. -generated-members= - -# Tells whether missing members accessed in mixin class should be ignored. A -# mixin class is detected if its name ends with "mixin" (case insensitive). -ignore-mixin-members=yes - -# This flag controls whether pylint should warn about no-member and similar -# checks whenever an opaque object is returned when inferring. The inference -# can return multiple potential results while evaluating a Python object, but -# some branches might not be evaluated, which results in partial inference. In -# that case, it might be useful to still emit no-member and other checks for -# the rest of the inferred objects. -ignore-on-opaque-inference=yes - -# List of class names for which member attributes should not be checked (useful -# for classes with dynamically set attributes). This supports the use of -# qualified names. -ignored-classes=optparse.Values,thread._local,_thread._local - -# List of module names for which member attributes should not be checked -# (useful for modules/projects where namespaces are manipulated during runtime -# and thus existing member attributes cannot be deduced by static analysis. It -# supports qualified module names, as well as Unix pattern matching. -ignored-modules=board - -# Show a hint with possible names when a member name was not found. The aspect -# of finding the hint is based on edit distance. -missing-member-hint=yes - -# The minimum edit distance a name should have in order to be considered a -# similar match for a missing member name. -missing-member-hint-distance=1 - -# The total number of similar names that should be taken in consideration when -# showing a hint for a missing member. -missing-member-max-choices=1 - - -[VARIABLES] - -# List of additional names supposed to be defined in builtins. Remember that -# you should avoid to define new builtins when possible. -additional-builtins= - -# Tells whether unused global variables should be treated as a violation. -allow-global-unused-variables=yes - -# List of strings which can identify a callback function by name. A callback -# name must start or end with one of those strings. -callbacks=cb_,_cb - -# A regular expression matching the name of dummy variables (i.e. expectedly -# not used). -dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ - -# Argument names that match this expression will be ignored. Default to name -# with leading underscore -ignored-argument-names=_.*|^ignored_|^unused_ - -# Tells whether we should check for unused import in __init__ files. -init-import=no - -# List of qualified module names which can have objects that can redefine -# builtins. -redefining-builtins-modules=six.moves,future.builtins - - -[FORMAT] - -# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. -# expected-line-ending-format= -expected-line-ending-format=LF - -# Regexp for a line that is allowed to be longer than the limit. -ignore-long-lines=^\s*(# )??$ - -# Number of spaces of indent required inside a hanging or continued line. -indent-after-paren=4 - -# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 -# tab). -indent-string=' ' - -# Maximum number of characters on a single line. -max-line-length=100 - -# Maximum number of lines in a module -max-module-lines=1000 - -# List of optional constructs for which whitespace checking is disabled. `dict- -# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. -# `trailing-comma` allows a space between comma and closing bracket: (a, ). -# `empty-line` allows space-only lines. -no-space-check=trailing-comma,dict-separator - -# Allow the body of a class to be on the same line as the declaration if body -# contains single statement. -single-line-class-stmt=no - -# Allow the body of an if to be on the same line as the test if there is no -# else. -single-line-if-stmt=no - - -[SIMILARITIES] - -# Ignore comments when computing similarities. -ignore-comments=yes - -# Ignore docstrings when computing similarities. -ignore-docstrings=yes - -# Ignore imports when computing similarities. -ignore-imports=no - -# Minimum lines number of a similarity. -min-similarity-lines=4 - - -[BASIC] - -# Naming hint for argument names -argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct argument names -argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Naming hint for attribute names -attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct attribute names -attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Bad variable names which should always be refused, separated by a comma -bad-names=foo,bar,baz,toto,tutu,tata - -# Naming hint for class attribute names -class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Regular expression matching correct class attribute names -class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Naming hint for class names -# class-name-hint=[A-Z_][a-zA-Z0-9]+$ -class-name-hint=[A-Z_][a-zA-Z0-9_]+$ - -# Regular expression matching correct class names -# class-rgx=[A-Z_][a-zA-Z0-9]+$ -class-rgx=[A-Z_][a-zA-Z0-9_]+$ - -# Naming hint for constant names -const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - -# Regular expression matching correct constant names -const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - -# Minimum line length for functions/classes that require docstrings, shorter -# ones are exempt. -docstring-min-length=-1 - -# Naming hint for function names -function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct function names -function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Good variable names which should always be accepted, separated by a comma -# good-names=i,j,k,ex,Run,_ -good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ - -# Include a hint for the correct naming format with invalid-name -include-naming-hint=no - -# Naming hint for inline iteration names -inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ - -# Regular expression matching correct inline iteration names -inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ - -# Naming hint for method names -method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct method names -method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Naming hint for module names -module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ - -# Regular expression matching correct module names -module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ - -# Colon-delimited sets of names that determine each other's naming style when -# the name regexes allow several styles. -name-group= - -# Regular expression which should only match function or class names that do -# not require a docstring. -no-docstring-rgx=^_ - -# List of decorators that produce properties, such as abc.abstractproperty. Add -# to this list to register other decorators that produce valid properties. -property-classes=abc.abstractproperty - -# Naming hint for variable names -variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - -# Regular expression matching correct variable names -variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - - -[IMPORTS] - -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no - -# Analyse import fallback blocks. This can be used to support both Python 2 and -# 3 compatible code, which means that the block might have code that exists -# only in one or another interpreter, leading to false positives when analysed. -analyse-fallback-blocks=no - -# Deprecated modules which should not be used, separated by a comma -deprecated-modules=optparse,tkinter.tix - -# Create a graph of external dependencies in the given file (report RP0402 must -# not be disabled) -ext-import-graph= - -# Create a graph of every (i.e. internal and external) dependencies in the -# given file (report RP0402 must not be disabled) -import-graph= - -# Create a graph of internal dependencies in the given file (report RP0402 must -# not be disabled) -int-import-graph= - -# Force import order to recognize a module as part of the standard -# compatibility libraries. -known-standard-library= - -# Force import order to recognize a module as part of a third party library. -known-third-party=enchant - - -[CLASSES] - -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__,__new__,setUp - -# List of member names, which should be excluded from the protected access -# warning. -exclude-protected=_asdict,_fields,_replace,_source,_make - -# List of valid names for the first argument in a class method. -valid-classmethod-first-arg=cls - -# List of valid names for the first argument in a metaclass class method. -valid-metaclass-classmethod-first-arg=mcs - - -[DESIGN] - -# Maximum number of arguments for function / method -max-args=5 - -# Maximum number of attributes for a class (see R0902). -# max-attributes=7 -max-attributes=11 - -# Maximum number of boolean expressions in a if statement -max-bool-expr=5 - -# Maximum number of branch for function / method body -max-branches=12 - -# Maximum number of locals for function / method body -max-locals=15 - -# Maximum number of parents for a class (see R0901). -max-parents=7 - -# Maximum number of public methods for a class (see R0904). -max-public-methods=20 - -# Maximum number of return / yield for function / method body -max-returns=6 - -# Maximum number of statements in function / method body -max-statements=50 - -# Minimum number of public methods for a class (see R0903). -min-public-methods=1 - - -[EXCEPTIONS] - -# Exceptions that will emit a warning when being caught. Defaults to -# "Exception" -overgeneral-exceptions=Exception diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..88bca9f --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,22 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +sphinx: + configuration: docs/conf.py + +build: + os: ubuntu-20.04 + tools: + python: "3" + +python: + install: + - requirements: docs/requirements.txt + - requirements: requirements.txt diff --git a/.readthedocs.yml b/.readthedocs.yml deleted file mode 100644 index f4243ad..0000000 --- a/.readthedocs.yml +++ /dev/null @@ -1,3 +0,0 @@ -python: - version: 3 -requirements_file: requirements.txt diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 134d510..8a55c07 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,3 +1,9 @@ + + # Adafruit Community Code of Conduct ## Our Pledge @@ -43,7 +49,7 @@ Examples of unacceptable behavior by participants include: The goal of the standards and moderation guidelines outlined here is to build and maintain a respectful community. We ask that you don’t just aim to be -"technically unimpeachable", but rather try to be your best self. +"technically unimpeachable", but rather try to be your best self. We value many things beyond technical expertise, including collaboration and supporting others within our community. Providing a positive experience for @@ -74,9 +80,9 @@ You may report in the following ways: In any situation, you may send an email to . On the Adafruit Discord, you may send an open message from any channel -to all Community Moderators by tagging @community moderators. You may -also send an open message from any channel, or a direct message to -@kattni#1507, @tannewt#4653, @Dan Halbert#1614, @cater#2442, +to all Community Moderators by tagging @community moderators. You may +also send an open message from any channel, or a direct message to +@kattni#1507, @tannewt#4653, @Dan Halbert#1614, @cater#2442, @sommersoft#0222, @Mr. Certainly#0472 or @Andon#8175. Email and direct message reports will be kept confidential. diff --git a/LICENSES/CC-BY-4.0.txt b/LICENSES/CC-BY-4.0.txt new file mode 100644 index 0000000..3f92dfc --- /dev/null +++ b/LICENSES/CC-BY-4.0.txt @@ -0,0 +1,324 @@ +Creative Commons Attribution 4.0 International Creative Commons Corporation +("Creative Commons") is not a law firm and does not provide legal services +or legal advice. Distribution of Creative Commons public licenses does not +create a lawyer-client or other relationship. Creative Commons makes its licenses +and related information available on an "as-is" basis. Creative Commons gives +no warranties regarding its licenses, any material licensed under their terms +and conditions, or any related information. Creative Commons disclaims all +liability for damages resulting from their use to the fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and conditions +that creators and other rights holders may use to share original works of +authorship and other material subject to copyright and certain other rights +specified in the public license below. The following considerations are for +informational purposes only, are not exhaustive, and do not form part of our +licenses. + +Considerations for licensors: Our public licenses are intended for use by +those authorized to give the public permission to use material in ways otherwise +restricted by copyright and certain other rights. Our licenses are irrevocable. +Licensors should read and understand the terms and conditions of the license +they choose before applying it. Licensors should also secure all rights necessary +before applying our licenses so that the public can reuse the material as +expected. Licensors should clearly mark any material not subject to the license. +This includes other CC-licensed material, or material used under an exception +or limitation to copyright. More considerations for licensors : wiki.creativecommons.org/Considerations_for_licensors + +Considerations for the public: By using one of our public licenses, a licensor +grants the public permission to use the licensed material under specified +terms and conditions. If the licensor's permission is not necessary for any +reason–for example, because of any applicable exception or limitation to copyright–then +that use is not regulated by the license. Our licenses grant only permissions +under copyright and certain other rights that a licensor has authority to +grant. Use of the licensed material may still be restricted for other reasons, +including because others have copyright or other rights in the material. A +licensor may make special requests, such as asking that all changes be marked +or described. Although not required by our licenses, you are encouraged to +respect those requests where reasonable. More considerations for the public +: wiki.creativecommons.org/Considerations_for_licensees Creative Commons Attribution +4.0 International Public License + +By exercising the Licensed Rights (defined below), You accept and agree to +be bound by the terms and conditions of this Creative Commons Attribution +4.0 International Public License ("Public License"). To the extent this Public +License may be interpreted as a contract, You are granted the Licensed Rights +in consideration of Your acceptance of these terms and conditions, and the +Licensor grants You such rights in consideration of benefits the Licensor +receives from making the Licensed Material available under these terms and +conditions. + +Section 1 – Definitions. + +a. Adapted Material means material subject to Copyright and Similar Rights +that is derived from or based upon the Licensed Material and in which the +Licensed Material is translated, altered, arranged, transformed, or otherwise +modified in a manner requiring permission under the Copyright and Similar +Rights held by the Licensor. For purposes of this Public License, where the +Licensed Material is a musical work, performance, or sound recording, Adapted +Material is always produced where the Licensed Material is synched in timed +relation with a moving image. + +b. Adapter's License means the license You apply to Your Copyright and Similar +Rights in Your contributions to Adapted Material in accordance with the terms +and conditions of this Public License. + +c. Copyright and Similar Rights means copyright and/or similar rights closely +related to copyright including, without limitation, performance, broadcast, +sound recording, and Sui Generis Database Rights, without regard to how the +rights are labeled or categorized. For purposes of this Public License, the +rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights. + +d. Effective Technological Measures means those measures that, in the absence +of proper authority, may not be circumvented under laws fulfilling obligations +under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, +and/or similar international agreements. + +e. Exceptions and Limitations means fair use, fair dealing, and/or any other +exception or limitation to Copyright and Similar Rights that applies to Your +use of the Licensed Material. + +f. Licensed Material means the artistic or literary work, database, or other +material to which the Licensor applied this Public License. + +g. Licensed Rights means the rights granted to You subject to the terms and +conditions of this Public License, which are limited to all Copyright and +Similar Rights that apply to Your use of the Licensed Material and that the +Licensor has authority to license. + +h. Licensor means the individual(s) or entity(ies) granting rights under this +Public License. + +i. Share means to provide material to the public by any means or process that +requires permission under the Licensed Rights, such as reproduction, public +display, public performance, distribution, dissemination, communication, or +importation, and to make material available to the public including in ways +that members of the public may access the material from a place and at a time +individually chosen by them. + +j. Sui Generis Database Rights means rights other than copyright resulting +from Directive 96/9/EC of the European Parliament and of the Council of 11 +March 1996 on the legal protection of databases, as amended and/or succeeded, +as well as other essentially equivalent rights anywhere in the world. + +k. You means the individual or entity exercising the Licensed Rights under +this Public License. Your has a corresponding meaning. + +Section 2 – Scope. + + a. License grant. + +1. Subject to the terms and conditions of this Public License, the Licensor +hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, +irrevocable license to exercise the Licensed Rights in the Licensed Material +to: + + A. reproduce and Share the Licensed Material, in whole or in part; and + + B. produce, reproduce, and Share Adapted Material. + +2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions +and Limitations apply to Your use, this Public License does not apply, and +You do not need to comply with its terms and conditions. + + 3. Term. The term of this Public License is specified in Section 6(a). + +4. Media and formats; technical modifications allowed. The Licensor authorizes +You to exercise the Licensed Rights in all media and formats whether now known +or hereafter created, and to make technical modifications necessary to do +so. The Licensor waives and/or agrees not to assert any right or authority +to forbid You from making technical modifications necessary to exercise the +Licensed Rights, including technical modifications necessary to circumvent +Effective Technological Measures. For purposes of this Public License, simply +making modifications authorized by this Section 2(a)(4) never produces Adapted +Material. + + 5. Downstream recipients. + +A. Offer from the Licensor – Licensed Material. Every recipient of the Licensed +Material automatically receives an offer from the Licensor to exercise the +Licensed Rights under the terms and conditions of this Public License. + +B. No downstream restrictions. You may not offer or impose any additional +or different terms or conditions on, or apply any Effective Technological +Measures to, the Licensed Material if doing so restricts exercise of the Licensed +Rights by any recipient of the Licensed Material. + +6. No endorsement. Nothing in this Public License constitutes or may be construed +as permission to assert or imply that You are, or that Your use of the Licensed +Material is, connected with, or sponsored, endorsed, or granted official status +by, the Licensor or others designated to receive attribution as provided in +Section 3(a)(1)(A)(i). + + b. Other rights. + +1. Moral rights, such as the right of integrity, are not licensed under this +Public License, nor are publicity, privacy, and/or other similar personality +rights; however, to the extent possible, the Licensor waives and/or agrees +not to assert any such rights held by the Licensor to the limited extent necessary +to allow You to exercise the Licensed Rights, but not otherwise. + +2. Patent and trademark rights are not licensed under this Public License. + +3. To the extent possible, the Licensor waives any right to collect royalties +from You for the exercise of the Licensed Rights, whether directly or through +a collecting society under any voluntary or waivable statutory or compulsory +licensing scheme. In all other cases the Licensor expressly reserves any right +to collect such royalties. + +Section 3 – License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the following +conditions. + + a. Attribution. + +1. If You Share the Licensed Material (including in modified form), You must: + +A. retain the following if it is supplied by the Licensor with the Licensed +Material: + +i. identification of the creator(s) of the Licensed Material and any others +designated to receive attribution, in any reasonable manner requested by the +Licensor (including by pseudonym if designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of warranties; + +v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable; + +B. indicate if You modified the Licensed Material and retain an indication +of any previous modifications; and + +C. indicate the Licensed Material is licensed under this Public License, and +include the text of, or the URI or hyperlink to, this Public License. + +2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner +based on the medium, means, and context in which You Share the Licensed Material. +For example, it may be reasonable to satisfy the conditions by providing a +URI or hyperlink to a resource that includes the required information. + +3. If requested by the Licensor, You must remove any of the information required +by Section 3(a)(1)(A) to the extent reasonably practicable. + +4. If You Share Adapted Material You produce, the Adapter's License You apply +must not prevent recipients of the Adapted Material from complying with this +Public License. + +Section 4 – Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that apply to +Your use of the Licensed Material: + +a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, +reuse, reproduce, and Share all or a substantial portion of the contents of +the database; + +b. if You include all or a substantial portion of the database contents in +a database in which You have Sui Generis Database Rights, then the database +in which You have Sui Generis Database Rights (but not its individual contents) +is Adapted Material; and + +c. You must comply with the conditions in Section 3(a) if You Share all or +a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not replace +Your obligations under this Public License where the Licensed Rights include +other Copyright and Similar Rights. + +Section 5 – Disclaimer of Warranties and Limitation of Liability. + +a. Unless otherwise separately undertaken by the Licensor, to the extent possible, +the Licensor offers the Licensed Material as-is and as-available, and makes +no representations or warranties of any kind concerning the Licensed Material, +whether express, implied, statutory, or other. This includes, without limitation, +warranties of title, merchantability, fitness for a particular purpose, non-infringement, +absence of latent or other defects, accuracy, or the presence or absence of +errors, whether or not known or discoverable. Where disclaimers of warranties +are not allowed in full or in part, this disclaimer may not apply to You. + +b. To the extent possible, in no event will the Licensor be liable to You +on any legal theory (including, without limitation, negligence) or otherwise +for any direct, special, indirect, incidental, consequential, punitive, exemplary, +or other losses, costs, expenses, or damages arising out of this Public License +or use of the Licensed Material, even if the Licensor has been advised of +the possibility of such losses, costs, expenses, or damages. Where a limitation +of liability is not allowed in full or in part, this limitation may not apply +to You. + +c. The disclaimer of warranties and limitation of liability provided above +shall be interpreted in a manner that, to the extent possible, most closely +approximates an absolute disclaimer and waiver of all liability. + +Section 6 – Term and Termination. + +a. This Public License applies for the term of the Copyright and Similar Rights +licensed here. However, if You fail to comply with this Public License, then +Your rights under this Public License terminate automatically. + +b. Where Your right to use the Licensed Material has terminated under Section +6(a), it reinstates: + +1. automatically as of the date the violation is cured, provided it is cured +within 30 days of Your discovery of the violation; or + + 2. upon express reinstatement by the Licensor. + +c. For the avoidance of doubt, this Section 6(b) does not affect any right +the Licensor may have to seek remedies for Your violations of this Public +License. + +d. For the avoidance of doubt, the Licensor may also offer the Licensed Material +under separate terms or conditions or stop distributing the Licensed Material +at any time; however, doing so will not terminate this Public License. + + e. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. + +Section 7 – Other Terms and Conditions. + +a. The Licensor shall not be bound by any additional or different terms or +conditions communicated by You unless expressly agreed. + +b. Any arrangements, understandings, or agreements regarding the Licensed +Material not stated herein are separate from and independent of the terms +and conditions of this Public License. + +Section 8 – Interpretation. + +a. For the avoidance of doubt, this Public License does not, and shall not +be interpreted to, reduce, limit, restrict, or impose conditions on any use +of the Licensed Material that could lawfully be made without permission under +this Public License. + +b. To the extent possible, if any provision of this Public License is deemed +unenforceable, it shall be automatically reformed to the minimum extent necessary +to make it enforceable. If the provision cannot be reformed, it shall be severed +from this Public License without affecting the enforceability of the remaining +terms and conditions. + +c. No term or condition of this Public License will be waived and no failure +to comply consented to unless expressly agreed to by the Licensor. + +d. Nothing in this Public License constitutes or may be interpreted as a limitation +upon, or waiver of, any privileges and immunities that apply to the Licensor +or You, including from the legal processes of any jurisdiction or authority. + +Creative Commons is not a party to its public licenses. Notwithstanding, Creative +Commons may elect to apply one of its public licenses to material it publishes +and in those instances will be considered the "Licensor." The text of the +Creative Commons public licenses is dedicated to the public domain under the +CC0 Public Domain Dedication. Except for the limited purpose of indicating +that material is shared under a Creative Commons public license or as otherwise +permitted by the Creative Commons policies published at creativecommons.org/policies, +Creative Commons does not authorize the use of the trademark "Creative Commons" +or any other trademark or logo of Creative Commons without its prior written +consent including, without limitation, in connection with any unauthorized +modifications to any of its public licenses or any other arrangements, understandings, +or agreements concerning use of licensed material. For the avoidance of doubt, +this paragraph does not form part of the public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/LICENSES/MIT.txt b/LICENSES/MIT.txt new file mode 100644 index 0000000..204b93d --- /dev/null +++ b/LICENSES/MIT.txt @@ -0,0 +1,19 @@ +MIT License Copyright (c) + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is furnished +to do so, subject to the following conditions: + +The above copyright notice and this permission notice (including the next +paragraph) shall be included in all copies or substantial portions of the +Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS +OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, +WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF +OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/LICENSES/Unlicense.txt b/LICENSES/Unlicense.txt new file mode 100644 index 0000000..24a8f90 --- /dev/null +++ b/LICENSES/Unlicense.txt @@ -0,0 +1,20 @@ +This is free and unencumbered software released into the public domain. + +Anyone is free to copy, modify, publish, use, compile, sell, or distribute +this software, either in source code form or as a compiled binary, for any +purpose, commercial or non-commercial, and by any means. + +In jurisdictions that recognize copyright laws, the author or authors of this +software dedicate any and all copyright interest in the software to the public +domain. We make this dedication for the benefit of the public at large and +to the detriment of our heirs and successors. We intend this dedication to +be an overt act of relinquishment in perpetuity of all present and future +rights to this software under copyright law. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS +BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH +THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. For more information, +please refer to diff --git a/README.rst b/README.rst index 54e5bfb..fa72f68 100644 --- a/README.rst +++ b/README.rst @@ -2,17 +2,21 @@ Introduction ============ .. image:: https://readthedocs.org/projects/adafruit-circuitpython-st7789/badge/?version=latest - :target: https://circuitpython.readthedocs.io/projects/st7789/en/latest/ + :target: https://docs.circuitpython.org/projects/st7789/en/latest/ :alt: Documentation Status -.. image:: https://img.shields.io/discord/327254708534116352.svg - :target: https://discord.gg/nBQh6qu +.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg + :target: https://adafru.it/discord :alt: Discord .. image:: https://github.com/adafruit/Adafruit_CircuitPython_ST7789/workflows/Build%20CI/badge.svg :target: https://github.com/adafruit/Adafruit_CircuitPython_ST7789/actions/ :alt: Build Status +.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json + :target: https://github.com/astral-sh/ruff + :alt: Code Style: Ruff + displayio driver for ST7789 TFT-LCD displays. Dependencies @@ -32,8 +36,17 @@ Usage Example import board import displayio + # Starting in CircuitPython 9.x fourwire will be a seperate internal library + # rather than a component of the displayio library + try: + from fourwire import FourWire + except ImportError: + from displayio import FourWire + from adafruit_st7789 import ST7789 + displayio.release_displays() + spi = board.SPI() while not spi.try_lock(): pass @@ -42,14 +55,13 @@ Usage Example tft_cs = board.D5 tft_dc = board.D6 - displayio.release_displays() - display_bus = displayio.FourWire(spi, command=tft_dc, chip_select=tft_cs, reset=board.D9) + display_bus = FourWire(spi, command=tft_dc, chip_select=tft_cs, reset=board.D9) - display = ST7789(display_bus, width=240, height=240, rowstart=80) + display = ST7789(display_bus, width=240, height=240, rowstart=80, bgr=True, invert=True) # Make the display context - splash = displayio.Group(max_size=10) - display.show(splash) + splash = displayio.Group() + display.root_group = splash color_bitmap = displayio.Bitmap(240, 240, 1) color_palette = displayio.Palette(1) @@ -63,14 +75,16 @@ Usage Example while True: pass +Documentation +============= + +API documentation for this library can be found on `Read the Docs `_. + +For information on building library documentation, please check out `this guide `_. + Contributing ============ Contributions are welcome! Please read our `Code of Conduct -`_ +`_ before contributing to help this project stay welcoming. - -Documentation -============= - -For information on building library documentation, please check out `this guide `_. diff --git a/README.rst.license b/README.rst.license new file mode 100644 index 0000000..11cd75d --- /dev/null +++ b/README.rst.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries + +SPDX-License-Identifier: MIT diff --git a/adafruit_st7789.py b/adafruit_st7789.py index bb0e0e7..8c448c7 100755 --- a/adafruit_st7789.py +++ b/adafruit_st7789.py @@ -1,24 +1,7 @@ -# The MIT License (MIT) +# SPDX-FileCopyrightText: 2019 Melissa LeBlanc-Williams for Adafruit Industries # -# Copyright (c) 2019 Melissa LeBlanc-Williams for Adafruit Industries LLC -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in -# all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -# THE SOFTWARE. +# SPDX-License-Identifier: MIT + """ `adafruit_st7789` ==================================================== @@ -32,9 +15,24 @@ **Hardware:** -* Adafruit 1.54" 240x240 Wide Angle TFT LCD Display with MicroSD: +* Adafruit 1.3" 240x240 Wide Angle TFT LCD Display with MicroSD - ST7789: + https://www.adafruit.com/product/4313 + +* Adafruit 1.54" 240x240 Wide Angle TFT LCD Display with MicroSD - ST7789: https://www.adafruit.com/product/3787 +* Adafruit 1.14" 240x135 Color TFT Display + MicroSD Card Breakout - ST7789: + https://www.adafruit.com/product/4383 + +* Adafruit Mini PiTFT 1.3" - 240x240 TFT Add-on for Raspberry Pi: + https://www.adafruit.com/product/4484 + +* Adafruit 1.3" Color TFT Bonnet for Raspberry Pi - 240x240 TFT + Joystick Add-on + https://www.adafruit.com/product/4506 + +* Adafruit Mini PiTFT - 135x240 Color TFT Add-on for Raspberry Pi: + https://www.adafruit.com/product/4393 + **Software and Dependencies:** * Adafruit CircuitPython firmware for the supported boards: @@ -42,25 +40,43 @@ """ -import displayio +from busdisplay import BusDisplay -__version__ = "0.0.0-auto.0" +try: + from typing import Any + + from fourwire import FourWire +except ImportError: + pass +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_ST7789.git" _INIT_SEQUENCE = ( b"\x01\x80\x96" # _SWRESET and Delay 150ms - b"\x11\x80\xFF" # _SLPOUT and Delay 500ms - b"\x3A\x81\x55\x0A" # _COLMOD and Delay 10ms + b"\x11\x80\xff" # _SLPOUT and Delay 500ms + b"\x3a\x81\x55\x0a" # _COLMOD and Delay 10ms b"\x36\x01\x08" # _MADCTL - b"\x21\x80\x0A" # _INVON Hack and Delay 10ms - b"\x13\x80\x0A" # _NORON and Delay 10ms - b"\x36\x01\xC0" # _MADCTL - b"\x29\x80\xFF" # _DISPON and Delay 500ms + b"\x13\x80\x0a" # _NORON and Delay 10ms + b"\x29\x80\xff" # _DISPON and Delay 500ms ) + # pylint: disable=too-few-public-methods -class ST7789(displayio.Display): - """ST7789 driver""" +class ST7789(BusDisplay): + """ + ST7789 driver + + :param FourWire bus: bus that the display is connected to + :param bool bgr: (Optional) An extra init sequence to append (default=True) + :param bool invert: (Optional) Invert the colors (default=True) + """ - def __init__(self, bus, **kwargs): - super().__init__(bus, _INIT_SEQUENCE, **kwargs) + def __init__(self, bus: FourWire, *, bgr: bool = True, invert: bool = True, **kwargs: Any): + init_sequence = _INIT_SEQUENCE + if bgr: + init_sequence += b"\x36\x01\xc0" # _MADCTL Default rotation plus BGR encoding + else: + init_sequence += b"\x36\x01\xc8" # _MADCTL Default rotation plus RGB encoding + if invert: + init_sequence += b"\x21\x00" # _INVON + super().__init__(bus, init_sequence, **kwargs) diff --git a/docs/_static/favicon.ico.license b/docs/_static/favicon.ico.license new file mode 100644 index 0000000..86a3fbf --- /dev/null +++ b/docs/_static/favicon.ico.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2018 Phillip Torrone for Adafruit Industries + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/api.rst b/docs/api.rst index e4ad45a..6f6dc2e 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,5 +4,8 @@ .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py) .. use this format as the module name: "adafruit_foo.foo" +API Reference +############# + .. automodule:: adafruit_st7789 :members: diff --git a/docs/api.rst.license b/docs/api.rst.license new file mode 100644 index 0000000..9aae48d --- /dev/null +++ b/docs/api.rst.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT diff --git a/docs/conf.py b/docs/conf.py index e7696c8..fc396a0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,5 +1,8 @@ -# -*- coding: utf-8 -*- +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT +import datetime import os import sys @@ -12,6 +15,7 @@ # ones. extensions = [ "sphinx.ext.autodoc", + "sphinxcontrib.jquery", "sphinx.ext.intersphinx", "sphinx.ext.napoleon", "sphinx.ext.todo", @@ -22,11 +26,11 @@ # 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"] -autodoc_mock_imports = ["displayio"] +autodoc_mock_imports = ["busdisplay", "fourwire"] intersphinx_mapping = { - "python": ("https://docs.python.org/3.4", None), - "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None), + "python": ("https://docs.python.org/3", None), + "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None), } # Add any paths that contain templates here, relative to this directory. @@ -39,7 +43,12 @@ # General information about the project. project = "Adafruit ST7789 Library" -copyright = "2019 Melissa LeBlanc-Williams" +creation_year = "2019" +current_year = str(datetime.datetime.now().year) +year_duration = ( + current_year if current_year == creation_year else creation_year + " - " + current_year +) +copyright = year_duration + " Melissa LeBlanc-Williams" author = "Melissa LeBlanc-Williams" # The version info for the project you're documenting, acts as replacement for @@ -56,7 +65,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -88,19 +97,9 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -on_rtd = os.environ.get("READTHEDOCS", None) == "True" - -if not on_rtd: # only import and set the theme if we're building docs locally - try: - import sphinx_rtd_theme - - html_theme = "sphinx_rtd_theme" - html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] - except: - html_theme = "default" - html_theme_path = ["."] -else: - html_theme_path = ["."] +import sphinx_rtd_theme + +html_theme = "sphinx_rtd_theme" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, diff --git a/docs/examples.rst b/docs/examples.rst index f9a2c15..80de595 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -6,3 +6,83 @@ Ensure your device works with this simple test. .. literalinclude:: ../examples/st7789_simpletest.py :caption: examples/st7789_simpletest.py :linenos: + +240x135 +======= + +.. literalinclude:: ../examples/st7789_240x135_simpletest.py + :caption: examples/st7789_240x135_simpletest.py + :linenos: + +280x240 +======= + +.. literalinclude:: ../examples/st7789_280x240_simpletest.py + :caption: examples/st7789_280x240_simpletest.py + :linenos: + +320x240 +======= + +.. literalinclude:: ../examples/st7789_320x240_simpletest.py + :caption: examples/st7789_320x240_simpletest.py + :linenos: + +Product specific examples +------------------------- + +1.14" Mini PiTFT +================ + +.. literalinclude:: ../examples/st7789_240x135_pitft_simpletest.py + :caption: examples/st7789_240x135_pitft_simpletest.py + :linenos: + +1.3" TFT Bonnet +=============== + +.. literalinclude:: ../examples/st7789_240x240_bonnet_simpletest.py + :caption: examples/st7789_240x240_bonnet_simpletest.py + :linenos: + +1.3" PiTFT +========== + +.. literalinclude:: ../examples/st7789_240x240_pitft_simpletest.py + :caption: examples/st7789_240x240_pitft_simpletest.py + :linenos: + +Gizmo +===== + +.. literalinclude:: ../examples/st7789_tft_gizmo_simpletest.py + :caption: examples/st7789_tft_gizmo_simpletest.py + :linenos: + +Pimoroni Pico Display Pack +========================== + +.. literalinclude:: ../examples/st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py + :caption: examples/st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py + :linenos: + +Pimoroni Pico Explorer +====================== + +.. literalinclude:: ../examples/st7789_240x240_simpletest_Pimoroni_Pico_Explorer.py + :caption: examples/st7789_240x240_simpletest_Pimoroni_Pico_Explorer.py + :linenos: + +Pimoroni Pico Display Pack 2.0 +============================== + +.. literalinclude:: ../examples/st7789_320x240_simpletest_Pimoroni_Pico_Display_2_0.py + :caption: examples/st7789_320x240_simpletest_Pimoroni_Pico_Display_2_0.py + :linenos: + +Waveshare Pico LCD 1.3 +============================== + +.. literalinclude:: ../examples/st7789_240x240_simpletest_Waveshare_PicoLCD_1_3.py + :caption: examples/st7789_240x240_simpletest_Waveshare_PicoLCD_1_3.py + :linenos: diff --git a/docs/examples.rst.license b/docs/examples.rst.license new file mode 100644 index 0000000..9aae48d --- /dev/null +++ b/docs/examples.rst.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT diff --git a/docs/index.rst b/docs/index.rst index 24c0cf6..7ad488f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -26,13 +26,24 @@ Table of Contents .. toctree:: :caption: Related Products + Adafruit 1.3" 240x240 Wide Angle TFT LCD Display with MicroSD + Adafruit 1.54" 240x240 Wide Angle TFT LCD Display with MicroSD + Adafruit 1.14" 240x135 Color TFT Display + MicroSD Card Breakout + + Adafruit Mini PiTFT 1.3" - 240x240 TFT Add-on for Raspberry Pi + + Adafruit 1.3" Color TFT Bonnet for Raspberry Pi - 240x240 TFT + Joystick Add-on + + Adafruit Mini PiTFT - 135x240 Color TFT Add-on for Raspberry Pi + .. toctree:: :caption: Other Links - Download - CircuitPython Reference Documentation + Download from GitHub + Download Library Bundle + CircuitPython Reference Documentation CircuitPython Support Forum Discord Chat Adafruit Learning System diff --git a/docs/index.rst.license b/docs/index.rst.license new file mode 100644 index 0000000..9aae48d --- /dev/null +++ b/docs/index.rst.license @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2020 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..979f568 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,7 @@ +# SPDX-FileCopyrightText: 2021 Kattni Rembor for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +sphinx +sphinxcontrib-jquery +sphinx-rtd-theme diff --git a/examples/st7789_170x320_1.9_simpletest.py b/examples/st7789_170x320_1.9_simpletest.py new file mode 100644 index 0000000..6049755 --- /dev/null +++ b/examples/st7789_170x320_1.9_simpletest.py @@ -0,0 +1,65 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + +""" +This test will initialize the display using displayio and draw a solid green +background, a smaller purple rectangle, and some yellow text. +""" + +import board +import displayio +import terminalio +from adafruit_display_text import label +from fourwire import FourWire + +from adafruit_st7789 import ST7789 + +BORDER_WIDTH = 20 +TEXT_SCALE = 3 + +# Release any resources currently in use for the displays +displayio.release_displays() + +spi = board.SPI() +tft_cs = board.D5 +tft_dc = board.D6 +tft_rst = board.D9 + +display_bus = FourWire(spi, command=tft_dc, chip_select=tft_cs, reset=tft_rst) + +display = ST7789(display_bus, width=320, height=170, colstart=35, rotation=90) + +# Make the display context +splash = displayio.Group() +display.root_group = splash + +color_bitmap = displayio.Bitmap(display.width, display.height, 1) +color_palette = displayio.Palette(1) +color_palette[0] = 0x00FF00 # Bright Green +bg_sprite = displayio.TileGrid(color_bitmap, pixel_shader=color_palette, x=0, y=0) +splash.append(bg_sprite) + +# Draw a smaller inner rectangle +inner_bitmap = displayio.Bitmap( + display.width - (BORDER_WIDTH * 2), display.height - (BORDER_WIDTH * 2), 1 +) +inner_palette = displayio.Palette(1) +inner_palette[0] = 0xAA0088 # Purple +inner_sprite = displayio.TileGrid( + inner_bitmap, pixel_shader=inner_palette, x=BORDER_WIDTH, y=BORDER_WIDTH +) +splash.append(inner_sprite) + +# Draw a label +text_area = label.Label( + terminalio.FONT, + text="Hello World!", + color=0xFFFF00, + scale=TEXT_SCALE, + anchor_point=(0.5, 0.5), + anchored_position=(display.width // 2, display.height // 2), +) +splash.append(text_area) + +while True: + pass diff --git a/examples/st7789_172x320_1.47_simpletest.py b/examples/st7789_172x320_1.47_simpletest.py new file mode 100644 index 0000000..0a55c24 --- /dev/null +++ b/examples/st7789_172x320_1.47_simpletest.py @@ -0,0 +1,77 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + +""" +This test will initialize the display using displayio and draw a solid green +background, a smaller purple rectangle, and some yellow text. +""" + +import board +import displayio +import terminalio +from adafruit_display_text import label +from fourwire import FourWire + +from adafruit_st7789 import ST7789 + +BORDER_WIDTH = 28 +TEXT_SCALE = 3 + +# Release any resources currently in use for the displays +displayio.release_displays() + +# built-in, silkscreen labelled SPI bus +spi = board.SPI() +tft_cs = board.D5 +tft_dc = board.D6 +tft_rst = board.D9 + +# If using a Raspberry Pi Pico or Pico-w +# Uncomment the below code to use GP (General Purpose) pins +# instead of D (Digital) + +# import busio +# spi = busio.SPI(board.GP2, board.GP3, board.GP4) +# tft_cs = board.GP5 +# tft_dc = board.GP6 +# tft_rst = board.GP7 + +display_bus = FourWire(spi, command=tft_dc, chip_select=tft_cs, reset=tft_rst) + +display = ST7789(display_bus, width=320, height=172, colstart=34, rotation=270) + +# Make the display context +splash = displayio.Group() +display.root_group = splash + +color_bitmap = displayio.Bitmap(display.width, display.height, 1) +color_palette = displayio.Palette(1) +color_palette[0] = 0x00FF00 # Bright Green +bg_sprite = displayio.TileGrid(color_bitmap, pixel_shader=color_palette, x=0, y=0) +splash.append(bg_sprite) + +# Draw a smaller inner rectangle +inner_bitmap = displayio.Bitmap( + display.width - (BORDER_WIDTH * 2), display.height - (BORDER_WIDTH * 2), 1 +) + +inner_palette = displayio.Palette(1) +inner_palette[0] = 0xAA0088 # Purple +inner_sprite = displayio.TileGrid( + inner_bitmap, pixel_shader=inner_palette, x=BORDER_WIDTH, y=BORDER_WIDTH +) +splash.append(inner_sprite) + +# Draw a label +text_area = label.Label( + terminalio.FONT, + text="Hello World!", + color=0xFFFF00, + scale=TEXT_SCALE, + anchor_point=(0.5, 0.5), + anchored_position=(display.width // 2, display.height // 2), +) +splash.append(text_area) + +while True: + pass diff --git a/examples/st7789_240x135_pitft_simpletest.py b/examples/st7789_240x135_pitft_simpletest.py new file mode 100644 index 0000000..f04f8ac --- /dev/null +++ b/examples/st7789_240x135_pitft_simpletest.py @@ -0,0 +1,67 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + +""" +This test will initialize the display using displayio and draw a solid green +background, a smaller purple rectangle, and some yellow text. + +Pinouts are for the 1.14" Mini PiTFT and should be run in CPython. +""" + +import board +import displayio +import terminalio +from adafruit_display_text import label +from fourwire import FourWire + +from adafruit_st7789 import ST7789 + +# First set some parameters used for shapes and text +BORDER = 20 +FONTSCALE = 2 +BACKGROUND_COLOR = 0x00FF00 # Bright Green +FOREGROUND_COLOR = 0xAA0088 # Purple +TEXT_COLOR = 0xFFFF00 + +# Release any resources currently in use for the displays +displayio.release_displays() + +spi = board.SPI() +tft_cs = board.CE0 +tft_dc = board.D25 + +display_bus = FourWire(spi, command=tft_dc, chip_select=tft_cs) +display = ST7789(display_bus, rotation=90, width=240, height=135, rowstart=40, colstart=53) + +# Make the display context +splash = displayio.Group() +display.root_group = splash + +color_bitmap = displayio.Bitmap(display.width, display.height, 1) +color_palette = displayio.Palette(1) +color_palette[0] = BACKGROUND_COLOR + +bg_sprite = displayio.TileGrid(color_bitmap, pixel_shader=color_palette, x=0, y=0) +splash.append(bg_sprite) + +# Draw a smaller inner rectangle +inner_bitmap = displayio.Bitmap(display.width - BORDER * 2, display.height - BORDER * 2, 1) +inner_palette = displayio.Palette(1) +inner_palette[0] = FOREGROUND_COLOR +inner_sprite = displayio.TileGrid(inner_bitmap, pixel_shader=inner_palette, x=BORDER, y=BORDER) +splash.append(inner_sprite) + +# Draw a label +text = "Hello World!" +text_area = label.Label(terminalio.FONT, text=text, color=TEXT_COLOR) +text_width = text_area.bounding_box[2] * FONTSCALE +text_group = displayio.Group( + scale=FONTSCALE, + x=display.width // 2 - text_width // 2, + y=display.height // 2, +) +text_group.append(text_area) # Subgroup for text scaling +splash.append(text_group) + +while True: + pass diff --git a/examples/st7789_240x135_simpletest.py b/examples/st7789_240x135_simpletest.py index 97da991..016b1cf 100644 --- a/examples/st7789_240x135_simpletest.py +++ b/examples/st7789_240x135_simpletest.py @@ -1,11 +1,17 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """ This test will initialize the display using displayio and draw a solid green background, a smaller purple rectangle, and some yellow text. """ + import board import displayio import terminalio from adafruit_display_text import label +from fourwire import FourWire + from adafruit_st7789 import ST7789 # First set some parameters used for shapes and text @@ -22,14 +28,12 @@ tft_cs = board.D5 tft_dc = board.D6 -display_bus = displayio.FourWire(spi, command=tft_dc, chip_select=tft_cs) -display = ST7789( - display_bus, rotation=270, width=240, height=135, rowstart=40, colstart=53 -) +display_bus = FourWire(spi, command=tft_dc, chip_select=tft_cs) +display = ST7789(display_bus, rotation=270, width=240, height=135, rowstart=40, colstart=53) # Make the display context -splash = displayio.Group(max_size=10) -display.show(splash) +splash = displayio.Group() +display.root_group = splash color_bitmap = displayio.Bitmap(display.width, display.height, 1) color_palette = displayio.Palette(1) @@ -39,14 +43,10 @@ splash.append(bg_sprite) # Draw a smaller inner rectangle -inner_bitmap = displayio.Bitmap( - display.width - BORDER * 2, display.height - BORDER * 2, 1 -) +inner_bitmap = displayio.Bitmap(display.width - BORDER * 2, display.height - BORDER * 2, 1) inner_palette = displayio.Palette(1) inner_palette[0] = FOREGROUND_COLOR -inner_sprite = displayio.TileGrid( - inner_bitmap, pixel_shader=inner_palette, x=BORDER, y=BORDER -) +inner_sprite = displayio.TileGrid(inner_bitmap, pixel_shader=inner_palette, x=BORDER, y=BORDER) splash.append(inner_sprite) # Draw a label @@ -54,7 +54,6 @@ text_area = label.Label(terminalio.FONT, text=text, color=TEXT_COLOR) text_width = text_area.bounding_box[2] * FONTSCALE text_group = displayio.Group( - max_size=10, scale=FONTSCALE, x=display.width // 2 - text_width // 2, y=display.height // 2, diff --git a/examples/st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py b/examples/st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py new file mode 100644 index 0000000..842e5d4 --- /dev/null +++ b/examples/st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py @@ -0,0 +1,81 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + +""" +This test will initialize the display using displayio and draw a solid green +background, a smaller purple rectangle, and some yellow text. +""" + +import board +import busio +import displayio +import terminalio +from adafruit_display_text import label +from fourwire import FourWire + +from adafruit_st7789 import ST7789 + +# First set some parameters used for shapes and text +BORDER = 20 +FONTSCALE = 2 +BACKGROUND_COLOR = 0x00FF00 # Bright Green +FOREGROUND_COLOR = 0xAA0088 # Purple +TEXT_COLOR = 0xFFFF00 + +# Release any resources currently in use for the displays +displayio.release_displays() + +tft_cs = board.GP17 +tft_dc = board.GP16 +spi_mosi = board.GP19 +spi_clk = board.GP18 +spi = busio.SPI(spi_clk, spi_mosi) +backlight = board.GP20 + +display_bus = FourWire(spi, command=tft_dc, chip_select=tft_cs) + +display = ST7789( + display_bus, + rotation=270, + width=240, + height=135, + rowstart=40, + colstart=53, + backlight_pin=backlight, +) + +# Set the backlight +display.brightness = 0.8 + +# Make the display context +splash = displayio.Group() +display.root_group = splash + +color_bitmap = displayio.Bitmap(display.width, display.height, 1) +color_palette = displayio.Palette(1) +color_palette[0] = BACKGROUND_COLOR + +bg_sprite = displayio.TileGrid(color_bitmap, pixel_shader=color_palette, x=0, y=0) +splash.append(bg_sprite) + +# Draw a smaller inner rectangle +inner_bitmap = displayio.Bitmap(display.width - BORDER * 2, display.height - BORDER * 2, 1) +inner_palette = displayio.Palette(1) +inner_palette[0] = FOREGROUND_COLOR +inner_sprite = displayio.TileGrid(inner_bitmap, pixel_shader=inner_palette, x=BORDER, y=BORDER) +splash.append(inner_sprite) + +# Draw a label +text = "Hello World!" +text_area = label.Label(terminalio.FONT, text=text, color=TEXT_COLOR) +text_width = text_area.bounding_box[2] * FONTSCALE +text_group = displayio.Group( + scale=FONTSCALE, + x=display.width // 2 - text_width // 2, + y=display.height // 2, +) +text_group.append(text_area) # Subgroup for text scaling +splash.append(text_group) + +while True: + pass diff --git a/examples/st7789_240x240_bonnet_simpletest.py b/examples/st7789_240x240_bonnet_simpletest.py new file mode 100644 index 0000000..2246840 --- /dev/null +++ b/examples/st7789_240x240_bonnet_simpletest.py @@ -0,0 +1,64 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + +""" +This test will initialize the display using displayio and draw a solid green +background, a smaller purple rectangle, and some yellow text. + +Pinouts are for the 1.3" TFT Bonnet and should be run in CPython. +""" + +import board +import displayio +import terminalio +from adafruit_display_text import label +from fourwire import FourWire + +from adafruit_st7789 import ST7789 + +# Release any resources currently in use for the displays +displayio.release_displays() + +spi = board.SPI() +tft_cs = board.CE0 +tft_dc = board.D25 +tft_lite = board.D26 + +display_bus = FourWire(spi, command=tft_dc, chip_select=tft_cs) + +display = ST7789( + display_bus, + width=240, + height=240, + rowstart=80, + rotation=180, + backlight_pin=tft_lite, +) + +# Make the display context +splash = displayio.Group() +display.root_group = splash + +color_bitmap = displayio.Bitmap(240, 240, 1) +color_palette = displayio.Palette(1) +color_palette[0] = 0x00FF00 # Bright Green + +bg_sprite = displayio.TileGrid(color_bitmap, pixel_shader=color_palette, x=0, y=0) +splash.append(bg_sprite) + +# Draw a smaller inner rectangle +inner_bitmap = displayio.Bitmap(200, 200, 1) +inner_palette = displayio.Palette(1) +inner_palette[0] = 0xAA0088 # Purple +inner_sprite = displayio.TileGrid(inner_bitmap, pixel_shader=inner_palette, x=20, y=20) +splash.append(inner_sprite) + +# Draw a label +text_group = displayio.Group(scale=2, x=50, y=120) +text = "Hello World!" +text_area = label.Label(terminalio.FONT, text=text, color=0xFFFF00) +text_group.append(text_area) # Subgroup for text scaling +splash.append(text_group) + +while True: + pass diff --git a/examples/st7789_240x240_pitft_simpletest.py b/examples/st7789_240x240_pitft_simpletest.py new file mode 100644 index 0000000..c86eea9 --- /dev/null +++ b/examples/st7789_240x240_pitft_simpletest.py @@ -0,0 +1,56 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + +""" +This test will initialize the display using displayio and draw a solid green +background, a smaller purple rectangle, and some yellow text. + +Pinouts are for the 1.3" PiTFT and should be run in CPython. +""" + +import board +import displayio +import terminalio +from adafruit_display_text import label +from fourwire import FourWire + +from adafruit_st7789 import ST7789 + +# Release any resources currently in use for the displays +displayio.release_displays() + +spi = board.SPI() +tft_cs = board.CE0 +tft_dc = board.D25 + +display_bus = FourWire(spi, command=tft_dc, chip_select=tft_cs) + +display = ST7789(display_bus, width=240, height=240, rowstart=80, rotation=180) + +# Make the display context +splash = displayio.Group() +display.root_group = splash + +color_bitmap = displayio.Bitmap(240, 240, 1) +color_palette = displayio.Palette(1) +color_palette[0] = 0x00FF00 # Bright Green + +bg_sprite = displayio.TileGrid(color_bitmap, pixel_shader=color_palette, x=0, y=0) +splash.append(bg_sprite) + +# Draw a smaller inner rectangle +inner_bitmap = displayio.Bitmap(200, 200, 1) +inner_palette = displayio.Palette(1) +inner_palette[0] = 0xAA0088 # Purple +inner_sprite = displayio.TileGrid(inner_bitmap, pixel_shader=inner_palette, x=20, y=20) +splash.append(inner_sprite) + +# Draw a label +text_group = displayio.Group(scale=2, x=50, y=120) +text = "Hello World!" +text_area = label.Label(terminalio.FONT, text=text, color=0xFFFF00) +text_group.append(text_area) # Subgroup for text scaling +splash.append(text_group) + +while True: + pass diff --git a/examples/st7789_240x240_simpletest_Pimoroni_Pico_Explorer.py b/examples/st7789_240x240_simpletest_Pimoroni_Pico_Explorer.py new file mode 100644 index 0000000..eff0cf4 --- /dev/null +++ b/examples/st7789_240x240_simpletest_Pimoroni_Pico_Explorer.py @@ -0,0 +1,57 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + +""" +This test will initialize the display using displayio and draw a solid green +background, a smaller purple rectangle, and some yellow text. +""" + +import board +import busio +import displayio +import terminalio +from adafruit_display_text import label +from fourwire import FourWire + +from adafruit_st7789 import ST7789 + +# Release any resources currently in use for the displays +displayio.release_displays() + +tft_cs = board.GP17 +tft_dc = board.GP16 +spi_mosi = board.GP19 +spi_clk = board.GP18 +spi = busio.SPI(spi_clk, spi_mosi) + +display_bus = FourWire(spi, command=tft_dc, chip_select=tft_cs) + +display = ST7789(display_bus, width=240, height=240, rowstart=80, rotation=180) + +# Make the display context +splash = displayio.Group() +display.root_group = splash + +color_bitmap = displayio.Bitmap(240, 240, 1) +color_palette = displayio.Palette(1) +color_palette[0] = 0x00FF00 # Bright Green + +bg_sprite = displayio.TileGrid(color_bitmap, pixel_shader=color_palette, x=0, y=0) +splash.append(bg_sprite) + +# Draw a smaller inner rectangle +inner_bitmap = displayio.Bitmap(200, 200, 1) +inner_palette = displayio.Palette(1) +inner_palette[0] = 0xAA0088 # Purple +inner_sprite = displayio.TileGrid(inner_bitmap, pixel_shader=inner_palette, x=20, y=20) +splash.append(inner_sprite) + +# Draw a label +text_group = displayio.Group(scale=2, x=50, y=120) +text = "Hello World!" +text_area = label.Label(terminalio.FONT, text=text, color=0xFFFF00) +text_group.append(text_area) # Subgroup for text scaling +splash.append(text_group) + +while True: + pass diff --git a/examples/st7789_240x240_simpletest_Waveshare_PicoLCD_1_3.py b/examples/st7789_240x240_simpletest_Waveshare_PicoLCD_1_3.py new file mode 100644 index 0000000..8c56920 --- /dev/null +++ b/examples/st7789_240x240_simpletest_Waveshare_PicoLCD_1_3.py @@ -0,0 +1,66 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + +""" +This test will initialize the display using displayio and draw a solid green +background, a smaller purple rectangle, and some yellow text. +""" + +import board +import busio +import displayio +import terminalio +from adafruit_display_text import label +from fourwire import FourWire + +from adafruit_st7789 import ST7789 + +# Release any resources currently in use for the displays +displayio.release_displays() + +tft_dc = board.GP8 +tft_cs = board.GP9 +spi_clk = board.GP10 +spi_mosi = board.GP11 +tft_rst = board.GP12 +backlight = board.GP13 +spi = busio.SPI(spi_clk, spi_mosi) + +display_bus = FourWire(spi, command=tft_dc, chip_select=tft_cs, reset=tft_rst) + +display = ST7789( + display_bus, + rotation=270, + width=240, + height=240, + rowstart=80, + backlight_pin=backlight, +) + +# Make the display context +splash = displayio.Group() +display.root_group = splash + +color_bitmap = displayio.Bitmap(240, 240, 1) +color_palette = displayio.Palette(1) +color_palette[0] = 0x00FF00 # Bright Green + +bg_sprite = displayio.TileGrid(color_bitmap, pixel_shader=color_palette, x=0, y=0) +splash.append(bg_sprite) + +# Draw a smaller inner rectangle +inner_bitmap = displayio.Bitmap(200, 200, 1) +inner_palette = displayio.Palette(1) +inner_palette[0] = 0xAA0088 # Purple +inner_sprite = displayio.TileGrid(inner_bitmap, pixel_shader=inner_palette, x=20, y=20) +splash.append(inner_sprite) + +# Draw a label +text_group = displayio.Group(scale=2, x=50, y=120) +text = "Hello World!" +text_area = label.Label(terminalio.FONT, text=text, color=0xFFFF00) +text_group.append(text_area) # Subgroup for text scaling +splash.append(text_group) + +while True: + pass diff --git a/examples/st7789_280x240_simpletest.py b/examples/st7789_280x240_simpletest.py new file mode 100644 index 0000000..e8229e6 --- /dev/null +++ b/examples/st7789_280x240_simpletest.py @@ -0,0 +1,54 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + +""" +This test will initialize the display using displayio and draw a solid green +background, a smaller purple rectangle, and some yellow text. +""" + +import board +import displayio +import terminalio +from adafruit_display_text import label +from fourwire import FourWire + +from adafruit_st7789 import ST7789 + +# Release any resources currently in use for the displays +displayio.release_displays() + +spi = board.SPI() +tft_cs = board.D5 +tft_dc = board.D6 + +display_bus = FourWire(spi, command=tft_dc, chip_select=tft_cs, reset=board.D9) + +display = ST7789(display_bus, width=280, height=240, rowstart=20, rotation=90) + +# Make the display context +splash = displayio.Group() +display.root_group = splash + +color_bitmap = displayio.Bitmap(280, 240, 1) +color_palette = displayio.Palette(1) +color_palette[0] = 0x00FF00 # Bright Green + +bg_sprite = displayio.TileGrid(color_bitmap, pixel_shader=color_palette, x=0, y=0) +splash.append(bg_sprite) + +# Draw a smaller inner rectangle +inner_bitmap = displayio.Bitmap(240, 200, 1) +inner_palette = displayio.Palette(1) +inner_palette[0] = 0xAA0088 # Purple +inner_sprite = displayio.TileGrid(inner_bitmap, pixel_shader=inner_palette, x=20, y=20) +splash.append(inner_sprite) + +# Draw a label +text_group = displayio.Group(scale=3, x=37, y=120) +text = "Hello World!" +text_area = label.Label(terminalio.FONT, text=text, color=0xFFFF00) +text_group.append(text_area) # Subgroup for text scaling +splash.append(text_group) + +while True: + pass diff --git a/examples/st7789_320x240_simpletest.py b/examples/st7789_320x240_simpletest.py index a0cbf23..357e130 100644 --- a/examples/st7789_320x240_simpletest.py +++ b/examples/st7789_320x240_simpletest.py @@ -1,11 +1,17 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """ This test will initialize the display using displayio and draw a solid green background, a smaller purple rectangle, and some yellow text. """ + import board import displayio import terminalio from adafruit_display_text import label +from fourwire import FourWire + from adafruit_st7789 import ST7789 # Release any resources currently in use for the displays @@ -15,15 +21,13 @@ tft_cs = board.D5 tft_dc = board.D6 -display_bus = displayio.FourWire( - spi, command=tft_dc, chip_select=tft_cs, reset=board.D9 -) +display_bus = FourWire(spi, command=tft_dc, chip_select=tft_cs, reset=board.D9) display = ST7789(display_bus, width=320, height=240, rotation=90) # Make the display context -splash = displayio.Group(max_size=10) -display.show(splash) +splash = displayio.Group() +display.root_group = splash color_bitmap = displayio.Bitmap(320, 240, 1) color_palette = displayio.Palette(1) @@ -40,7 +44,7 @@ splash.append(inner_sprite) # Draw a label -text_group = displayio.Group(max_size=10, scale=3, x=57, y=120) +text_group = displayio.Group(scale=3, x=57, y=120) text = "Hello World!" text_area = label.Label(terminalio.FONT, text=text, color=0xFFFF00) text_group.append(text_area) # Subgroup for text scaling diff --git a/examples/st7789_320x240_simpletest_Pimoroni_Pico_Display_2_0.py b/examples/st7789_320x240_simpletest_Pimoroni_Pico_Display_2_0.py new file mode 100644 index 0000000..846b084 --- /dev/null +++ b/examples/st7789_320x240_simpletest_Pimoroni_Pico_Display_2_0.py @@ -0,0 +1,67 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + +""" +This test will initialize the display using displayio and draw a solid green +background, a smaller purple rectangle, and some yellow text. +""" + +import board +import busio +import displayio +import terminalio +from adafruit_display_text import label +from fourwire import FourWire + +from adafruit_st7789 import ST7789 + +# Release any resources currently in use for the displays +displayio.release_displays() + +tft_cs = board.GP17 +tft_dc = board.GP16 +spi_mosi = board.GP19 +spi_clk = board.GP18 +spi = busio.SPI(spi_clk, spi_mosi) +backlight = board.GP20 + +display_bus = FourWire(spi, command=tft_dc, chip_select=tft_cs) + +display = ST7789( + display_bus, + rotation=270, + width=320, + height=240, + backlight_pin=backlight, +) + +# Set the backlight +display.brightness = 0.8 + +# Make the display context +splash = displayio.Group() +display.root_group = splash + +color_bitmap = displayio.Bitmap(320, 240, 1) +color_palette = displayio.Palette(1) +color_palette[0] = 0x00FF00 # Bright Green + +bg_sprite = displayio.TileGrid(color_bitmap, pixel_shader=color_palette, x=0, y=0) +splash.append(bg_sprite) + +# Draw a smaller inner rectangle +inner_bitmap = displayio.Bitmap(280, 200, 1) +inner_palette = displayio.Palette(1) +inner_palette[0] = 0xAA0088 # Purple +inner_sprite = displayio.TileGrid(inner_bitmap, pixel_shader=inner_palette, x=20, y=20) +splash.append(inner_sprite) + +# Draw a label +text_group = displayio.Group(scale=3, x=57, y=120) +text = "Hello World!" +text_area = label.Label(terminalio.FONT, text=text, color=0xFFFF00) +text_group.append(text_area) # Subgroup for text scaling +splash.append(text_group) + +while True: + pass diff --git a/examples/st7789_simpletest.py b/examples/st7789_simpletest.py index eb85629..4d48e12 100644 --- a/examples/st7789_simpletest.py +++ b/examples/st7789_simpletest.py @@ -1,11 +1,17 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """ This test will initialize the display using displayio and draw a solid green background, a smaller purple rectangle, and some yellow text. """ + import board import displayio import terminalio from adafruit_display_text import label +from fourwire import FourWire + from adafruit_st7789 import ST7789 # Release any resources currently in use for the displays @@ -15,15 +21,13 @@ tft_cs = board.D5 tft_dc = board.D6 -display_bus = displayio.FourWire( - spi, command=tft_dc, chip_select=tft_cs, reset=board.D9 -) +display_bus = FourWire(spi, command=tft_dc, chip_select=tft_cs, reset=board.D9) -display = ST7789(display_bus, width=240, height=240, rowstart=80) +display = ST7789(display_bus, width=240, height=240, rowstart=80, bgr=True, invert=True) # Make the display context -splash = displayio.Group(max_size=10) -display.show(splash) +splash = displayio.Group() +display.root_group = splash color_bitmap = displayio.Bitmap(240, 240, 1) color_palette = displayio.Palette(1) @@ -40,7 +44,7 @@ splash.append(inner_sprite) # Draw a label -text_group = displayio.Group(max_size=10, scale=2, x=50, y=120) +text_group = displayio.Group(scale=2, x=50, y=120) text = "Hello World!" text_area = label.Label(terminalio.FONT, text=text, color=0xFFFF00) text_group.append(text_area) # Subgroup for text scaling diff --git a/examples/st7789_tft_gizmo_simpletest.py b/examples/st7789_tft_gizmo_simpletest.py index e0bab93..17bf207 100644 --- a/examples/st7789_tft_gizmo_simpletest.py +++ b/examples/st7789_tft_gizmo_simpletest.py @@ -1,12 +1,18 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + """ This test will initialize the display using displayio and draw a solid green background, a smaller purple rectangle, and some yellow text. """ + import board import busio import displayio import terminalio from adafruit_display_text import label +from fourwire import FourWire + from adafruit_st7789 import ST7789 # Release any resources currently in use for the displays @@ -17,7 +23,7 @@ tft_dc = board.TX tft_backlight = board.A3 -display_bus = displayio.FourWire(spi, command=tft_dc, chip_select=tft_cs) +display_bus = FourWire(spi, command=tft_dc, chip_select=tft_cs) display = ST7789( display_bus, @@ -29,8 +35,8 @@ ) # Make the display context -splash = displayio.Group(max_size=10) -display.show(splash) +splash = displayio.Group() +display.root_group = splash color_bitmap = displayio.Bitmap(240, 240, 1) color_palette = displayio.Palette(1) @@ -47,7 +53,7 @@ splash.append(inner_sprite) # Draw a label -text_group = displayio.Group(max_size=10, scale=2, x=50, y=120) +text_group = displayio.Group(scale=2, x=50, y=120) text = "Hello World!" text_area = label.Label(terminalio.FONT, text=text, color=0xFFFF00) text_group.append(text_area) # Subgroup for text scaling diff --git a/optional_requirements.txt b/optional_requirements.txt new file mode 100644 index 0000000..d4e27c4 --- /dev/null +++ b/optional_requirements.txt @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..864e7a8 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,48 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +[build-system] +requires = [ + "setuptools", + "wheel", + "setuptools-scm", +] + +[project] +name = "adafruit-circuitpython-st7789" +description = "displayio driver for ST7789 TFT-LCD displays." +version = "0.0.0+auto.0" +readme = "README.rst" +authors = [ + {name = "Adafruit Industries", email = "circuitpython@adafruit.com"} +] +urls = {Homepage = "https://github.com/adafruit/Adafruit_CircuitPython_ST7789"} +keywords = [ + "adafruit", + "blinka", + "circuitpython", + "micropython", + "st7789", + "display", + "tft", + "lcd", + "displayio", +] +license = {text = "MIT"} +classifiers = [ + "Intended Audience :: Developers", + "Topic :: Software Development :: Libraries", + "Topic :: Software Development :: Embedded Systems", + "Topic :: System :: Hardware", + "License :: OSI Approved :: MIT License", + "Programming Language :: Python :: 3", +] +dynamic = ["dependencies", "optional-dependencies"] + +[tool.setuptools] +py-modules = ["adafruit_st7789"] + +[tool.setuptools.dynamic] +dependencies = {file = ["requirements.txt"]} +optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} diff --git a/requirements.txt b/requirements.txt index cf4cac0..274b851 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,6 @@ -Adafruit-Blinka +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense +Adafruit-Blinka +adafruit-blinka-displayio diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..970c292 --- /dev/null +++ b/ruff.toml @@ -0,0 +1,100 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +target-version = "py38" +line-length = 100 + +[lint] +preview = true +select = ["I", "PL", "UP"] + +extend-select = [ + "D419", # empty-docstring + "E501", # line-too-long + "W291", # trailing-whitespace + "PLC0414", # useless-import-alias + "PLC2401", # non-ascii-name + "PLC2801", # unnecessary-dunder-call + "PLC3002", # unnecessary-direct-lambda-call + "E999", # syntax-error + "PLE0101", # return-in-init + "F706", # return-outside-function + "F704", # yield-outside-function + "PLE0116", # continue-in-finally + "PLE0117", # nonlocal-without-binding + "PLE0241", # duplicate-bases + "PLE0302", # unexpected-special-method-signature + "PLE0604", # invalid-all-object + "PLE0605", # invalid-all-format + "PLE0643", # potential-index-error + "PLE0704", # misplaced-bare-raise + "PLE1141", # dict-iter-missing-items + "PLE1142", # await-outside-async + "PLE1205", # logging-too-many-args + "PLE1206", # logging-too-few-args + "PLE1307", # bad-string-format-type + "PLE1310", # bad-str-strip-call + "PLE1507", # invalid-envvar-value + "PLE2502", # bidirectional-unicode + "PLE2510", # invalid-character-backspace + "PLE2512", # invalid-character-sub + "PLE2513", # invalid-character-esc + "PLE2514", # invalid-character-nul + "PLE2515", # invalid-character-zero-width-space + "PLR0124", # comparison-with-itself + "PLR0202", # no-classmethod-decorator + "PLR0203", # no-staticmethod-decorator + "UP004", # useless-object-inheritance + "PLR0206", # property-with-parameters + "PLR0904", # too-many-public-methods + "PLR0911", # too-many-return-statements + "PLR0912", # too-many-branches + "PLR0913", # too-many-arguments + "PLR0914", # too-many-locals + "PLR0915", # too-many-statements + "PLR0916", # too-many-boolean-expressions + "PLR1702", # too-many-nested-blocks + "PLR1704", # redefined-argument-from-local + "PLR1711", # useless-return + "C416", # unnecessary-comprehension + "PLR1733", # unnecessary-dict-index-lookup + "PLR1736", # unnecessary-list-index-lookup + + # ruff reports this rule is unstable + #"PLR6301", # no-self-use + + "PLW0108", # unnecessary-lambda + "PLW0120", # useless-else-on-loop + "PLW0127", # self-assigning-variable + "PLW0129", # assert-on-string-literal + "B033", # duplicate-value + "PLW0131", # named-expr-without-context + "PLW0245", # super-without-brackets + "PLW0406", # import-self + "PLW0602", # global-variable-not-assigned + "PLW0603", # global-statement + "PLW0604", # global-at-module-level + + # fails on the try: import typing used by libraries + #"F401", # unused-import + + "F841", # unused-variable + "E722", # bare-except + "PLW0711", # binary-op-exception + "PLW1501", # bad-open-mode + "PLW1508", # invalid-envvar-default + "PLW1509", # subprocess-popen-preexec-fn + "PLW2101", # useless-with-lock + "PLW3301", # nested-min-max +] + +ignore = [ + "PLR2004", # magic-value-comparison + "UP030", # format literals + "PLW1514", # unspecified-encoding + +] + +[format] +line-ending = "lf" diff --git a/setup.py.disabled b/setup.py.disabled deleted file mode 100644 index a80b9bf..0000000 --- a/setup.py.disabled +++ /dev/null @@ -1,4 +0,0 @@ -""" -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. -"""