From f1f1273bf50b7bf5aa2579bc9562cc24322490cd Mon Sep 17 00:00:00 2001 From: Melissa LeBlanc-Williams Date: Tue, 9 Jun 2020 17:26:47 -0700 Subject: [PATCH 01/91] File changes to allow releasing on PyPI --- adafruit_st7789.py | 17 ++++- examples/st7789_240x135_pitft_simpletest.py | 68 ++++++++++++++++++++ examples/st7789_240x135_simpletest.py | 2 +- examples/st7789_240x240_bonnet_simpletest.py | 58 +++++++++++++++++ examples/st7789_240x240_pitft_simpletest.py | 50 ++++++++++++++ examples/st7789_320x240_simpletest.py | 2 +- examples/st7789_simpletest.py | 2 +- examples/st7789_tft_gizmo_simpletest.py | 2 +- requirements.txt | 2 +- setup.py | 50 ++++++++++++++ setup.py.disabled | 4 -- 11 files changed, 247 insertions(+), 10 deletions(-) create mode 100644 examples/st7789_240x135_pitft_simpletest.py create mode 100644 examples/st7789_240x240_bonnet_simpletest.py create mode 100644 examples/st7789_240x240_pitft_simpletest.py create mode 100644 setup.py delete mode 100644 setup.py.disabled diff --git a/adafruit_st7789.py b/adafruit_st7789.py index bb0e0e7..522a5fa 100755 --- a/adafruit_st7789.py +++ b/adafruit_st7789.py @@ -32,9 +32,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: diff --git a/examples/st7789_240x135_pitft_simpletest.py b/examples/st7789_240x135_pitft_simpletest.py new file mode 100644 index 0000000..5817458 --- /dev/null +++ b/examples/st7789_240x135_pitft_simpletest.py @@ -0,0 +1,68 @@ +""" +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 terminalio +import displayio +from adafruit_display_text import label +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 = displayio.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(max_size=10) +display.show(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( + max_size=10, + 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..cc72ea2 100644 --- a/examples/st7789_240x135_simpletest.py +++ b/examples/st7789_240x135_simpletest.py @@ -3,8 +3,8 @@ background, a smaller purple rectangle, and some yellow text. """ import board -import displayio import terminalio +import displayio from adafruit_display_text import label from adafruit_st7789 import ST7789 diff --git a/examples/st7789_240x240_bonnet_simpletest.py b/examples/st7789_240x240_bonnet_simpletest.py new file mode 100644 index 0000000..9676387 --- /dev/null +++ b/examples/st7789_240x240_bonnet_simpletest.py @@ -0,0 +1,58 @@ +""" +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 terminalio +import displayio +from adafruit_display_text import label +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 = displayio.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(max_size=10) +display.show(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(max_size=10, 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..5c55926 --- /dev/null +++ b/examples/st7789_240x240_pitft_simpletest.py @@ -0,0 +1,50 @@ +""" +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 terminalio +import displayio +from adafruit_display_text import label +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 = displayio.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(max_size=10) +display.show(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(max_size=10, 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_320x240_simpletest.py b/examples/st7789_320x240_simpletest.py index a0cbf23..a96eb66 100644 --- a/examples/st7789_320x240_simpletest.py +++ b/examples/st7789_320x240_simpletest.py @@ -3,8 +3,8 @@ background, a smaller purple rectangle, and some yellow text. """ import board -import displayio import terminalio +import displayio from adafruit_display_text import label from adafruit_st7789 import ST7789 diff --git a/examples/st7789_simpletest.py b/examples/st7789_simpletest.py index eb85629..1fa06cb 100644 --- a/examples/st7789_simpletest.py +++ b/examples/st7789_simpletest.py @@ -3,8 +3,8 @@ background, a smaller purple rectangle, and some yellow text. """ import board -import displayio import terminalio +import displayio from adafruit_display_text import label from adafruit_st7789 import ST7789 diff --git a/examples/st7789_tft_gizmo_simpletest.py b/examples/st7789_tft_gizmo_simpletest.py index e0bab93..34e5f09 100644 --- a/examples/st7789_tft_gizmo_simpletest.py +++ b/examples/st7789_tft_gizmo_simpletest.py @@ -4,8 +4,8 @@ """ import board import busio -import displayio import terminalio +import displayio from adafruit_display_text import label from adafruit_st7789 import ST7789 diff --git a/requirements.txt b/requirements.txt index cf4cac0..f99129c 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,2 @@ Adafruit-Blinka - +adafruit-blinka-displayio diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..3b18f32 --- /dev/null +++ b/setup.py @@ -0,0 +1,50 @@ +"""A setuptools based setup module. +See: +https://packaging.python.org/en/latest/distributing.html +https://github.com/pypa/sampleproject +""" + +from setuptools import setup, find_packages + +# To use a consistent encoding +from codecs import open +from os import path + +here = path.abspath(path.dirname(__file__)) + +# Get the long description from the README file +with open(path.join(here, "README.rst"), encoding="utf-8") as f: + long_description = f.read() + +setup( + name="adafruit-circuitpython-st7789", + use_scm_version=True, + setup_requires=["setuptools_scm"], + description="displayio driver for ST7789 TFT-LCD displays.", + long_description=long_description, + long_description_content_type="text/x-rst", + # The project's main homepage. + url="https://github.com/adafruit/Adafruit_CircuitPython_ST7789", + # Author details + author="Adafruit Industries", + author_email="circuitpython@adafruit.com", + install_requires=["Adafruit-Blinka", "adafruit-blinka-displayio",], + # Choose your license + license="MIT", + # See https://pypi.python.org/pypi?%3Aaction=list_classifiers + classifiers=[ + "Development Status :: 3 - Alpha", + "Intended Audience :: Developers", + "Topic :: Software Development :: Libraries", + "Topic :: System :: Hardware", + "License :: OSI Approved :: MIT License", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.4", + "Programming Language :: Python :: 3.5", + ], + # What does your project relate to? + keywords="adafruit blinka circuitpython micropython st7789 display tft lcd displayio", + # You can just specify the packages manually here if your project is + # simple. Or you can use find_packages(). + py_modules=["adafruit_st7789"], +) 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. -""" From 8a0aee1ad0fb2afa82cf32071d33b533f5bd78ac Mon Sep 17 00:00:00 2001 From: Melissa LeBlanc-Williams Date: Tue, 9 Jun 2020 17:30:46 -0700 Subject: [PATCH 02/91] Sphinx wanted another blank line --- adafruit_st7789.py | 1 + 1 file changed, 1 insertion(+) diff --git a/adafruit_st7789.py b/adafruit_st7789.py index 522a5fa..486fad1 100755 --- a/adafruit_st7789.py +++ b/adafruit_st7789.py @@ -50,6 +50,7 @@ * 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: From af8a645693913f1979766a5dded6551f06731ae7 Mon Sep 17 00:00:00 2001 From: Melissa LeBlanc-Williams Date: Tue, 9 Jun 2020 17:36:50 -0700 Subject: [PATCH 03/91] Trying to interpret a sphinx cryptic error --- adafruit_st7789.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/adafruit_st7789.py b/adafruit_st7789.py index 486fad1..2e35eac 100755 --- a/adafruit_st7789.py +++ b/adafruit_st7789.py @@ -33,7 +33,7 @@ **Hardware:** * Adafruit 1.3" 240x240 Wide Angle TFT LCD Display with MicroSD - ST7789: -https://www.adafruit.com/product/4313 + https://www.adafruit.com/product/4313 * Adafruit 1.54" 240x240 Wide Angle TFT LCD Display with MicroSD - ST7789: https://www.adafruit.com/product/3787 @@ -50,7 +50,6 @@ * 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: From 156783b7218536c24422a00d86651d63fa193b3e Mon Sep 17 00:00:00 2001 From: Melissa LeBlanc-Williams Date: Wed, 10 Jun 2020 10:58:58 -0700 Subject: [PATCH 04/91] Added products to index page --- docs/index.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/index.rst b/docs/index.rst index 24c0cf6..734d593 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -26,8 +26,18 @@ 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 From e0225d3f7c4e137846cb2ceed4915559d4ba9daf Mon Sep 17 00:00:00 2001 From: dherrada Date: Wed, 8 Jul 2020 16:49:05 -0400 Subject: [PATCH 05/91] Fixed discord invite link --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 54e5bfb..70169c8 100644 --- a/README.rst +++ b/README.rst @@ -6,7 +6,7 @@ Introduction :alt: Documentation Status .. image:: https://img.shields.io/discord/327254708534116352.svg - :target: https://discord.gg/nBQh6qu + :target: https://adafru.it/discord :alt: Discord .. image:: https://github.com/adafruit/Adafruit_CircuitPython_ST7789/workflows/Build%20CI/badge.svg From 2e83e3061d40bc30d99fdeb4e2c0c047153ba109 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 11 Jan 2021 15:06:44 -0500 Subject: [PATCH 06/91] Added pre-commit and SPDX copyright Signed-off-by: dherrada --- .github/workflows/build.yml | 28 ++++++++++++++++++++++++---- .github/workflows/release.yml | 4 ++++ 2 files changed, 28 insertions(+), 4 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index b6977a9..59baa53 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] @@ -38,20 +42,36 @@ jobs: # (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 + - name: Pip install pylint, Sphinx, pre-commit run: | - pip install --force-reinstall pylint black==19.10b0 Sphinx sphinx-rtd-theme + pip install --force-reinstall pylint Sphinx sphinx-rtd-theme pre-commit - name: Library version run: git describe --dirty --always --tags - - name: Check formatting + - name: Pre-commit hooks run: | - black --check --target-version=py35 . + pre-commit run --all-files - 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: Archive bundles + uses: actions/upload-artifact@v2 + with: + name: bundles + path: ${{ github.workspace }}/bundles/ - name: Build docs working-directory: docs run: sphinx-build -E -W -b html . _build/html + - name: Check For setup.py + id: need-pypi + run: | + echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) + - name: Build Python package + if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + run: | + pip install --upgrade setuptools wheel twine readme_renderer testresources + python setup.py sdist + python setup.py bdist_wheel --universal + twine check dist/* diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 18efb9c..6d0015a 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + name: Release Actions on: From 0d5886d8add3190187c0de8f261f14ce7c1819e2 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 11 Jan 2021 16:06:47 -0500 Subject: [PATCH 07/91] Added pre-commit-config file Signed-off-by: dherrada --- .pre-commit-config.yaml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 .pre-commit-config.yaml diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..aab5f1c --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,19 @@ +# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò +# +# SPDX-License-Identifier: Unlicense + +repos: +- repo: https://github.com/python/black + rev: stable + hooks: + - id: black +- repo: https://github.com/fsfe/reuse-tool + rev: latest + hooks: + - id: reuse +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: v2.3.0 + hooks: + - id: check-yaml + - id: end-of-file-fixer + - id: trailing-whitespace From cba0a9bb6abf5960ed8f316bacea42cd986dad3e Mon Sep 17 00:00:00 2001 From: dherrada Date: Wed, 13 Jan 2021 11:51:29 -0500 Subject: [PATCH 08/91] Ran pre-commit, added licenses --- .gitignore | 4 + .pylintrc | 4 + .readthedocs.yml | 4 + CODE_OF_CONDUCT.md | 14 +- LICENSES/CC-BY-4.0.txt | 324 +++++++++++++++++++ LICENSES/MIT.txt | 19 ++ LICENSES/Unlicense.txt | 20 ++ README.rst.license | 3 + adafruit_st7789.py | 23 +- docs/_static/favicon.ico.license | 3 + docs/api.rst.license | 3 + docs/conf.py | 4 + docs/examples.rst.license | 3 + docs/index.rst.license | 3 + examples/st7789_240x135_pitft_simpletest.py | 3 + examples/st7789_240x135_simpletest.py | 3 + examples/st7789_240x240_bonnet_simpletest.py | 3 + examples/st7789_240x240_pitft_simpletest.py | 3 + examples/st7789_320x240_simpletest.py | 3 + examples/st7789_simpletest.py | 3 + examples/st7789_tft_gizmo_simpletest.py | 3 + requirements.txt | 4 + setup.py | 9 +- 23 files changed, 440 insertions(+), 25 deletions(-) create mode 100644 LICENSES/CC-BY-4.0.txt create mode 100644 LICENSES/MIT.txt create mode 100644 LICENSES/Unlicense.txt create mode 100644 README.rst.license create mode 100644 docs/_static/favicon.ico.license create mode 100644 docs/api.rst.license create mode 100644 docs/examples.rst.license create mode 100644 docs/index.rst.license diff --git a/.gitignore b/.gitignore index 1be1c4b..9647e71 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + *.mpy .idea __pycache__ diff --git a/.pylintrc b/.pylintrc index d8f0ee8..5c31f66 100644 --- a/.pylintrc +++ b/.pylintrc @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + [MASTER] # A comma-separated list of package or module names from where C extensions may diff --git a/.readthedocs.yml b/.readthedocs.yml index f4243ad..ffa84c4 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + 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.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 2e35eac..3b34441 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` ==================================================== 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.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..077875b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,5 +1,9 @@ # -*- coding: utf-8 -*- +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT + import os import sys 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.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/examples/st7789_240x135_pitft_simpletest.py b/examples/st7789_240x135_pitft_simpletest.py index 5817458..3258799 100644 --- a/examples/st7789_240x135_pitft_simpletest.py +++ b/examples/st7789_240x135_pitft_simpletest.py @@ -1,3 +1,6 @@ +# 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. diff --git a/examples/st7789_240x135_simpletest.py b/examples/st7789_240x135_simpletest.py index cc72ea2..d6b52df 100644 --- a/examples/st7789_240x135_simpletest.py +++ b/examples/st7789_240x135_simpletest.py @@ -1,3 +1,6 @@ +# 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. diff --git a/examples/st7789_240x240_bonnet_simpletest.py b/examples/st7789_240x240_bonnet_simpletest.py index 9676387..5101272 100644 --- a/examples/st7789_240x240_bonnet_simpletest.py +++ b/examples/st7789_240x240_bonnet_simpletest.py @@ -1,3 +1,6 @@ +# 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. diff --git a/examples/st7789_240x240_pitft_simpletest.py b/examples/st7789_240x240_pitft_simpletest.py index 5c55926..e666c41 100644 --- a/examples/st7789_240x240_pitft_simpletest.py +++ b/examples/st7789_240x240_pitft_simpletest.py @@ -1,3 +1,6 @@ +# 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. diff --git a/examples/st7789_320x240_simpletest.py b/examples/st7789_320x240_simpletest.py index a96eb66..bf1e81d 100644 --- a/examples/st7789_320x240_simpletest.py +++ b/examples/st7789_320x240_simpletest.py @@ -1,3 +1,6 @@ +# 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. diff --git a/examples/st7789_simpletest.py b/examples/st7789_simpletest.py index 1fa06cb..b1a4672 100644 --- a/examples/st7789_simpletest.py +++ b/examples/st7789_simpletest.py @@ -1,3 +1,6 @@ +# 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. diff --git a/examples/st7789_tft_gizmo_simpletest.py b/examples/st7789_tft_gizmo_simpletest.py index 34e5f09..3892684 100644 --- a/examples/st7789_tft_gizmo_simpletest.py +++ b/examples/st7789_tft_gizmo_simpletest.py @@ -1,3 +1,6 @@ +# 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. diff --git a/requirements.txt b/requirements.txt index f99129c..44cdfd8 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + Adafruit-Blinka adafruit-blinka-displayio diff --git a/setup.py b/setup.py index 3b18f32..8cbf9b2 100644 --- a/setup.py +++ b/setup.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: MIT + """A setuptools based setup module. See: https://packaging.python.org/en/latest/distributing.html @@ -28,7 +32,10 @@ # Author details author="Adafruit Industries", author_email="circuitpython@adafruit.com", - install_requires=["Adafruit-Blinka", "adafruit-blinka-displayio",], + install_requires=[ + "Adafruit-Blinka", + "adafruit-blinka-displayio", + ], # Choose your license license="MIT", # See https://pypi.python.org/pypi?%3Aaction=list_classifiers From c0c898575d6ec7efd337a76e122a7c348d082a3e Mon Sep 17 00:00:00 2001 From: wildestpixel <47211094+wildestpixel@users.noreply.github.com> Date: Tue, 9 Feb 2021 05:40:49 +0000 Subject: [PATCH 09/91] Create st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py Adding functionality simply for Pimoroni Pico Display Pack --- ...5_simpletest_Pimoroni_Pico_Display_Pack.py | 65 +++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 examples/st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py 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..4cfbf10 --- /dev/null +++ b/examples/st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py @@ -0,0 +1,65 @@ +import board +import busio +import terminalio +import displayio +from adafruit_display_text import label +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) + +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 +) + +# Make the display context +splash = displayio.Group(max_size=10) +display.show(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( + max_size=10, + 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 From ae0afaf7a2a4106b11c7900e0bbd8b778b16b973 Mon Sep 17 00:00:00 2001 From: wildestpixel <47211094+wildestpixel@users.noreply.github.com> Date: Tue, 9 Feb 2021 20:14:21 +0000 Subject: [PATCH 10/91] Update st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py --- .../st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/examples/st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py b/examples/st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py index 4cfbf10..a57babd 100644 --- a/examples/st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py +++ b/examples/st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py @@ -1,3 +1,6 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + import board import busio import terminalio From 9ed67add1074613cf1a7d4ab17201c2794a709e3 Mon Sep 17 00:00:00 2001 From: dherrada Date: Wed, 3 Feb 2021 16:38:51 -0500 Subject: [PATCH 11/91] Hardcoded Black and REUSE versions Signed-off-by: dherrada --- .pre-commit-config.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index aab5f1c..07f886c 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -4,11 +4,11 @@ repos: - repo: https://github.com/python/black - rev: stable + rev: 20.8b1 hooks: - id: black - repo: https://github.com/fsfe/reuse-tool - rev: latest + rev: v0.12.1 hooks: - id: reuse - repo: https://github.com/pre-commit/pre-commit-hooks From c1dc5c06301e41bf087d8a8f0f06bce6087e2f5c Mon Sep 17 00:00:00 2001 From: wildestpixel <47211094+wildestpixel@users.noreply.github.com> Date: Fri, 12 Feb 2021 05:52:24 +0000 Subject: [PATCH 12/91] Create st7789_240x240_simpletest_Pimoroni_Pico_Explorer.py Example for Pimoroni Pico Explorer Display, correctly rotated --- ...0x240_simpletest_Pimoroni_Pico_Explorer.py | 56 +++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 examples/st7789_240x240_simpletest_Pimoroni_Pico_Explorer.py 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..007d2d8 --- /dev/null +++ b/examples/st7789_240x240_simpletest_Pimoroni_Pico_Explorer.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. +""" +import board +import busio +import terminalio +import displayio +from adafruit_display_text import label +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 = displayio.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(max_size=10) +display.show(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(max_size=10, 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 From 5d5ac72cd6e6510b54f5533ac64d70f4ba2232f1 Mon Sep 17 00:00:00 2001 From: wildestpixel <47211094+wildestpixel@users.noreply.github.com> Date: Thu, 18 Feb 2021 05:27:43 +0000 Subject: [PATCH 13/91] Add files via upload --- examples/st7789_240x240_simpletest_Pimoroni_Pico_Explorer.py | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/examples/st7789_240x240_simpletest_Pimoroni_Pico_Explorer.py b/examples/st7789_240x240_simpletest_Pimoroni_Pico_Explorer.py index 007d2d8..bca0a53 100644 --- a/examples/st7789_240x240_simpletest_Pimoroni_Pico_Explorer.py +++ b/examples/st7789_240x240_simpletest_Pimoroni_Pico_Explorer.py @@ -21,9 +21,7 @@ spi_clk = board.GP18 spi = busio.SPI(spi_clk, spi_mosi) -display_bus = displayio.FourWire( - spi, command=tft_dc, chip_select=tft_cs -) +display_bus = displayio.FourWire(spi, command=tft_dc, chip_select=tft_cs) display = ST7789(display_bus, width=240, height=240, rowstart=80, rotation=180) From 17ca442708c7f00ff49d375bc8c15449a9da6e3f Mon Sep 17 00:00:00 2001 From: dherrada Date: Tue, 2 Mar 2021 16:46:17 -0500 Subject: [PATCH 14/91] Removed pylint process from github workflow Signed-off-by: dherrada --- .github/workflows/build.yml | 8 ++------ .pre-commit-config.yaml | 15 +++++++++++++++ .pylintrc | 2 +- 3 files changed, 18 insertions(+), 7 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 59baa53..621d5ef 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -42,18 +42,14 @@ jobs: # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.) run: | source actions-ci/install.sh - - name: Pip install pylint, Sphinx, pre-commit + - name: Pip install Sphinx, pre-commit run: | - pip install --force-reinstall pylint Sphinx sphinx-rtd-theme pre-commit + pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit - name: Library version run: git describe --dirty --always --tags - name: Pre-commit hooks run: | pre-commit run --all-files - - name: 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: Archive bundles diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 07f886c..354c761 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -17,3 +17,18 @@ repos: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace +- repo: https://github.com/pycqa/pylint + rev: pylint-2.7.1 + hooks: + - id: pylint + name: pylint (library code) + types: [python] + exclude: "^(docs/|examples/|setup.py$)" +- repo: local + hooks: + - id: pylint_examples + name: pylint (examples code) + description: Run pylint rules on "examples/*.py" files + entry: /usr/bin/env bash -c + args: ['([[ ! -d "examples" ]] || for example in $(find . -path "./examples/*.py"); do pylint --disable=missing-docstring,invalid-name $example; done)'] + language: system diff --git a/.pylintrc b/.pylintrc index 5c31f66..9ed669e 100644 --- a/.pylintrc +++ b/.pylintrc @@ -250,7 +250,7 @@ ignore-comments=yes ignore-docstrings=yes # Ignore imports when computing similarities. -ignore-imports=no +ignore-imports=yes # Minimum lines number of a similarity. min-similarity-lines=4 From f1841618d2690bb54dabd98fd8650af30bc2c9bf Mon Sep 17 00:00:00 2001 From: dherrada Date: Tue, 2 Mar 2021 17:17:50 -0500 Subject: [PATCH 15/91] Re-added pylint install to build.yml Signed-off-by: dherrada --- .github/workflows/build.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 621d5ef..3baf502 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -42,9 +42,9 @@ jobs: # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.) run: | source actions-ci/install.sh - - name: Pip install Sphinx, pre-commit + - name: Pip install pylint, Sphinx, pre-commit run: | - pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit + pip install --force-reinstall pylint Sphinx sphinx-rtd-theme pre-commit - name: Library version run: git describe --dirty --always --tags - name: Pre-commit hooks From 881ffb981f26f40debe9cfd70427b8e49fef1294 Mon Sep 17 00:00:00 2001 From: dherrada Date: Fri, 19 Mar 2021 13:45:55 -0400 Subject: [PATCH 16/91] "Increase duplicate code check threshold " --- .pylintrc | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.pylintrc b/.pylintrc index 9ed669e..0238b90 100644 --- a/.pylintrc +++ b/.pylintrc @@ -22,8 +22,7 @@ ignore-patterns= #init-hook= # Use multiple processes to speed up Pylint. -# jobs=1 -jobs=2 +jobs=1 # List of plugins (as comma separated values of python modules names) to load, # usually to register additional checkers. @@ -253,7 +252,7 @@ ignore-docstrings=yes ignore-imports=yes # Minimum lines number of a similarity. -min-similarity-lines=4 +min-similarity-lines=12 [BASIC] From 2809fc3c80110b19a8b59d9b0de0c4d51d6ddd4a Mon Sep 17 00:00:00 2001 From: dherrada Date: Wed, 19 May 2021 13:32:42 -0400 Subject: [PATCH 17/91] Added pull request template Signed-off-by: dherrada --- .../adafruit_circuitpython_pr.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md 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..71ef8f8 --- /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://circuitpython.readthedocs.io/en/latest/docs/design_guide.html + +If your changes are to documentation, please verify that the documentation builds locally by following the steps found here: https://adafru.it/build-docs + +Before submitting the pull request, make sure you've run Pylint and Black locally on your code. You can do this manually or using pre-commit. Instructions are available here: https://adafru.it/check-your-code + +Please remove all of this text before submitting. Include an explanation or list of changes included in your PR, as well as, if applicable, a link to any related issues. From 2717063865a94857ec2160547641acd428448016 Mon Sep 17 00:00:00 2001 From: dherrada Date: Wed, 19 May 2021 13:35:18 -0400 Subject: [PATCH 18/91] Added help text and problem matcher Signed-off-by: dherrada --- .github/workflows/build.yml | 2 ++ .github/workflows/failure-help-text.yml | 19 +++++++++++++++++++ 2 files changed, 21 insertions(+) create mode 100644 .github/workflows/failure-help-text.yml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 3baf502..0ab7182 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -71,3 +71,5 @@ jobs: python setup.py sdist python setup.py bdist_wheel --universal twine check dist/* + - name: Setup problem matchers + uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 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 From f148efb2b3894958859e8f6e28de7e4a30517e4a Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 24 May 2021 09:54:31 -0400 Subject: [PATCH 19/91] Moved CI to Python 3.7 Signed-off-by: dherrada --- .github/workflows/build.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 0ab7182..c4c975d 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -22,10 +22,10 @@ jobs: awk -F '\/' '{ print tolower($2) }' | tr '_' '-' ) - - name: Set up Python 3.6 + - name: Set up Python 3.7 uses: actions/setup-python@v1 with: - python-version: 3.6 + python-version: 3.7 - name: Versions run: | python3 --version From 8d6ad2ee81a0906f7d66b95268c409ac56905da9 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 7 Jun 2021 13:13:06 -0400 Subject: [PATCH 20/91] Moved default branch to main --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 70169c8..259554e 100644 --- a/README.rst +++ b/README.rst @@ -67,7 +67,7 @@ Contributing ============ Contributions are welcome! Please read our `Code of Conduct -`_ +`_ before contributing to help this project stay welcoming. Documentation From e7a943ad4f0c3f17139b02d9eee42f160bbfa5bc Mon Sep 17 00:00:00 2001 From: James Carr Date: Sun, 4 Jul 2021 12:31:09 +0100 Subject: [PATCH 21/91] Include all examples in docs --- docs/examples.rst | 59 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) diff --git a/docs/examples.rst b/docs/examples.rst index f9a2c15..70b2e6a 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -6,3 +6,62 @@ 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: + +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: From 92e20ac0c366618cdee5677aa8e9955624191045 Mon Sep 17 00:00:00 2001 From: James Carr Date: Sun, 4 Jul 2021 12:31:48 +0100 Subject: [PATCH 22/91] Remove max_size parameter --- README.rst | 2 +- examples/st7789_240x135_pitft_simpletest.py | 3 +-- examples/st7789_240x135_simpletest.py | 3 +-- .../st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py | 3 +-- examples/st7789_240x240_bonnet_simpletest.py | 4 ++-- examples/st7789_240x240_pitft_simpletest.py | 4 ++-- examples/st7789_240x240_simpletest_Pimoroni_Pico_Explorer.py | 4 ++-- examples/st7789_320x240_simpletest.py | 4 ++-- examples/st7789_simpletest.py | 4 ++-- examples/st7789_tft_gizmo_simpletest.py | 4 ++-- 10 files changed, 16 insertions(+), 19 deletions(-) diff --git a/README.rst b/README.rst index 259554e..b16c3fd 100644 --- a/README.rst +++ b/README.rst @@ -48,7 +48,7 @@ Usage Example display = ST7789(display_bus, width=240, height=240, rowstart=80) # Make the display context - splash = displayio.Group(max_size=10) + splash = displayio.Group() display.show(splash) color_bitmap = displayio.Bitmap(240, 240, 1) diff --git a/examples/st7789_240x135_pitft_simpletest.py b/examples/st7789_240x135_pitft_simpletest.py index 3258799..5f2db09 100644 --- a/examples/st7789_240x135_pitft_simpletest.py +++ b/examples/st7789_240x135_pitft_simpletest.py @@ -33,7 +33,7 @@ ) # Make the display context -splash = displayio.Group(max_size=10) +splash = displayio.Group() display.show(splash) color_bitmap = displayio.Bitmap(display.width, display.height, 1) @@ -59,7 +59,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.py b/examples/st7789_240x135_simpletest.py index d6b52df..7d878ab 100644 --- a/examples/st7789_240x135_simpletest.py +++ b/examples/st7789_240x135_simpletest.py @@ -31,7 +31,7 @@ ) # Make the display context -splash = displayio.Group(max_size=10) +splash = displayio.Group() display.show(splash) color_bitmap = displayio.Bitmap(display.width, display.height, 1) @@ -57,7 +57,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 index a57babd..09f7505 100644 --- a/examples/st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py +++ b/examples/st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py @@ -30,7 +30,7 @@ ) # Make the display context -splash = displayio.Group(max_size=10) +splash = displayio.Group() display.show(splash) color_bitmap = displayio.Bitmap(display.width, display.height, 1) @@ -56,7 +56,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_240x240_bonnet_simpletest.py b/examples/st7789_240x240_bonnet_simpletest.py index 5101272..d208ca8 100644 --- a/examples/st7789_240x240_bonnet_simpletest.py +++ b/examples/st7789_240x240_bonnet_simpletest.py @@ -33,7 +33,7 @@ ) # Make the display context -splash = displayio.Group(max_size=10) +splash = displayio.Group() display.show(splash) color_bitmap = displayio.Bitmap(240, 240, 1) @@ -51,7 +51,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_240x240_pitft_simpletest.py b/examples/st7789_240x240_pitft_simpletest.py index e666c41..7df1753 100644 --- a/examples/st7789_240x240_pitft_simpletest.py +++ b/examples/st7789_240x240_pitft_simpletest.py @@ -25,7 +25,7 @@ display = ST7789(display_bus, width=240, height=240, rowstart=80, rotation=180) # Make the display context -splash = displayio.Group(max_size=10) +splash = displayio.Group() display.show(splash) color_bitmap = displayio.Bitmap(240, 240, 1) @@ -43,7 +43,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_240x240_simpletest_Pimoroni_Pico_Explorer.py b/examples/st7789_240x240_simpletest_Pimoroni_Pico_Explorer.py index bca0a53..67b0adf 100644 --- a/examples/st7789_240x240_simpletest_Pimoroni_Pico_Explorer.py +++ b/examples/st7789_240x240_simpletest_Pimoroni_Pico_Explorer.py @@ -26,7 +26,7 @@ display = ST7789(display_bus, width=240, height=240, rowstart=80, rotation=180) # Make the display context -splash = displayio.Group(max_size=10) +splash = displayio.Group() display.show(splash) color_bitmap = displayio.Bitmap(240, 240, 1) @@ -44,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_320x240_simpletest.py b/examples/st7789_320x240_simpletest.py index bf1e81d..3fac5aa 100644 --- a/examples/st7789_320x240_simpletest.py +++ b/examples/st7789_320x240_simpletest.py @@ -25,7 +25,7 @@ display = ST7789(display_bus, width=320, height=240, rotation=90) # Make the display context -splash = displayio.Group(max_size=10) +splash = displayio.Group() display.show(splash) color_bitmap = displayio.Bitmap(320, 240, 1) @@ -43,7 +43,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_simpletest.py b/examples/st7789_simpletest.py index b1a4672..990630e 100644 --- a/examples/st7789_simpletest.py +++ b/examples/st7789_simpletest.py @@ -25,7 +25,7 @@ display = ST7789(display_bus, width=240, height=240, rowstart=80) # Make the display context -splash = displayio.Group(max_size=10) +splash = displayio.Group() display.show(splash) color_bitmap = displayio.Bitmap(240, 240, 1) @@ -43,7 +43,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 3892684..0869521 100644 --- a/examples/st7789_tft_gizmo_simpletest.py +++ b/examples/st7789_tft_gizmo_simpletest.py @@ -32,7 +32,7 @@ ) # Make the display context -splash = displayio.Group(max_size=10) +splash = displayio.Group() display.show(splash) color_bitmap = displayio.Bitmap(240, 240, 1) @@ -50,7 +50,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 From dfd74acde215e76885bdacf935d415a7936b03e1 Mon Sep 17 00:00:00 2001 From: Melissa LeBlanc-Williams Date: Thu, 2 Sep 2021 13:57:30 -0700 Subject: [PATCH 23/91] Add 280x240 example --- docs/examples.rst | 7 ++++ examples/st7789_280x240_simpletest.py | 53 +++++++++++++++++++++++++++ 2 files changed, 60 insertions(+) create mode 100644 examples/st7789_280x240_simpletest.py diff --git a/docs/examples.rst b/docs/examples.rst index 70b2e6a..9ff1cdf 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -14,6 +14,13 @@ Ensure your device works with this simple test. :caption: examples/st7789_240x135_simpletest.py :linenos: +280x240 +======= + +.. literalinclude:: ../examples/st7789_280x240_simpletest.py + :caption: examples/st7789_280x240_simpletest.py + :linenos: + 320x240 ======= diff --git a/examples/st7789_280x240_simpletest.py b/examples/st7789_280x240_simpletest.py new file mode 100644 index 0000000..06047d6 --- /dev/null +++ b/examples/st7789_280x240_simpletest.py @@ -0,0 +1,53 @@ +# 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 terminalio +import displayio +from adafruit_display_text import label +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 = displayio.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() +display.show(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 From 46ce7f169451a8fc719f1afa957ff797a8fb657b Mon Sep 17 00:00:00 2001 From: Melissa LeBlanc-Williams Date: Thu, 2 Sep 2021 14:07:22 -0700 Subject: [PATCH 24/91] Update line endings to LF --- examples/st7789_280x240_simpletest.py | 106 +++++++++++++------------- 1 file changed, 53 insertions(+), 53 deletions(-) diff --git a/examples/st7789_280x240_simpletest.py b/examples/st7789_280x240_simpletest.py index 06047d6..3fac5aa 100644 --- a/examples/st7789_280x240_simpletest.py +++ b/examples/st7789_280x240_simpletest.py @@ -1,53 +1,53 @@ -# 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 terminalio -import displayio -from adafruit_display_text import label -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 = displayio.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() -display.show(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 +# 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 terminalio +import displayio +from adafruit_display_text import label +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 = displayio.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() +display.show(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 From 47c8f654c36ec162a5922d398315863109664788 Mon Sep 17 00:00:00 2001 From: Melissa LeBlanc-Williams Date: Thu, 2 Sep 2021 15:36:39 -0700 Subject: [PATCH 25/91] Fix the 280x240 example offsets --- examples/st7789_280x240_simpletest.py | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/examples/st7789_280x240_simpletest.py b/examples/st7789_280x240_simpletest.py index 3fac5aa..59ba1e3 100644 --- a/examples/st7789_280x240_simpletest.py +++ b/examples/st7789_280x240_simpletest.py @@ -15,20 +15,20 @@ displayio.release_displays() spi = board.SPI() -tft_cs = board.D5 -tft_dc = board.D6 +tft_cs = board.D10 +tft_dc = board.D8 display_bus = displayio.FourWire( spi, command=tft_dc, chip_select=tft_cs, reset=board.D9 ) -display = ST7789(display_bus, width=320, height=240, rotation=90) +display = ST7789(display_bus, width=280, height=240, rowstart=20, rotation=90) # Make the display context splash = displayio.Group() display.show(splash) -color_bitmap = displayio.Bitmap(320, 240, 1) +color_bitmap = displayio.Bitmap(280, 240, 1) color_palette = displayio.Palette(1) color_palette[0] = 0x00FF00 # Bright Green @@ -36,14 +36,14 @@ splash.append(bg_sprite) # Draw a smaller inner rectangle -inner_bitmap = displayio.Bitmap(280, 200, 1) +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=57, y=120) +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 From 9d05143aa60166e66ef869721f8b2c7444ebe4bb Mon Sep 17 00:00:00 2001 From: Melissa LeBlanc-Williams Date: Thu, 2 Sep 2021 15:37:38 -0700 Subject: [PATCH 26/91] Set back to feather pins --- examples/st7789_280x240_simpletest.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/st7789_280x240_simpletest.py b/examples/st7789_280x240_simpletest.py index 59ba1e3..926990d 100644 --- a/examples/st7789_280x240_simpletest.py +++ b/examples/st7789_280x240_simpletest.py @@ -15,8 +15,8 @@ displayio.release_displays() spi = board.SPI() -tft_cs = board.D10 -tft_dc = board.D8 +tft_cs = board.D5 +tft_dc = board.D6 display_bus = displayio.FourWire( spi, command=tft_dc, chip_select=tft_cs, reset=board.D9 From e035dd5d5ee0af2f5402355cdacf32373491a39d Mon Sep 17 00:00:00 2001 From: dherrada Date: Thu, 23 Sep 2021 17:52:55 -0400 Subject: [PATCH 27/91] Globally disabled consider-using-f-string pylint check Signed-off-by: dherrada --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 354c761..8810708 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -30,5 +30,5 @@ repos: name: pylint (examples code) description: Run pylint rules on "examples/*.py" files entry: /usr/bin/env bash -c - args: ['([[ ! -d "examples" ]] || for example in $(find . -path "./examples/*.py"); do pylint --disable=missing-docstring,invalid-name $example; done)'] + args: ['([[ ! -d "examples" ]] || for example in $(find . -path "./examples/*.py"); do pylint --disable=missing-docstring,invalid-name,consider-using-f-string $example; done)'] language: system From a90dc2960986fe8cb215ac9c3b7a1a4050d37f58 Mon Sep 17 00:00:00 2001 From: helgibbons <50950368+helgibbons@users.noreply.github.com> Date: Thu, 7 Oct 2021 19:02:26 +0100 Subject: [PATCH 28/91] Add ST7789 example for Pimoroni Pico Display Pack 2.0 --- docs/examples.rst | 7 +++ ...40_simpletest_Pimoroni_Pico_Display_2_0.py | 57 +++++++++++++++++++ 2 files changed, 64 insertions(+) create mode 100644 examples/st7789_320x240_simpletest_Pimoroni_Pico_Display_2_0.py diff --git a/docs/examples.rst b/docs/examples.rst index 9ff1cdf..dbbc509 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -72,3 +72,10 @@ 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: 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..d88d91d --- /dev/null +++ b/examples/st7789_320x240_simpletest_Pimoroni_Pico_Display_2_0.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 terminalio +import displayio +from adafruit_display_text import label +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 = displayio.FourWire(spi, command=tft_dc, chip_select=tft_cs) + +display = ST7789( + display_bus, rotation=270, width=320, height=240, backlight_pin=backlight +) + +# Make the display context +splash = displayio.Group() +display.show(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 From f48828f71adc37ce456969cc139f81f5d81aae69 Mon Sep 17 00:00:00 2001 From: helgibbons <50950368+helgibbons@users.noreply.github.com> Date: Fri, 8 Oct 2021 09:14:05 +0100 Subject: [PATCH 29/91] Update examples.rst --- docs/examples.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/examples.rst b/docs/examples.rst index dbbc509..9f6b5fd 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -74,7 +74,7 @@ Pimoroni Pico Explorer :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 From 7397050a20b0f7b0205a76ad272238713ff451a1 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 25 Oct 2021 11:23:23 -0500 Subject: [PATCH 30/91] add docs link to readme --- README.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.rst b/README.rst index b16c3fd..c18cd85 100644 --- a/README.rst +++ b/README.rst @@ -63,6 +63,11 @@ Usage Example while True: pass +Documentation +============= + +API documentation for this library can be found on `Read the Docs `_. + Contributing ============ From 7f4c79538e98847ce7e0126de717fe62d258efb5 Mon Sep 17 00:00:00 2001 From: dherrada Date: Wed, 3 Nov 2021 14:40:16 -0400 Subject: [PATCH 31/91] PATCH Pylint and readthedocs patch test Signed-off-by: dherrada --- .github/workflows/build.yml | 4 ++-- .pre-commit-config.yaml | 26 +++++++++++++++++--------- .pylintrc | 2 +- .readthedocs.yml | 2 +- docs/requirements.txt | 5 +++++ 5 files changed, 26 insertions(+), 13 deletions(-) create mode 100644 docs/requirements.txt diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index c4c975d..ca35544 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -42,9 +42,9 @@ jobs: # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.) run: | source actions-ci/install.sh - - name: Pip install pylint, Sphinx, pre-commit + - name: Pip install Sphinx, pre-commit run: | - pip install --force-reinstall pylint Sphinx sphinx-rtd-theme pre-commit + pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit - name: Library version run: git describe --dirty --always --tags - name: Pre-commit hooks diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 8810708..1b9fadc 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -18,17 +18,25 @@ repos: - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: pylint-2.7.1 + rev: v2.11.1 hooks: - id: pylint name: pylint (library code) types: [python] - exclude: "^(docs/|examples/|setup.py$)" -- repo: local - hooks: - - id: pylint_examples - name: pylint (examples code) + args: + - --disable=consider-using-f-string + exclude: "^(docs/|examples/|tests/|setup.py$)" + - id: pylint + name: pylint (example code) description: Run pylint rules on "examples/*.py" files - entry: /usr/bin/env bash -c - args: ['([[ ! -d "examples" ]] || for example in $(find . -path "./examples/*.py"); do pylint --disable=missing-docstring,invalid-name,consider-using-f-string $example; done)'] - language: system + types: [python] + files: "^examples/" + args: + - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code + - id: pylint + name: pylint (test code) + description: Run pylint rules on "tests/*.py" files + types: [python] + files: "^tests/" + args: + - --disable=missing-docstring,consider-using-f-string,duplicate-code diff --git a/.pylintrc b/.pylintrc index 0238b90..e78bad2 100644 --- a/.pylintrc +++ b/.pylintrc @@ -252,7 +252,7 @@ ignore-docstrings=yes ignore-imports=yes # Minimum lines number of a similarity. -min-similarity-lines=12 +min-similarity-lines=4 [BASIC] diff --git a/.readthedocs.yml b/.readthedocs.yml index ffa84c4..49dcab3 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -4,4 +4,4 @@ python: version: 3 -requirements_file: requirements.txt +requirements_file: docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..88e6733 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,5 @@ +# SPDX-FileCopyrightText: 2021 Kattni Rembor for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +sphinx>=4.0.0 From 09798755edff53c4a2128f2abf1e591541a36674 Mon Sep 17 00:00:00 2001 From: dherrada Date: Fri, 5 Nov 2021 14:49:30 -0400 Subject: [PATCH 32/91] Disabled unspecified-encoding pylint check Signed-off-by: dherrada --- .pylintrc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pylintrc b/.pylintrc index e78bad2..cfd1c41 100644 --- a/.pylintrc +++ b/.pylintrc @@ -55,7 +55,7 @@ confidence= # 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 +disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation,unspecified-encoding # Enable the message, report, category or checker with the given id(s). You can # either give multiple identifier separated by comma (,) or put this option From c5b480434de8fa56d8ba978a57cd3919fdc9da2a Mon Sep 17 00:00:00 2001 From: dherrada Date: Tue, 9 Nov 2021 13:31:14 -0500 Subject: [PATCH 33/91] Updated readthedocs file Signed-off-by: dherrada --- .readthedocs.yaml | 15 +++++++++++++++ .readthedocs.yml | 7 ------- 2 files changed, 15 insertions(+), 7 deletions(-) create mode 100644 .readthedocs.yaml delete mode 100644 .readthedocs.yml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..95ec218 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,15 @@ +# 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 + +python: + version: "3.6" + install: + - requirements: docs/requirements.txt + - requirements: requirements.txt diff --git a/.readthedocs.yml b/.readthedocs.yml deleted file mode 100644 index 49dcab3..0000000 --- a/.readthedocs.yml +++ /dev/null @@ -1,7 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -python: - version: 3 -requirements_file: docs/requirements.txt From bc574d2633c1e7d255b47b2e72880c97caf52bcb Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 23 Nov 2021 13:09:04 -0600 Subject: [PATCH 34/91] update rtd py version --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 95ec218..1335112 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,7 +9,7 @@ version: 2 python: - version: "3.6" + version: "3.7" install: - requirements: docs/requirements.txt - requirements: requirements.txt From bb8d4602ce039362a72e0ddc88dd387016493f01 Mon Sep 17 00:00:00 2001 From: dherrada Date: Thu, 13 Jan 2022 16:27:30 -0500 Subject: [PATCH 35/91] First part of patch Signed-off-by: dherrada --- .../PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md | 2 +- .github/workflows/build.yml | 6 +++--- .github/workflows/release.yml | 8 ++++---- .readthedocs.yaml | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md index 71ef8f8..8de294e 100644 --- a/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md +++ b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md @@ -4,7 +4,7 @@ Thank you for contributing! Before you submit a pull request, please read the following. -Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://circuitpython.readthedocs.io/en/latest/docs/design_guide.html +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 diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index ca35544..474520d 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -22,10 +22,10 @@ jobs: awk -F '\/' '{ print tolower($2) }' | tr '_' '-' ) - - name: Set up Python 3.7 - uses: actions/setup-python@v1 + - name: Set up Python 3.x + uses: actions/setup-python@v2 with: - python-version: 3.7 + python-version: "3.x" - name: Versions run: | python3 --version diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 6d0015a..a65e5de 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -24,10 +24,10 @@ jobs: awk -F '\/' '{ print tolower($2) }' | tr '_' '-' ) - - name: Set up Python 3.6 - uses: actions/setup-python@v1 + - name: Set up Python 3.x + uses: actions/setup-python@v2 with: - python-version: 3.6 + python-version: "3.x" - name: Versions run: | python3 --version @@ -67,7 +67,7 @@ jobs: 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 + uses: actions/setup-python@v2 with: python-version: '3.x' - name: Install dependencies diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 1335112..f8b2891 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,7 +9,7 @@ version: 2 python: - version: "3.7" + version: "3.x" install: - requirements: docs/requirements.txt - requirements: requirements.txt From 0ee3fa18ddd33994d6f6a86d7fc06552383d824b Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 24 Jan 2022 16:46:17 -0500 Subject: [PATCH 36/91] Updated docs link, updated python docs link, updated setup.py --- README.rst | 4 ++-- docs/conf.py | 4 ++-- docs/index.rst | 2 +- setup.py | 2 -- 4 files changed, 5 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index c18cd85..a4d7cab 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,7 @@ 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 @@ -66,7 +66,7 @@ Usage Example Documentation ============= -API documentation for this library can be found on `Read the Docs `_. +API documentation for this library can be found on `Read the Docs `_. Contributing ============ diff --git a/docs/conf.py b/docs/conf.py index 077875b..df6edd0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -29,8 +29,8 @@ autodoc_mock_imports = ["displayio"] 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. diff --git a/docs/index.rst b/docs/index.rst index 734d593..6c0fb4f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -42,7 +42,7 @@ Table of Contents :caption: Other Links Download - CircuitPython Reference Documentation + CircuitPython Reference Documentation CircuitPython Support Forum Discord Chat Adafruit Learning System diff --git a/setup.py b/setup.py index 8cbf9b2..bfe5116 100644 --- a/setup.py +++ b/setup.py @@ -46,8 +46,6 @@ "Topic :: System :: Hardware", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.4", - "Programming Language :: Python :: 3.5", ], # What does your project relate to? keywords="adafruit blinka circuitpython micropython st7789 display tft lcd displayio", From a3974d5e197d2f5d0d4bcf4ebf364b26319e79ec Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Wed, 9 Feb 2022 13:10:27 -0500 Subject: [PATCH 37/91] Consolidate Documentation sections of README --- README.rst | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index a4d7cab..3191038 100644 --- a/README.rst +++ b/README.rst @@ -68,14 +68,11 @@ 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 `_. From 5952b34ab132eb15ed92b600090d39556dfa2a2d Mon Sep 17 00:00:00 2001 From: Malcolm Lashley Date: Fri, 11 Feb 2022 15:25:20 +0000 Subject: [PATCH 38/91] Add example for Waveshare Pico LCD 1.3 --- docs/examples.rst | 7 +++ ...40x240_simpletest_Waveshare_PicoLCD_1_3.py | 58 +++++++++++++++++++ 2 files changed, 65 insertions(+) create mode 100644 examples/st7789_240x240_simpletest_Waveshare_PicoLCD_1_3.py diff --git a/docs/examples.rst b/docs/examples.rst index 9f6b5fd..80de595 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -79,3 +79,10 @@ 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/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..8c6ffb1 --- /dev/null +++ b/examples/st7789_240x240_simpletest_Waveshare_PicoLCD_1_3.py @@ -0,0 +1,58 @@ +# 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 terminalio +import displayio +from adafruit_display_text import label +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 = displayio.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.show(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 From ba2b01fd06a0e9c0705bef32ebf5444da70ec45c Mon Sep 17 00:00:00 2001 From: Malcolm Lashley Date: Fri, 11 Feb 2022 15:35:05 +0000 Subject: [PATCH 39/91] Fix according to CI's coding style demands --- .../st7789_240x240_simpletest_Waveshare_PicoLCD_1_3.py | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/examples/st7789_240x240_simpletest_Waveshare_PicoLCD_1_3.py b/examples/st7789_240x240_simpletest_Waveshare_PicoLCD_1_3.py index 8c6ffb1..c379bb1 100644 --- a/examples/st7789_240x240_simpletest_Waveshare_PicoLCD_1_3.py +++ b/examples/st7789_240x240_simpletest_Waveshare_PicoLCD_1_3.py @@ -26,7 +26,12 @@ display_bus = displayio.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 + display_bus, + rotation=270, + width=240, + height=240, + rowstart=80, + backlight_pin=backlight, ) # Make the display context From 79c70a49285be8b6548de3f5ca20aa5ac1fafa22 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 14 Feb 2022 15:35:02 -0500 Subject: [PATCH 40/91] Fixed readthedocs build Signed-off-by: dherrada --- .readthedocs.yaml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index f8b2891..33c2a61 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,8 +8,12 @@ # Required version: 2 +build: + os: ubuntu-20.04 + tools: + python: "3" + python: - version: "3.x" install: - requirements: docs/requirements.txt - requirements: requirements.txt From 59bbfc20b2d05e4608b5411f2ea59b0b6ca730bf Mon Sep 17 00:00:00 2001 From: Melissa LeBlanc-Williams Date: Wed, 16 Mar 2022 09:48:44 -0700 Subject: [PATCH 41/91] Add examples for 1.47 and 1.9 displays --- examples/st7789_170x320_1.9_simpletest.py | 60 ++++++++++++++++++++++ examples/st7789_172x320_1.47_simpletest.py | 60 ++++++++++++++++++++++ 2 files changed, 120 insertions(+) create mode 100644 examples/st7789_170x320_1.9_simpletest.py create mode 100644 examples/st7789_172x320_1.47_simpletest.py diff --git a/examples/st7789_170x320_1.9_simpletest.py b/examples/st7789_170x320_1.9_simpletest.py new file mode 100644 index 0000000..553c4c7 --- /dev/null +++ b/examples/st7789_170x320_1.9_simpletest.py @@ -0,0 +1,60 @@ +# 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 terminalio +import displayio +from adafruit_display_text import label +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 = displayio.FourWire( + spi, command=tft_dc, chip_select=tft_cs, reset=tft_rst +) + +display = ST7789(display_bus, width=320, height=170, colstart=34, rotation=90) + +# Make the display context +splash = displayio.Group() +display.show(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..2a26f61 --- /dev/null +++ b/examples/st7789_172x320_1.47_simpletest.py @@ -0,0 +1,60 @@ +# 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 terminalio +import displayio +from adafruit_display_text import label +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 = displayio.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.show(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 From 973d4f3240ce2ec25d11410ad35f9c61eb7c1523 Mon Sep 17 00:00:00 2001 From: Melissa LeBlanc-Williams Date: Wed, 16 Mar 2022 09:49:58 -0700 Subject: [PATCH 42/91] Run pre-commit and fix line endings --- examples/st7789_170x320_1.9_simpletest.py | 16 +++++++++------- examples/st7789_172x320_1.47_simpletest.py | 16 +++++++++------- 2 files changed, 18 insertions(+), 14 deletions(-) diff --git a/examples/st7789_170x320_1.9_simpletest.py b/examples/st7789_170x320_1.9_simpletest.py index 553c4c7..48b016a 100644 --- a/examples/st7789_170x320_1.9_simpletest.py +++ b/examples/st7789_170x320_1.9_simpletest.py @@ -22,9 +22,7 @@ tft_dc = board.D6 tft_rst = board.D9 -display_bus = displayio.FourWire( - spi, command=tft_dc, chip_select=tft_cs, reset=tft_rst -) +display_bus = displayio.FourWire(spi, command=tft_dc, chip_select=tft_cs, reset=tft_rst) display = ST7789(display_bus, width=320, height=170, colstart=34, rotation=90) @@ -39,20 +37,24 @@ 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_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) +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, + terminalio.FONT, text="Hello World!", color=0xFFFF00, scale=TEXT_SCALE, anchor_point=(0.5, 0.5), - anchored_position=(display.width // 2, display.height // 2) + anchored_position=(display.width // 2, display.height // 2), ) splash.append(text_area) diff --git a/examples/st7789_172x320_1.47_simpletest.py b/examples/st7789_172x320_1.47_simpletest.py index 2a26f61..4d3133b 100644 --- a/examples/st7789_172x320_1.47_simpletest.py +++ b/examples/st7789_172x320_1.47_simpletest.py @@ -22,9 +22,7 @@ tft_dc = board.D6 tft_rst = board.D9 -display_bus = displayio.FourWire( - spi, command=tft_dc, chip_select=tft_cs, reset=tft_rst -) +display_bus = displayio.FourWire(spi, command=tft_dc, chip_select=tft_cs, reset=tft_rst) display = ST7789(display_bus, width=320, height=172, colstart=34, rotation=270) @@ -39,20 +37,24 @@ 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_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) +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, + terminalio.FONT, text="Hello World!", color=0xFFFF00, scale=TEXT_SCALE, anchor_point=(0.5, 0.5), - anchored_position=(display.width // 2, display.height // 2) + anchored_position=(display.width // 2, display.height // 2), ) splash.append(text_area) From d0588d9baf4c9044352323163cc5b16bf9214911 Mon Sep 17 00:00:00 2001 From: Melissa LeBlanc-Williams Date: Wed, 16 Mar 2022 13:58:46 -0700 Subject: [PATCH 43/91] Fix offset for 1.9 display example --- examples/st7789_170x320_1.9_simpletest.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/st7789_170x320_1.9_simpletest.py b/examples/st7789_170x320_1.9_simpletest.py index 48b016a..10d854a 100644 --- a/examples/st7789_170x320_1.9_simpletest.py +++ b/examples/st7789_170x320_1.9_simpletest.py @@ -24,7 +24,7 @@ display_bus = displayio.FourWire(spi, command=tft_dc, chip_select=tft_cs, reset=tft_rst) -display = ST7789(display_bus, width=320, height=170, colstart=34, rotation=90) +display = ST7789(display_bus, width=320, height=170, colstart=35, rotation=90) # Make the display context splash = displayio.Group() From f3101209ee6a239a1c4d10a7a7a7d56105823d50 Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Mon, 28 Mar 2022 15:52:04 -0400 Subject: [PATCH 44/91] Update Black to latest. Signed-off-by: Kattni Rembor --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 1b9fadc..7467c1d 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -4,7 +4,7 @@ repos: - repo: https://github.com/python/black - rev: 20.8b1 + rev: 22.3.0 hooks: - id: black - repo: https://github.com/fsfe/reuse-tool From 6f9c037da05401a26b8a4af3ad7b7bd0f4099e42 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Thu, 21 Apr 2022 15:00:27 -0400 Subject: [PATCH 45/91] Updated gitignore Signed-off-by: evaherrada --- .gitignore | 48 ++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 40 insertions(+), 8 deletions(-) diff --git a/.gitignore b/.gitignore index 9647e71..544ec4a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,15 +1,47 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Kattni Rembor, written for Adafruit Industries # -# SPDX-License-Identifier: Unlicense +# SPDX-License-Identifier: MIT +# Do not include files and directories created by your personal work environment, such as the IDE +# you use, except for those already listed here. Pull requests including changes to this file will +# not be accepted. + +# This .gitignore file contains rules for files generated by working with CircuitPython libraries, +# including building Sphinx, testing with pip, and creating a virual environment, as well as the +# MacOS and IDE-specific files generated by using MacOS in general, or the PyCharm or VSCode IDEs. + +# If you find that there are files being generated on your machine that should not be included in +# your git commit, you should create a .gitignore_global file on your computer to include the +# files created by your personal setup. To do so, follow the two steps below. + +# First, create a file called .gitignore_global somewhere convenient for you, and add rules for +# the files you want to exclude from git commits. + +# Second, configure Git to use the exclude file for all Git repositories by running the +# following via commandline, replacing "path/to/your/" with the actual path to your newly created +# .gitignore_global file: +# git config --global core.excludesfile path/to/your/.gitignore_global + +# CircuitPython-specific files *.mpy -.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 + +# MacOS-specific files *.DS_Store -.eggs -dist -**/*.egg-info + +# IDE-specific files +.idea +.vscode +*~ From f0d42172b9763b0331c1a2e9a4d5802ad6e6a399 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Fri, 22 Apr 2022 15:59:23 -0400 Subject: [PATCH 46/91] Patch: Replaced discord badge image --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 3191038..f73fd35 100644 --- a/README.rst +++ b/README.rst @@ -5,7 +5,7 @@ Introduction :target: https://docs.circuitpython.org/projects/st7789/en/latest/ :alt: Documentation Status -.. image:: https://img.shields.io/discord/327254708534116352.svg +.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Bundle/blob/main/badges/adafruit_discord.svg :target: https://adafru.it/discord :alt: Discord From 587da54921c6cc92951bea22e2b8879e12fa1005 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sun, 24 Apr 2022 13:58:42 -0500 Subject: [PATCH 47/91] change discord badge --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index f73fd35..a38446d 100644 --- a/README.rst +++ b/README.rst @@ -5,7 +5,7 @@ Introduction :target: https://docs.circuitpython.org/projects/st7789/en/latest/ :alt: Documentation Status -.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Bundle/blob/main/badges/adafruit_discord.svg +.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg :target: https://adafru.it/discord :alt: Discord From 6bdd9de20cc26d456591bb698e832bacf982e2c1 Mon Sep 17 00:00:00 2001 From: Matthew Blau Date: Mon, 2 May 2022 09:07:10 -0600 Subject: [PATCH 48/91] added type annotation None --- adafruit_st7789.py | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/adafruit_st7789.py b/adafruit_st7789.py index 3b34441..bca7f24 100755 --- a/adafruit_st7789.py +++ b/adafruit_st7789.py @@ -41,7 +41,6 @@ """ import displayio - __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_ST7789.git" @@ -60,5 +59,5 @@ class ST7789(displayio.Display): """ST7789 driver""" - def __init__(self, bus, **kwargs): + def __init__(self, bus, **kwargs) -> None: super().__init__(bus, _INIT_SEQUENCE, **kwargs) From fb6a52f6a397c6e6d1239cf2099f9df2f451420b Mon Sep 17 00:00:00 2001 From: Matthew Blau Date: Mon, 2 May 2022 09:13:50 -0600 Subject: [PATCH 49/91] Re-added the space back --- adafruit_st7789.py | 1 + 1 file changed, 1 insertion(+) diff --git a/adafruit_st7789.py b/adafruit_st7789.py index bca7f24..b403375 100755 --- a/adafruit_st7789.py +++ b/adafruit_st7789.py @@ -41,6 +41,7 @@ """ import displayio + __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_ST7789.git" From 1fab22a37553d1f9c012e31ad8484590d4b9f283 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 15 May 2022 12:20:32 -0400 Subject: [PATCH 50/91] Patch .pre-commit-config.yaml --- .pre-commit-config.yaml | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 7467c1d..3343606 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -3,40 +3,40 @@ # SPDX-License-Identifier: Unlicense repos: -- repo: https://github.com/python/black + - repo: https://github.com/python/black rev: 22.3.0 hooks: - - id: black -- repo: https://github.com/fsfe/reuse-tool - rev: v0.12.1 + - id: black + - repo: https://github.com/fsfe/reuse-tool + rev: v0.14.0 hooks: - - id: reuse -- repo: https://github.com/pre-commit/pre-commit-hooks - rev: v2.3.0 + - id: reuse + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.2.0 hooks: - - id: check-yaml - - id: end-of-file-fixer - - id: trailing-whitespace -- repo: https://github.com/pycqa/pylint + - id: check-yaml + - id: end-of-file-fixer + - id: trailing-whitespace + - repo: https://github.com/pycqa/pylint rev: v2.11.1 hooks: - - id: pylint + - id: pylint name: pylint (library code) types: [python] args: - --disable=consider-using-f-string exclude: "^(docs/|examples/|tests/|setup.py$)" - - id: pylint + - id: pylint name: pylint (example code) description: Run pylint rules on "examples/*.py" files types: [python] files: "^examples/" args: - - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code - - id: pylint + - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code + - id: pylint name: pylint (test code) description: Run pylint rules on "tests/*.py" files types: [python] files: "^tests/" args: - - --disable=missing-docstring,consider-using-f-string,duplicate-code + - --disable=missing-docstring,consider-using-f-string,duplicate-code From 05ebfb666b4bdb3d12b73f151d1ca40bf9bd5210 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 22 May 2022 00:18:55 -0400 Subject: [PATCH 51/91] Increase min lines similarity Signed-off-by: Alec Delaney --- .pylintrc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pylintrc b/.pylintrc index cfd1c41..f006a4a 100644 --- a/.pylintrc +++ b/.pylintrc @@ -252,7 +252,7 @@ ignore-docstrings=yes ignore-imports=yes # Minimum lines number of a similarity. -min-similarity-lines=4 +min-similarity-lines=12 [BASIC] From 1f2f2b6e87acf85c638185e7da89e6f48c72e16a Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 22 May 2022 00:18:23 -0400 Subject: [PATCH 52/91] Switch to inclusive terminology Signed-off-by: Alec Delaney --- .pylintrc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.pylintrc b/.pylintrc index f006a4a..f772971 100644 --- a/.pylintrc +++ b/.pylintrc @@ -9,11 +9,11 @@ # run arbitrary code extension-pkg-whitelist= -# Add files or directories to the blacklist. They should be base names, not +# Add files or directories to the ignore-list. They should be base names, not # paths. ignore=CVS -# Add files or directories matching the regex patterns to the blacklist. The +# Add files or directories matching the regex patterns to the ignore-list. The # regex matches against base names, not paths. ignore-patterns= From 4af38209c12f9a34857e2a1077c70681f2a0d5f5 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 30 May 2022 14:25:04 -0400 Subject: [PATCH 53/91] Set language to "en" for documentation Signed-off-by: Alec Delaney --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index df6edd0..cc27e2e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -60,7 +60,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. From 995959d5dca23fbe49590700d1aa26a96dca1df7 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Tue, 7 Jun 2022 15:35:03 -0400 Subject: [PATCH 54/91] Added cp.org link to index.rst --- docs/index.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 6c0fb4f..7ad488f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -41,7 +41,8 @@ Table of Contents .. toctree:: :caption: Other Links - Download + Download from GitHub + Download Library Bundle CircuitPython Reference Documentation CircuitPython Support Forum Discord Chat From 4161cc6aca6aa865d9dc30a788720575aa0e93a3 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Tue, 2 Aug 2022 17:01:07 -0400 Subject: [PATCH 55/91] Added Black formatting badge --- README.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.rst b/README.rst index a38446d..a5d272d 100644 --- a/README.rst +++ b/README.rst @@ -13,6 +13,10 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_ST7789/actions/ :alt: Build Status +.. image:: https://img.shields.io/badge/code%20style-black-000000.svg + :target: https://github.com/psf/black + :alt: Code Style: Black + displayio driver for ST7789 TFT-LCD displays. Dependencies From b893ae1b070708f90c80dc8dd8d10078cb88acae Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 8 Aug 2022 22:05:53 -0400 Subject: [PATCH 56/91] Switched to pyproject.toml --- .github/workflows/build.yml | 18 +++++++----- .github/workflows/release.yml | 17 ++++++----- optional_requirements.txt | 3 ++ pyproject.toml | 47 ++++++++++++++++++++++++++++++ requirements.txt | 2 +- setup.py | 55 ----------------------------------- 6 files changed, 71 insertions(+), 71 deletions(-) create mode 100644 optional_requirements.txt create mode 100644 pyproject.toml delete mode 100644 setup.py diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 474520d..22f6582 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -47,6 +47,8 @@ jobs: pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit - name: Library version run: git describe --dirty --always --tags + - name: Setup problem matchers + uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 - name: Pre-commit hooks run: | pre-commit run --all-files @@ -60,16 +62,16 @@ jobs: - name: Build docs working-directory: docs run: sphinx-build -E -W -b html . _build/html - - name: Check For setup.py + - name: Check For pyproject.toml id: need-pypi run: | - echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) + echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) - name: Build Python package - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') run: | - pip install --upgrade setuptools wheel twine readme_renderer testresources - python setup.py sdist - python setup.py bdist_wheel --universal + pip install --upgrade build twine + for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do + sed -i -e "s/0.0.0-auto.0/1.2.3/" $file; + done; + python -m build twine check dist/* - - name: Setup problem matchers - uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index a65e5de..d1b4f8d 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -61,25 +61,28 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v1 - - name: Check For setup.py + - name: Check For pyproject.toml id: need-pypi run: | - echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) + echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) - name: Set up Python - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') uses: actions/setup-python@v2 with: python-version: '3.x' - name: Install dependencies - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') run: | python -m pip install --upgrade pip - pip install setuptools wheel twine + pip install --upgrade build twine - name: Build and publish - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') env: TWINE_USERNAME: ${{ secrets.pypi_username }} TWINE_PASSWORD: ${{ secrets.pypi_password }} run: | - python setup.py sdist + for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do + sed -i -e "s/0.0.0-auto.0/${{github.event.release.tag_name}}/" $file; + done; + python -m build twine upload dist/* 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..688b5fe --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,47 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +[build-system] +requires = [ + "setuptools", + "wheel", +] + +[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 44cdfd8..274b851 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries # # SPDX-License-Identifier: Unlicense diff --git a/setup.py b/setup.py deleted file mode 100644 index bfe5116..0000000 --- a/setup.py +++ /dev/null @@ -1,55 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -"""A setuptools based setup module. -See: -https://packaging.python.org/en/latest/distributing.html -https://github.com/pypa/sampleproject -""" - -from setuptools import setup, find_packages - -# To use a consistent encoding -from codecs import open -from os import path - -here = path.abspath(path.dirname(__file__)) - -# Get the long description from the README file -with open(path.join(here, "README.rst"), encoding="utf-8") as f: - long_description = f.read() - -setup( - name="adafruit-circuitpython-st7789", - use_scm_version=True, - setup_requires=["setuptools_scm"], - description="displayio driver for ST7789 TFT-LCD displays.", - long_description=long_description, - long_description_content_type="text/x-rst", - # The project's main homepage. - url="https://github.com/adafruit/Adafruit_CircuitPython_ST7789", - # Author details - author="Adafruit Industries", - author_email="circuitpython@adafruit.com", - install_requires=[ - "Adafruit-Blinka", - "adafruit-blinka-displayio", - ], - # Choose your license - license="MIT", - # See https://pypi.python.org/pypi?%3Aaction=list_classifiers - classifiers=[ - "Development Status :: 3 - Alpha", - "Intended Audience :: Developers", - "Topic :: Software Development :: Libraries", - "Topic :: System :: Hardware", - "License :: OSI Approved :: MIT License", - "Programming Language :: Python :: 3", - ], - # What does your project relate to? - keywords="adafruit blinka circuitpython micropython st7789 display tft lcd displayio", - # You can just specify the packages manually here if your project is - # simple. Or you can use find_packages(). - py_modules=["adafruit_st7789"], -) From 4a094ea8e0ca902e7c61822060e149d73fa18ce5 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 9 Aug 2022 12:03:54 -0400 Subject: [PATCH 57/91] Add setuptools-scm to build system requirements Signed-off-by: Alec Delaney --- pyproject.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/pyproject.toml b/pyproject.toml index 688b5fe..7f01228 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,6 +6,7 @@ requires = [ "setuptools", "wheel", + "setuptools-scm", ] [project] From 64e02070e1053db6655a77be299d0304a21776e2 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 16 Aug 2022 18:09:14 -0400 Subject: [PATCH 58/91] Update version string --- adafruit_st7789.py | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_st7789.py b/adafruit_st7789.py index b403375..66a539c 100755 --- a/adafruit_st7789.py +++ b/adafruit_st7789.py @@ -42,7 +42,7 @@ import displayio -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_ST7789.git" _INIT_SEQUENCE = ( diff --git a/pyproject.toml b/pyproject.toml index 7f01228..864e7a8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -12,7 +12,7 @@ requires = [ [project] name = "adafruit-circuitpython-st7789" description = "displayio driver for ST7789 TFT-LCD displays." -version = "0.0.0-auto.0" +version = "0.0.0+auto.0" readme = "README.rst" authors = [ {name = "Adafruit Industries", email = "circuitpython@adafruit.com"} From a8f2c7d1bd111890a9bf5759d9e327e91f7bf1f4 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 16 Aug 2022 21:09:14 -0400 Subject: [PATCH 59/91] Fix version strings in workflow files --- .github/workflows/build.yml | 2 +- .github/workflows/release.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 22f6582..cb2f60e 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -71,7 +71,7 @@ jobs: run: | pip install --upgrade build twine for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do - sed -i -e "s/0.0.0-auto.0/1.2.3/" $file; + sed -i -e "s/0.0.0+auto.0/1.2.3/" $file; done; python -m build twine check dist/* diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index d1b4f8d..f3a0325 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -82,7 +82,7 @@ jobs: TWINE_PASSWORD: ${{ secrets.pypi_password }} run: | for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do - sed -i -e "s/0.0.0-auto.0/${{github.event.release.tag_name}}/" $file; + sed -i -e "s/0.0.0+auto.0/${{github.event.release.tag_name}}/" $file; done; python -m build twine upload dist/* From 48efe8446393ae4384909456b889abb589a45ea8 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 22 Aug 2022 21:36:31 -0400 Subject: [PATCH 60/91] Keep copyright up to date in documentation --- docs/conf.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index cc27e2e..16df3e0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -6,6 +6,7 @@ import os import sys +import datetime sys.path.insert(0, os.path.abspath("..")) @@ -43,7 +44,8 @@ # General information about the project. project = "Adafruit ST7789 Library" -copyright = "2019 Melissa LeBlanc-Williams" +current_year = str(datetime.datetime.now().year) +copyright = current_year + " Melissa LeBlanc-Williams" author = "Melissa LeBlanc-Williams" # The version info for the project you're documenting, acts as replacement for From ae5e51d173812e770e847170adfa7f4e3c48b873 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 23 Aug 2022 17:26:21 -0400 Subject: [PATCH 61/91] Use year duration range for copyright attribution --- docs/conf.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 16df3e0..e9712e0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -44,8 +44,14 @@ # General information about the project. project = "Adafruit ST7789 Library" +creation_year = "2019" current_year = str(datetime.datetime.now().year) -copyright = current_year + " Melissa LeBlanc-Williams" +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 From 34d3a00b7f51a0565b5412252fd15ed4b3765839 Mon Sep 17 00:00:00 2001 From: Thomas Franks Date: Thu, 8 Sep 2022 10:09:45 -0400 Subject: [PATCH 62/91] Added FourWire to bus type to complete annotations --- adafruit_st7789.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_st7789.py b/adafruit_st7789.py index 66a539c..68d7a78 100755 --- a/adafruit_st7789.py +++ b/adafruit_st7789.py @@ -60,5 +60,5 @@ class ST7789(displayio.Display): """ST7789 driver""" - def __init__(self, bus, **kwargs) -> None: + def __init__(self, bus: displayio.FourWire, **kwargs) -> None: super().__init__(bus, _INIT_SEQUENCE, **kwargs) From 8375efe7ea8e1727bcdad7b80297ba1f7ab8fe47 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 00:02:50 -0400 Subject: [PATCH 63/91] Switching to composite actions --- .github/workflows/build.yml | 67 +---------------------- .github/workflows/release.yml | 88 ------------------------------ .github/workflows/release_gh.yml | 14 +++++ .github/workflows/release_pypi.yml | 14 +++++ 4 files changed, 30 insertions(+), 153 deletions(-) delete mode 100644 .github/workflows/release.yml create mode 100644 .github/workflows/release_gh.yml create mode 100644 .github/workflows/release_pypi.yml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index cb2f60e..041a337 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -10,68 +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.x - uses: actions/setup-python@v2 - with: - python-version: "3.x" - - name: Versions - run: | - python3 --version - - name: Checkout Current Repo - uses: actions/checkout@v1 - with: - submodules: true - - name: Checkout tools repo - uses: actions/checkout@v2 - with: - repository: adafruit/actions-ci-circuitpython-libs - path: actions-ci - - name: Install dependencies - # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.) - run: | - source actions-ci/install.sh - - name: Pip install Sphinx, pre-commit - run: | - pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit - - name: Library version - run: git describe --dirty --always --tags - - name: Setup problem matchers - uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 - - name: Pre-commit hooks - run: | - pre-commit run --all-files - - name: Build assets - run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - - name: Archive bundles - uses: actions/upload-artifact@v2 - with: - name: bundles - path: ${{ github.workspace }}/bundles/ - - name: Build docs - working-directory: docs - run: sphinx-build -E -W -b html . _build/html - - name: Check For pyproject.toml - id: need-pypi - run: | - echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) - - name: Build Python package - if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') - run: | - pip install --upgrade build twine - for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do - sed -i -e "s/0.0.0+auto.0/1.2.3/" $file; - done; - python -m build - twine check dist/* + - name: Run Build CI workflow + uses: adafruit/workflows-circuitpython-libs/build@main diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index f3a0325..0000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,88 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -name: Release Actions - -on: - release: - types: [published] - -jobs: - upload-release-assets: - runs-on: ubuntu-latest - steps: - - name: Dump GitHub context - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - run: echo "$GITHUB_CONTEXT" - - name: Translate Repo Name For Build Tools filename_prefix - id: repo-name - run: | - echo ::set-output name=repo-name::$( - echo ${{ github.repository }} | - awk -F '\/' '{ print tolower($2) }' | - tr '_' '-' - ) - - name: Set up Python 3.x - uses: actions/setup-python@v2 - with: - python-version: "3.x" - - 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 pyproject.toml - id: need-pypi - run: | - echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) - - name: Set up Python - if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') - uses: actions/setup-python@v2 - with: - python-version: '3.x' - - name: Install dependencies - if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') - run: | - python -m pip install --upgrade pip - pip install --upgrade build twine - - name: Build and publish - if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') - env: - TWINE_USERNAME: ${{ secrets.pypi_username }} - TWINE_PASSWORD: ${{ secrets.pypi_password }} - run: | - for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do - sed -i -e "s/0.0.0+auto.0/${{github.event.release.tag_name}}/" $file; - done; - python -m build - twine upload dist/* diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml new file mode 100644 index 0000000..041a337 --- /dev/null +++ b/.github/workflows/release_gh.yml @@ -0,0 +1,14 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: Build CI + +on: [pull_request, push] + +jobs: + test: + runs-on: ubuntu-latest + steps: + - name: Run Build CI workflow + uses: adafruit/workflows-circuitpython-libs/build@main diff --git a/.github/workflows/release_pypi.yml b/.github/workflows/release_pypi.yml new file mode 100644 index 0000000..041a337 --- /dev/null +++ b/.github/workflows/release_pypi.yml @@ -0,0 +1,14 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: Build CI + +on: [pull_request, push] + +jobs: + test: + runs-on: ubuntu-latest + steps: + - name: Run Build CI workflow + uses: adafruit/workflows-circuitpython-libs/build@main From 794090fb6c5c70b9916e18f26107482626003ed8 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 00:47:00 -0400 Subject: [PATCH 64/91] Updated pylint version to 2.13.0 --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 3343606..4c43710 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -18,7 +18,7 @@ repos: - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: v2.11.1 + rev: v2.13.0 hooks: - id: pylint name: pylint (library code) From 7d026712a82d16ecb092aacb9480c675dcf93774 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 08:15:20 -0400 Subject: [PATCH 65/91] Update pylint to 2.15.5 --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 4c43710..0e5fccc 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -18,7 +18,7 @@ repos: - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: v2.13.0 + rev: v2.15.5 hooks: - id: pylint name: pylint (library code) From eae8f513e9dff0d0657b43e0b154897705d5e4b0 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 09:12:44 -0400 Subject: [PATCH 66/91] Fix release CI files --- .github/workflows/release_gh.yml | 14 +++++++++----- .github/workflows/release_pypi.yml | 15 ++++++++++----- 2 files changed, 19 insertions(+), 10 deletions(-) diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml index 041a337..b8aa8d6 100644 --- a/.github/workflows/release_gh.yml +++ b/.github/workflows/release_gh.yml @@ -2,13 +2,17 @@ # # SPDX-License-Identifier: MIT -name: Build CI +name: GitHub Release Actions -on: [pull_request, push] +on: + release: + types: [published] jobs: - test: + upload-release-assets: runs-on: ubuntu-latest steps: - - name: Run Build CI workflow - uses: adafruit/workflows-circuitpython-libs/build@main + - name: Run GitHub Release CI workflow + uses: adafruit/workflows-circuitpython-libs/release-gh@main + with: + github-token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/release_pypi.yml b/.github/workflows/release_pypi.yml index 041a337..65775b7 100644 --- a/.github/workflows/release_pypi.yml +++ b/.github/workflows/release_pypi.yml @@ -2,13 +2,18 @@ # # SPDX-License-Identifier: MIT -name: Build CI +name: PyPI Release Actions -on: [pull_request, push] +on: + release: + types: [published] jobs: - test: + upload-release-assets: runs-on: ubuntu-latest steps: - - name: Run Build CI workflow - uses: adafruit/workflows-circuitpython-libs/build@main + - 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 }} From 59ff9dedb45a715ea1f77dd6601df39927fc9197 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 18:34:33 -0400 Subject: [PATCH 67/91] Update .pylintrc for v2.15.5 --- .pylintrc | 45 ++++----------------------------------------- 1 file changed, 4 insertions(+), 41 deletions(-) diff --git a/.pylintrc b/.pylintrc index f772971..40208c3 100644 --- a/.pylintrc +++ b/.pylintrc @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries # # SPDX-License-Identifier: Unlicense @@ -26,7 +26,7 @@ jobs=1 # List of plugins (as comma separated values of python modules names) to load, # usually to register additional checkers. -load-plugins= +load-plugins=pylint.extensions.no_self_use # Pickle collected data for later comparisons. persistent=yes @@ -54,8 +54,8 @@ confidence= # --enable=similarities". If you want to run only the classes checker, but have # no Warning level messages displayed, use"--disable=all --enable=classes # --disable=W" -# disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call -disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation,unspecified-encoding +# disable=import-error,raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,deprecated-str-translate-call +disable=raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,import-error,pointless-string-statement,unspecified-encoding # Enable the message, report, category or checker with the given id(s). You can # either give multiple identifier separated by comma (,) or put this option @@ -225,12 +225,6 @@ 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 @@ -257,38 +251,22 @@ min-similarity-lines=12 [BASIC] -# Naming hint for argument names -argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct argument names argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ -# Naming hint for attribute names -attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct attribute names attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ # Bad variable names which should always be refused, separated by a comma bad-names=foo,bar,baz,toto,tutu,tata -# Naming hint for class attribute names -class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - # Regular expression matching correct class attribute names class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ -# Naming hint for class names -# class-name-hint=[A-Z_][a-zA-Z0-9]+$ -class-name-hint=[A-Z_][a-zA-Z0-9_]+$ - # Regular expression matching correct class names # class-rgx=[A-Z_][a-zA-Z0-9]+$ class-rgx=[A-Z_][a-zA-Z0-9_]+$ -# Naming hint for constant names -const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - # Regular expression matching correct constant names const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ @@ -296,9 +274,6 @@ const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ # 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_]*))$ @@ -309,21 +284,12 @@ 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]+))$ @@ -339,9 +305,6 @@ no-docstring-rgx=^_ # 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_]*))$ From 54f169eada4099cead953f7a234ad18ccbb66ffc Mon Sep 17 00:00:00 2001 From: Mark McGookin Date: Sat, 12 Nov 2022 23:02:06 +0000 Subject: [PATCH 68/91] Small changes to work with Circuit Python 8 Beta 4 on Raspberry Pi Pico. board.SPI didn't exist and needed to be changed to busio.SPI. The Dx reference for pins doesn't work and needs updated to be GPx (for the raspberry pi pico at least) --- examples/st7789_172x320_1.47_simpletest.py | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/examples/st7789_172x320_1.47_simpletest.py b/examples/st7789_172x320_1.47_simpletest.py index 4d3133b..98a0736 100644 --- a/examples/st7789_172x320_1.47_simpletest.py +++ b/examples/st7789_172x320_1.47_simpletest.py @@ -3,25 +3,26 @@ """ This test will initialize the display using displayio and draw a solid green -background, a smaller purple rectangle, and some yellow text. +background, a smaller purple rectangle, and some yellow text.. """ import board +import busio import terminalio import displayio from adafruit_display_text import label from adafruit_st7789 import ST7789 -BORDER_WIDTH = 20 +BORDER_WIDTH = 28 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 +tft_cs = board.GP5 #board.D5 +tft_dc = board.GP6 #board.D6 +tft_rst = board.GP7 #board.D7 +spi = busio.SPI(board.GP2, board.GP3, board.GP4) display_bus = displayio.FourWire(spi, command=tft_dc, chip_select=tft_cs, reset=tft_rst) display = ST7789(display_bus, width=320, height=172, colstart=34, rotation=270) @@ -34,12 +35,13 @@ 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) +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( @@ -50,7 +52,7 @@ # Draw a label text_area = label.Label( terminalio.FONT, - text="Hello World!", + text="Hello World!!", color=0xFFFF00, scale=TEXT_SCALE, anchor_point=(0.5, 0.5), From 2b22b10ab4c37129ffd5cdabb5ab473cef39ab70 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 21 Nov 2022 11:04:11 -0600 Subject: [PATCH 69/91] code format --- examples/st7789_172x320_1.47_simpletest.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/examples/st7789_172x320_1.47_simpletest.py b/examples/st7789_172x320_1.47_simpletest.py index 98a0736..b65b9b6 100644 --- a/examples/st7789_172x320_1.47_simpletest.py +++ b/examples/st7789_172x320_1.47_simpletest.py @@ -18,9 +18,9 @@ # Release any resources currently in use for the displays displayio.release_displays() -tft_cs = board.GP5 #board.D5 -tft_dc = board.GP6 #board.D6 -tft_rst = board.GP7 #board.D7 +tft_cs = board.GP5 # board.D5 +tft_dc = board.GP6 # board.D6 +tft_rst = board.GP7 # board.D7 spi = busio.SPI(board.GP2, board.GP3, board.GP4) display_bus = displayio.FourWire(spi, command=tft_dc, chip_select=tft_cs, reset=tft_rst) @@ -35,7 +35,7 @@ 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) +splash.append(bg_sprite) # Draw a smaller inner rectangle inner_bitmap = displayio.Bitmap( From 0dc060893c9dfdd64ea6ab385d2b8d1060749dad Mon Sep 17 00:00:00 2001 From: Mark McGookin Date: Tue, 22 Nov 2022 12:04:00 +0000 Subject: [PATCH 70/91] updated 1.47" screen simple test with Pico compatability and using busio for creating the SPI interface --- examples/st7789_172x320_1.47_simpletest.py | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/examples/st7789_172x320_1.47_simpletest.py b/examples/st7789_172x320_1.47_simpletest.py index b65b9b6..996365c 100644 --- a/examples/st7789_172x320_1.47_simpletest.py +++ b/examples/st7789_172x320_1.47_simpletest.py @@ -18,11 +18,21 @@ # Release any resources currently in use for the displays displayio.release_displays() -tft_cs = board.GP5 # board.D5 -tft_dc = board.GP6 # board.D6 -tft_rst = board.GP7 # board.D7 +# built-in, silkscreen labelled SPI bus +spi = busio.SPI(board.SCK, board.MOSI, board.MISO) +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) + +# spi = busio.SPI(board.GP2, board.GP3, board.GP4) +# tft_cs = board.GP5 +# tft_dc = board.GP6 +# tft_rst = board.GP7 -spi = busio.SPI(board.GP2, board.GP3, board.GP4) display_bus = displayio.FourWire(spi, command=tft_dc, chip_select=tft_cs, reset=tft_rst) display = ST7789(display_bus, width=320, height=172, colstart=34, rotation=270) From 1b29123658126d44bb491764fae6d83236e4dfb4 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Thu, 1 Sep 2022 20:16:31 -0400 Subject: [PATCH 71/91] Add .venv to .gitignore Signed-off-by: Alec Delaney <89490472+tekktrik@users.noreply.github.com> --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 544ec4a..db3d538 100644 --- a/.gitignore +++ b/.gitignore @@ -37,6 +37,7 @@ _build # Virtual environment-specific files .env +.venv # MacOS-specific files *.DS_Store From c3280d6e329a41a7042750b3b31f4e0de9e77d87 Mon Sep 17 00:00:00 2001 From: xgpt Date: Mon, 2 Jan 2023 20:25:43 -0500 Subject: [PATCH 72/91] "displayio.release_displays()" was *after* spi initialization, leading to failures on device restart. Now Corrected. --- README.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index a5d272d..6cfb7cb 100644 --- a/README.rst +++ b/README.rst @@ -38,15 +38,16 @@ Usage Example import displayio from adafruit_st7789 import ST7789 - spi = board.SPI() + displayio.release_displays() + while not spi.try_lock(): pass + spi = board.SPI() spi.configure(baudrate=24000000) # Configure SPI for 24MHz spi.unlock() 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 = ST7789(display_bus, width=240, height=240, rowstart=80) From 4153d10ad62cd559fba15051ed4debd985b5d39b Mon Sep 17 00:00:00 2001 From: Neradoc Date: Tue, 3 Jan 2023 03:11:19 +0100 Subject: [PATCH 73/91] Update README.rst --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 6cfb7cb..a1b2dfc 100644 --- a/README.rst +++ b/README.rst @@ -40,9 +40,9 @@ Usage Example displayio.release_displays() + spi = board.SPI() while not spi.try_lock(): pass - spi = board.SPI() spi.configure(baudrate=24000000) # Configure SPI for 24MHz spi.unlock() tft_cs = board.D5 From 7687a85fde4d087dc8eedb8379f35f6cb57ce68b Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Thu, 19 Jan 2023 23:39:55 -0500 Subject: [PATCH 74/91] Add upload url to release action Signed-off-by: Alec Delaney <89490472+tekktrik@users.noreply.github.com> --- .github/workflows/release_gh.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml index b8aa8d6..9acec60 100644 --- a/.github/workflows/release_gh.yml +++ b/.github/workflows/release_gh.yml @@ -16,3 +16,4 @@ jobs: uses: adafruit/workflows-circuitpython-libs/release-gh@main with: github-token: ${{ secrets.GITHUB_TOKEN }} + upload-url: ${{ github.event.release.upload_url }} From fe8709648571286de79bb1fc3c5e611c62b9a1a1 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sat, 21 Jan 2023 12:07:49 -0600 Subject: [PATCH 75/91] use builtin SPI bus. remove extra punctuation --- examples/st7789_172x320_1.47_simpletest.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/examples/st7789_172x320_1.47_simpletest.py b/examples/st7789_172x320_1.47_simpletest.py index 996365c..9fb3a59 100644 --- a/examples/st7789_172x320_1.47_simpletest.py +++ b/examples/st7789_172x320_1.47_simpletest.py @@ -3,7 +3,7 @@ """ This test will initialize the display using displayio and draw a solid green -background, a smaller purple rectangle, and some yellow text.. +background, a smaller purple rectangle, and some yellow text. """ import board import busio @@ -12,6 +12,7 @@ from adafruit_display_text import label from adafruit_st7789 import ST7789 + BORDER_WIDTH = 28 TEXT_SCALE = 3 @@ -19,7 +20,7 @@ displayio.release_displays() # built-in, silkscreen labelled SPI bus -spi = busio.SPI(board.SCK, board.MOSI, board.MISO) +spi = board.SPI() tft_cs = board.D5 tft_dc = board.D6 tft_rst = board.D9 @@ -62,7 +63,7 @@ # Draw a label text_area = label.Label( terminalio.FONT, - text="Hello World!!", + text="Hello World!", color=0xFFFF00, scale=TEXT_SCALE, anchor_point=(0.5, 0.5), From 20dc9f340ad2d892a15fd4d976bb1018c86e25d0 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sat, 21 Jan 2023 12:13:08 -0600 Subject: [PATCH 76/91] code format. move import to apease pylint --- examples/st7789_172x320_1.47_simpletest.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/examples/st7789_172x320_1.47_simpletest.py b/examples/st7789_172x320_1.47_simpletest.py index 9fb3a59..101113f 100644 --- a/examples/st7789_172x320_1.47_simpletest.py +++ b/examples/st7789_172x320_1.47_simpletest.py @@ -6,7 +6,6 @@ background, a smaller purple rectangle, and some yellow text. """ import board -import busio import terminalio import displayio from adafruit_display_text import label @@ -19,16 +18,17 @@ # Release any resources currently in use for the displays displayio.release_displays() -# built-in, silkscreen labelled SPI bus +# 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 +# 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 From 2328e7838d5d1b4065750335be941f08e4218f52 Mon Sep 17 00:00:00 2001 From: Tekktrik Date: Tue, 9 May 2023 20:26:25 -0400 Subject: [PATCH 77/91] Update pre-commit hooks Signed-off-by: Tekktrik --- .pre-commit-config.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 0e5fccc..70ade69 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -4,21 +4,21 @@ repos: - repo: https://github.com/python/black - rev: 22.3.0 + rev: 23.3.0 hooks: - id: black - repo: https://github.com/fsfe/reuse-tool - rev: v0.14.0 + rev: v1.1.2 hooks: - id: reuse - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.2.0 + rev: v4.4.0 hooks: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: v2.15.5 + rev: v2.17.4 hooks: - id: pylint name: pylint (library code) From 127b3503030a4e805fe848310f2ef7077191b1fc Mon Sep 17 00:00:00 2001 From: Tekktrik Date: Wed, 10 May 2023 22:45:22 -0400 Subject: [PATCH 78/91] Run pre-commit --- adafruit_st7789.py | 1 + 1 file changed, 1 insertion(+) diff --git a/adafruit_st7789.py b/adafruit_st7789.py index 68d7a78..42c28b6 100755 --- a/adafruit_st7789.py +++ b/adafruit_st7789.py @@ -56,6 +56,7 @@ b"\x29\x80\xFF" # _DISPON and Delay 500ms ) + # pylint: disable=too-few-public-methods class ST7789(displayio.Display): """ST7789 driver""" From d939bbf9395a27d3200d12de333d7c78956a80a4 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Tue, 23 May 2023 23:35:48 -0400 Subject: [PATCH 79/91] Update .pylintrc, fix jQuery for docs --- .pylintrc | 2 +- docs/conf.py | 1 + docs/requirements.txt | 1 + 3 files changed, 3 insertions(+), 1 deletion(-) diff --git a/.pylintrc b/.pylintrc index 40208c3..f945e92 100644 --- a/.pylintrc +++ b/.pylintrc @@ -396,4 +396,4 @@ min-public-methods=1 # Exceptions that will emit a warning when being caught. Defaults to # "Exception" -overgeneral-exceptions=Exception +overgeneral-exceptions=builtins.Exception diff --git a/docs/conf.py b/docs/conf.py index e9712e0..b5ebde8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -17,6 +17,7 @@ # ones. extensions = [ "sphinx.ext.autodoc", + "sphinxcontrib.jquery", "sphinx.ext.intersphinx", "sphinx.ext.napoleon", "sphinx.ext.todo", diff --git a/docs/requirements.txt b/docs/requirements.txt index 88e6733..797aa04 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -3,3 +3,4 @@ # SPDX-License-Identifier: Unlicense sphinx>=4.0.0 +sphinxcontrib-jquery From 54f33bbd728b551eadddc0cefebe13591a1973f0 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 18 Sep 2023 16:22:00 -0500 Subject: [PATCH 80/91] "fix rtd theme " --- docs/conf.py | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index b5ebde8..3efe197 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -101,19 +101,10 @@ # 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" +html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, From 2f8b5dba2d2ef5adb2b4252a332a0c319e93ff49 Mon Sep 17 00:00:00 2001 From: RetiredWizard Date: Mon, 6 Nov 2023 18:01:26 -0500 Subject: [PATCH 81/91] replace depreciated .show() & displayio changes --- README.rst | 11 +++++++++-- adafruit_st7789.py | 13 ++++++++++--- examples/st7789_170x320_1.9_simpletest.py | 11 +++++++++-- examples/st7789_172x320_1.47_simpletest.py | 11 +++++++++-- examples/st7789_240x135_pitft_simpletest.py | 11 +++++++++-- examples/st7789_240x135_simpletest.py | 11 +++++++++-- ...240x135_simpletest_Pimoroni_Pico_Display_Pack.py | 11 +++++++++-- examples/st7789_240x240_bonnet_simpletest.py | 11 +++++++++-- examples/st7789_240x240_pitft_simpletest.py | 11 +++++++++-- ...789_240x240_simpletest_Pimoroni_Pico_Explorer.py | 11 +++++++++-- ...7789_240x240_simpletest_Waveshare_PicoLCD_1_3.py | 11 +++++++++-- examples/st7789_280x240_simpletest.py | 13 +++++++++---- examples/st7789_320x240_simpletest.py | 13 +++++++++---- ..._320x240_simpletest_Pimoroni_Pico_Display_2_0.py | 11 +++++++++-- examples/st7789_simpletest.py | 13 +++++++++---- examples/st7789_tft_gizmo_simpletest.py | 11 +++++++++-- 16 files changed, 145 insertions(+), 39 deletions(-) diff --git a/README.rst b/README.rst index a1b2dfc..3e85caf 100644 --- a/README.rst +++ b/README.rst @@ -36,6 +36,13 @@ 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() @@ -48,13 +55,13 @@ Usage Example 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) # Make the display context splash = displayio.Group() - display.show(splash) + display.root_group = splash color_bitmap = displayio.Bitmap(240, 240, 1) color_palette = displayio.Palette(1) diff --git a/adafruit_st7789.py b/adafruit_st7789.py index 42c28b6..b37f264 100755 --- a/adafruit_st7789.py +++ b/adafruit_st7789.py @@ -40,7 +40,14 @@ """ -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 + from busdisplay import BusDisplay +except ImportError: + from displayio import FourWire + from displayio import Display as BusDisplay __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_ST7789.git" @@ -58,8 +65,8 @@ # pylint: disable=too-few-public-methods -class ST7789(displayio.Display): +class ST7789(BusDisplay): """ST7789 driver""" - def __init__(self, bus: displayio.FourWire, **kwargs) -> None: + def __init__(self, bus: FourWire, **kwargs) -> None: super().__init__(bus, _INIT_SEQUENCE, **kwargs) diff --git a/examples/st7789_170x320_1.9_simpletest.py b/examples/st7789_170x320_1.9_simpletest.py index 10d854a..c3fc4cf 100644 --- a/examples/st7789_170x320_1.9_simpletest.py +++ b/examples/st7789_170x320_1.9_simpletest.py @@ -8,6 +8,13 @@ import board import terminalio 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_display_text import label from adafruit_st7789 import ST7789 @@ -22,13 +29,13 @@ tft_dc = board.D6 tft_rst = board.D9 -display_bus = displayio.FourWire(spi, command=tft_dc, chip_select=tft_cs, reset=tft_rst) +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.show(splash) +display.root_group = splash color_bitmap = displayio.Bitmap(display.width, display.height, 1) color_palette = displayio.Palette(1) diff --git a/examples/st7789_172x320_1.47_simpletest.py b/examples/st7789_172x320_1.47_simpletest.py index 101113f..a61a5ae 100644 --- a/examples/st7789_172x320_1.47_simpletest.py +++ b/examples/st7789_172x320_1.47_simpletest.py @@ -8,6 +8,13 @@ import board import terminalio 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_display_text import label from adafruit_st7789 import ST7789 @@ -34,13 +41,13 @@ # tft_dc = board.GP6 # tft_rst = board.GP7 -display_bus = displayio.FourWire(spi, command=tft_dc, chip_select=tft_cs, reset=tft_rst) +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.show(splash) +display.root_group = splash color_bitmap = displayio.Bitmap(display.width, display.height, 1) color_palette = displayio.Palette(1) diff --git a/examples/st7789_240x135_pitft_simpletest.py b/examples/st7789_240x135_pitft_simpletest.py index 5f2db09..e9a050d 100644 --- a/examples/st7789_240x135_pitft_simpletest.py +++ b/examples/st7789_240x135_pitft_simpletest.py @@ -10,6 +10,13 @@ import board import terminalio 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_display_text import label from adafruit_st7789 import ST7789 @@ -27,14 +34,14 @@ tft_cs = board.CE0 tft_dc = board.D25 -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, rotation=90, width=240, height=135, rowstart=40, colstart=53 ) # Make the display context splash = displayio.Group() -display.show(splash) +display.root_group = splash color_bitmap = displayio.Bitmap(display.width, display.height, 1) color_palette = displayio.Palette(1) diff --git a/examples/st7789_240x135_simpletest.py b/examples/st7789_240x135_simpletest.py index 7d878ab..0821810 100644 --- a/examples/st7789_240x135_simpletest.py +++ b/examples/st7789_240x135_simpletest.py @@ -8,6 +8,13 @@ import board import terminalio 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_display_text import label from adafruit_st7789 import ST7789 @@ -25,14 +32,14 @@ tft_cs = board.D5 tft_dc = board.D6 -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, rotation=270, width=240, height=135, rowstart=40, colstart=53 ) # Make the display context splash = displayio.Group() -display.show(splash) +display.root_group = splash color_bitmap = displayio.Bitmap(display.width, display.height, 1) color_palette = displayio.Palette(1) diff --git a/examples/st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py b/examples/st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py index 09f7505..3691a31 100644 --- a/examples/st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py +++ b/examples/st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py @@ -5,6 +5,13 @@ import busio import terminalio 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_display_text import label from adafruit_st7789 import ST7789 @@ -24,14 +31,14 @@ spi_clk = board.GP18 spi = busio.SPI(spi_clk, spi_mosi) -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, rotation=270, width=240, height=135, rowstart=40, colstart=53 ) # Make the display context splash = displayio.Group() -display.show(splash) +display.root_group = splash color_bitmap = displayio.Bitmap(display.width, display.height, 1) color_palette = displayio.Palette(1) diff --git a/examples/st7789_240x240_bonnet_simpletest.py b/examples/st7789_240x240_bonnet_simpletest.py index d208ca8..3e24f57 100644 --- a/examples/st7789_240x240_bonnet_simpletest.py +++ b/examples/st7789_240x240_bonnet_simpletest.py @@ -10,6 +10,13 @@ import board import terminalio 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_display_text import label from adafruit_st7789 import ST7789 @@ -21,7 +28,7 @@ tft_dc = board.D25 tft_lite = board.D26 -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, @@ -34,7 +41,7 @@ # Make the display context splash = displayio.Group() -display.show(splash) +display.root_group = splash color_bitmap = displayio.Bitmap(240, 240, 1) color_palette = displayio.Palette(1) diff --git a/examples/st7789_240x240_pitft_simpletest.py b/examples/st7789_240x240_pitft_simpletest.py index 7df1753..a779d47 100644 --- a/examples/st7789_240x240_pitft_simpletest.py +++ b/examples/st7789_240x240_pitft_simpletest.py @@ -10,6 +10,13 @@ import board import terminalio 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_display_text import label from adafruit_st7789 import ST7789 @@ -20,13 +27,13 @@ tft_cs = board.CE0 tft_dc = board.D25 -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, width=240, height=240, rowstart=80, rotation=180) # Make the display context splash = displayio.Group() -display.show(splash) +display.root_group = splash color_bitmap = displayio.Bitmap(240, 240, 1) color_palette = displayio.Palette(1) diff --git a/examples/st7789_240x240_simpletest_Pimoroni_Pico_Explorer.py b/examples/st7789_240x240_simpletest_Pimoroni_Pico_Explorer.py index 67b0adf..930d773 100644 --- a/examples/st7789_240x240_simpletest_Pimoroni_Pico_Explorer.py +++ b/examples/st7789_240x240_simpletest_Pimoroni_Pico_Explorer.py @@ -9,6 +9,13 @@ import busio import terminalio 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_display_text import label from adafruit_st7789 import ST7789 @@ -21,13 +28,13 @@ spi_clk = board.GP18 spi = busio.SPI(spi_clk, spi_mosi) -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, width=240, height=240, rowstart=80, rotation=180) # Make the display context splash = displayio.Group() -display.show(splash) +display.root_group = splash color_bitmap = displayio.Bitmap(240, 240, 1) color_palette = displayio.Palette(1) diff --git a/examples/st7789_240x240_simpletest_Waveshare_PicoLCD_1_3.py b/examples/st7789_240x240_simpletest_Waveshare_PicoLCD_1_3.py index c379bb1..ddb35c9 100644 --- a/examples/st7789_240x240_simpletest_Waveshare_PicoLCD_1_3.py +++ b/examples/st7789_240x240_simpletest_Waveshare_PicoLCD_1_3.py @@ -9,6 +9,13 @@ import busio import terminalio 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_display_text import label from adafruit_st7789 import ST7789 @@ -23,7 +30,7 @@ backlight = board.GP13 spi = busio.SPI(spi_clk, spi_mosi) -display_bus = displayio.FourWire(spi, command=tft_dc, chip_select=tft_cs, reset=tft_rst) +display_bus = FourWire(spi, command=tft_dc, chip_select=tft_cs, reset=tft_rst) display = ST7789( display_bus, @@ -36,7 +43,7 @@ # Make the display context splash = displayio.Group() -display.show(splash) +display.root_group = splash color_bitmap = displayio.Bitmap(240, 240, 1) color_palette = displayio.Palette(1) diff --git a/examples/st7789_280x240_simpletest.py b/examples/st7789_280x240_simpletest.py index 926990d..f2ed86f 100644 --- a/examples/st7789_280x240_simpletest.py +++ b/examples/st7789_280x240_simpletest.py @@ -8,6 +8,13 @@ import board import terminalio 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_display_text import label from adafruit_st7789 import ST7789 @@ -18,15 +25,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=280, height=240, rowstart=20, rotation=90) # Make the display context splash = displayio.Group() -display.show(splash) +display.root_group = splash color_bitmap = displayio.Bitmap(280, 240, 1) color_palette = displayio.Palette(1) diff --git a/examples/st7789_320x240_simpletest.py b/examples/st7789_320x240_simpletest.py index 3fac5aa..c68913a 100644 --- a/examples/st7789_320x240_simpletest.py +++ b/examples/st7789_320x240_simpletest.py @@ -8,6 +8,13 @@ import board import terminalio 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_display_text import label from adafruit_st7789 import ST7789 @@ -18,15 +25,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() -display.show(splash) +display.root_group = splash color_bitmap = displayio.Bitmap(320, 240, 1) color_palette = displayio.Palette(1) diff --git a/examples/st7789_320x240_simpletest_Pimoroni_Pico_Display_2_0.py b/examples/st7789_320x240_simpletest_Pimoroni_Pico_Display_2_0.py index d88d91d..3e8f0e0 100644 --- a/examples/st7789_320x240_simpletest_Pimoroni_Pico_Display_2_0.py +++ b/examples/st7789_320x240_simpletest_Pimoroni_Pico_Display_2_0.py @@ -9,6 +9,13 @@ import busio import terminalio 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_display_text import label from adafruit_st7789 import ST7789 @@ -22,7 +29,7 @@ spi = busio.SPI(spi_clk, spi_mosi) backlight = board.GP20 -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, rotation=270, width=320, height=240, backlight_pin=backlight @@ -30,7 +37,7 @@ # Make the display context splash = displayio.Group() -display.show(splash) +display.root_group = splash color_bitmap = displayio.Bitmap(320, 240, 1) color_palette = displayio.Palette(1) diff --git a/examples/st7789_simpletest.py b/examples/st7789_simpletest.py index 990630e..1e80711 100644 --- a/examples/st7789_simpletest.py +++ b/examples/st7789_simpletest.py @@ -8,6 +8,13 @@ import board import terminalio 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_display_text import label from adafruit_st7789 import ST7789 @@ -18,15 +25,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) # Make the display context splash = displayio.Group() -display.show(splash) +display.root_group = splash color_bitmap = displayio.Bitmap(240, 240, 1) color_palette = displayio.Palette(1) diff --git a/examples/st7789_tft_gizmo_simpletest.py b/examples/st7789_tft_gizmo_simpletest.py index 0869521..40403a6 100644 --- a/examples/st7789_tft_gizmo_simpletest.py +++ b/examples/st7789_tft_gizmo_simpletest.py @@ -9,6 +9,13 @@ import busio import terminalio 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_display_text import label from adafruit_st7789 import ST7789 @@ -20,7 +27,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, @@ -33,7 +40,7 @@ # Make the display context splash = displayio.Group() -display.show(splash) +display.root_group = splash color_bitmap = displayio.Bitmap(240, 240, 1) color_palette = displayio.Palette(1) From b0692952495b4816136216f077785677fa2ad2bd Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 16 Oct 2023 14:30:31 -0500 Subject: [PATCH 82/91] unpin sphinx and add sphinx-rtd-theme to docs reqs Signed-off-by: foamyguy --- docs/requirements.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 797aa04..979f568 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,5 +2,6 @@ # # SPDX-License-Identifier: Unlicense -sphinx>=4.0.0 +sphinx sphinxcontrib-jquery +sphinx-rtd-theme From 20022befa0e24fb3a54a23807d72c3e2b0c1cdb3 Mon Sep 17 00:00:00 2001 From: helgibbons <50950368+helgibbons@users.noreply.github.com> Date: Fri, 12 Apr 2024 14:39:44 +0100 Subject: [PATCH 83/91] Pimoroni Display Pack examples - show how to control backlight --- ...9_240x135_simpletest_Pimoroni_Pico_Display_Pack.py | 11 ++++++++++- ...89_320x240_simpletest_Pimoroni_Pico_Display_2_0.py | 3 +++ 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/examples/st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py b/examples/st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py index 3691a31..3dcce87 100644 --- a/examples/st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py +++ b/examples/st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py @@ -1,6 +1,10 @@ # 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 terminalio @@ -30,12 +34,17 @@ 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 + 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 diff --git a/examples/st7789_320x240_simpletest_Pimoroni_Pico_Display_2_0.py b/examples/st7789_320x240_simpletest_Pimoroni_Pico_Display_2_0.py index 3e8f0e0..4d0ab6f 100644 --- a/examples/st7789_320x240_simpletest_Pimoroni_Pico_Display_2_0.py +++ b/examples/st7789_320x240_simpletest_Pimoroni_Pico_Display_2_0.py @@ -35,6 +35,9 @@ 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 From b88f46e2b3f2e58d4c86ca0b6f743bd77027be33 Mon Sep 17 00:00:00 2001 From: helgibbons <50950368+helgibbons@users.noreply.github.com> Date: Fri, 12 Apr 2024 15:15:55 +0100 Subject: [PATCH 84/91] Pimoroni Display Pack examples - fix formatting --- ...t7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py | 8 +++++++- ...st7789_320x240_simpletest_Pimoroni_Pico_Display_2_0.py | 6 +++++- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/examples/st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py b/examples/st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py index 3dcce87..c4209df 100644 --- a/examples/st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py +++ b/examples/st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py @@ -39,7 +39,13 @@ 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 + display_bus, + rotation=270, + width=240, + height=135, + rowstart=40, + colstart=53, + backlight_pin=backlight, ) # Set the backlight diff --git a/examples/st7789_320x240_simpletest_Pimoroni_Pico_Display_2_0.py b/examples/st7789_320x240_simpletest_Pimoroni_Pico_Display_2_0.py index 4d0ab6f..9f92b96 100644 --- a/examples/st7789_320x240_simpletest_Pimoroni_Pico_Display_2_0.py +++ b/examples/st7789_320x240_simpletest_Pimoroni_Pico_Display_2_0.py @@ -32,7 +32,11 @@ display_bus = FourWire(spi, command=tft_dc, chip_select=tft_cs) display = ST7789( - display_bus, rotation=270, width=320, height=240, backlight_pin=backlight + display_bus, + rotation=270, + width=320, + height=240, + backlight_pin=backlight, ) # Set the backlight From 240c4187d312bfbe28e27ed0e6f67901da5fe12a Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 7 Oct 2024 09:24:05 -0500 Subject: [PATCH 85/91] remove deprecated get_html_theme_path() call Signed-off-by: foamyguy --- docs/conf.py | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 3efe197..b71979a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -104,7 +104,6 @@ import sphinx_rtd_theme html_theme = "sphinx_rtd_theme" -html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, From 1698dfb97989ecd10a51bffdeec236a34e60287f Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 14 Jan 2025 11:32:34 -0600 Subject: [PATCH 86/91] add sphinx configuration to rtd.yaml Signed-off-by: foamyguy --- .readthedocs.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 33c2a61..88bca9f 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,6 +8,9 @@ # Required version: 2 +sphinx: + configuration: docs/conf.py + build: os: ubuntu-20.04 tools: From f847aec52ccaed15f5a1ccb86c62d6524831d5ea Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 24 Feb 2025 15:52:07 -0600 Subject: [PATCH 87/91] use ruff and remove 8x displayio code --- .gitattributes | 11 + .pre-commit-config.yaml | 43 +- .pylintrc | 399 ------------------ README.rst | 6 +- adafruit_st7789.py | 22 +- docs/api.rst | 3 + docs/conf.py | 10 +- examples/st7789_170x320_1.9_simpletest.py | 12 +- examples/st7789_172x320_1.47_simpletest.py | 13 +- examples/st7789_240x135_pitft_simpletest.py | 24 +- examples/st7789_240x135_simpletest.py | 24 +- ...5_simpletest_Pimoroni_Pico_Display_Pack.py | 20 +- examples/st7789_240x240_bonnet_simpletest.py | 12 +- examples/st7789_240x240_pitft_simpletest.py | 12 +- ...0x240_simpletest_Pimoroni_Pico_Explorer.py | 12 +- ...40x240_simpletest_Waveshare_PicoLCD_1_3.py | 12 +- examples/st7789_280x240_simpletest.py | 12 +- examples/st7789_320x240_simpletest.py | 12 +- ...40_simpletest_Pimoroni_Pico_Display_2_0.py | 12 +- examples/st7789_simpletest.py | 12 +- examples/st7789_tft_gizmo_simpletest.py | 12 +- ruff.toml | 100 +++++ 22 files changed, 206 insertions(+), 589 deletions(-) create mode 100644 .gitattributes delete mode 100644 .pylintrc create mode 100644 ruff.toml 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/.pre-commit-config.yaml b/.pre-commit-config.yaml index 70ade69..ff19dde 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,42 +1,21 @@ -# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries # # SPDX-License-Identifier: Unlicense repos: - - repo: https://github.com/python/black - rev: 23.3.0 - hooks: - - id: black - - repo: https://github.com/fsfe/reuse-tool - rev: v1.1.2 - hooks: - - id: reuse - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.4.0 + rev: v4.5.0 hooks: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace - - repo: https://github.com/pycqa/pylint - rev: v2.17.4 + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.3.4 hooks: - - id: pylint - name: pylint (library code) - types: [python] - args: - - --disable=consider-using-f-string - exclude: "^(docs/|examples/|tests/|setup.py$)" - - id: pylint - name: pylint (example code) - description: Run pylint rules on "examples/*.py" files - types: [python] - files: "^examples/" - args: - - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code - - id: pylint - name: pylint (test code) - description: Run pylint rules on "tests/*.py" files - types: [python] - files: "^tests/" - args: - - --disable=missing-docstring,consider-using-f-string,duplicate-code + - id: 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 f945e92..0000000 --- a/.pylintrc +++ /dev/null @@ -1,399 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -[MASTER] - -# A comma-separated list of package or module names from where C extensions may -# be loaded. Extensions are loading into the active Python interpreter and may -# run arbitrary code -extension-pkg-whitelist= - -# Add files or directories to the ignore-list. They should be base names, not -# paths. -ignore=CVS - -# Add files or directories matching the regex patterns to the ignore-list. The -# regex matches against base names, not paths. -ignore-patterns= - -# Python code to execute, usually for sys.path manipulation such as -# pygtk.require(). -#init-hook= - -# Use multiple processes to speed up Pylint. -jobs=1 - -# List of plugins (as comma separated values of python modules names) to load, -# usually to register additional checkers. -load-plugins=pylint.extensions.no_self_use - -# 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,raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,deprecated-str-translate-call -disable=raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,import-error,pointless-string-statement,unspecified-encoding - -# Enable the message, report, category or checker with the given id(s). You can -# either give multiple identifier separated by comma (,) or put this option -# multiple time (only on the command line, not in the configuration file where -# it should appear only once). See also the "--disable" option for examples. -enable= - - -[REPORTS] - -# Python expression which should return a note less than 10 (10 is the highest -# note). You have access to the variables errors warning, statement which -# respectively contain the number of errors / warnings messages and the total -# number of statements analyzed. This is used by the global evaluation report -# (RP0004). -evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) - -# Template used to display messages. This is a python new-style format string -# used to format the message information. See doc for all details -#msg-template= - -# Set the output format. Available formats are text, parseable, colorized, json -# and msvs (visual studio).You can also give a reporter class, eg -# mypackage.mymodule.MyReporterClass. -output-format=text - -# Tells whether to display a full report or only the messages -reports=no - -# Activate the evaluation score. -score=yes - - -[REFACTORING] - -# Maximum number of nested blocks for function / method body -max-nested-blocks=5 - - -[LOGGING] - -# Logging modules to check that the string format arguments are in logging -# function parameter format -logging-modules=logging - - -[SPELLING] - -# Spelling dictionary name. Available dictionaries: none. To make it working -# install python-enchant package. -spelling-dict= - -# List of comma separated words that should not be checked. -spelling-ignore-words= - -# A path to a file that contains private dictionary; one word per line. -spelling-private-dict-file= - -# Tells whether to store unknown words to indicated private dictionary in -# --spelling-private-dict-file option instead of raising a message. -spelling-store-unknown-words=no - - -[MISCELLANEOUS] - -# List of note tags to take in consideration, separated by a comma. -# notes=FIXME,XXX,TODO -notes=FIXME,XXX - - -[TYPECHECK] - -# List of decorators that produce context managers, such as -# contextlib.contextmanager. Add to this list to register other decorators that -# produce valid context managers. -contextmanager-decorators=contextlib.contextmanager - -# List of members which are set dynamically and missed by pylint inference -# system, and so shouldn't trigger E1101 when accessed. Python regular -# expressions are accepted. -generated-members= - -# Tells whether missing members accessed in mixin class should be ignored. A -# mixin class is detected if its name ends with "mixin" (case insensitive). -ignore-mixin-members=yes - -# This flag controls whether pylint should warn about no-member and similar -# checks whenever an opaque object is returned when inferring. The inference -# can return multiple potential results while evaluating a Python object, but -# some branches might not be evaluated, which results in partial inference. In -# that case, it might be useful to still emit no-member and other checks for -# the rest of the inferred objects. -ignore-on-opaque-inference=yes - -# List of class names for which member attributes should not be checked (useful -# for classes with dynamically set attributes). This supports the use of -# qualified names. -ignored-classes=optparse.Values,thread._local,_thread._local - -# List of module names for which member attributes should not be checked -# (useful for modules/projects where namespaces are manipulated during runtime -# and thus existing member attributes cannot be deduced by static analysis. It -# supports qualified module names, as well as Unix pattern matching. -ignored-modules=board - -# Show a hint with possible names when a member name was not found. The aspect -# of finding the hint is based on edit distance. -missing-member-hint=yes - -# The minimum edit distance a name should have in order to be considered a -# similar match for a missing member name. -missing-member-hint-distance=1 - -# The total number of similar names that should be taken in consideration when -# showing a hint for a missing member. -missing-member-max-choices=1 - - -[VARIABLES] - -# List of additional names supposed to be defined in builtins. Remember that -# you should avoid to define new builtins when possible. -additional-builtins= - -# Tells whether unused global variables should be treated as a violation. -allow-global-unused-variables=yes - -# List of strings which can identify a callback function by name. A callback -# name must start or end with one of those strings. -callbacks=cb_,_cb - -# A regular expression matching the name of dummy variables (i.e. expectedly -# not used). -dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ - -# Argument names that match this expression will be ignored. Default to name -# with leading underscore -ignored-argument-names=_.*|^ignored_|^unused_ - -# Tells whether we should check for unused import in __init__ files. -init-import=no - -# List of qualified module names which can have objects that can redefine -# builtins. -redefining-builtins-modules=six.moves,future.builtins - - -[FORMAT] - -# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. -# expected-line-ending-format= -expected-line-ending-format=LF - -# Regexp for a line that is allowed to be longer than the limit. -ignore-long-lines=^\s*(# )??$ - -# Number of spaces of indent required inside a hanging or continued line. -indent-after-paren=4 - -# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 -# tab). -indent-string=' ' - -# Maximum number of characters on a single line. -max-line-length=100 - -# Maximum number of lines in a module -max-module-lines=1000 - -# Allow the body of a class to be on the same line as the declaration if body -# contains single statement. -single-line-class-stmt=no - -# Allow the body of an if to be on the same line as the test if there is no -# else. -single-line-if-stmt=no - - -[SIMILARITIES] - -# Ignore comments when computing similarities. -ignore-comments=yes - -# Ignore docstrings when computing similarities. -ignore-docstrings=yes - -# Ignore imports when computing similarities. -ignore-imports=yes - -# Minimum lines number of a similarity. -min-similarity-lines=12 - - -[BASIC] - -# Regular expression matching correct argument names -argument-rgx=(([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 - -# Regular expression matching correct class attribute names -class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - -# Regular expression matching correct class names -# class-rgx=[A-Z_][a-zA-Z0-9]+$ -class-rgx=[A-Z_][a-zA-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 - -# 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 - -# Regular expression matching correct inline iteration names -inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ - -# Regular expression matching correct method names -method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-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 - -# 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=builtins.Exception diff --git a/README.rst b/README.rst index 3e85caf..1c465be 100644 --- a/README.rst +++ b/README.rst @@ -13,9 +13,9 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_ST7789/actions/ :alt: Build Status -.. image:: https://img.shields.io/badge/code%20style-black-000000.svg - :target: https://github.com/psf/black - :alt: Code Style: Black +.. 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. diff --git a/adafruit_st7789.py b/adafruit_st7789.py index b37f264..6a2ce7a 100755 --- a/adafruit_st7789.py +++ b/adafruit_st7789.py @@ -40,27 +40,27 @@ """ -# Starting in CircuitPython 9.x fourwire will be a seperate internal library -# rather than a component of the displayio library +from busdisplay import BusDisplay + try: + import typing + from fourwire import FourWire - from busdisplay import BusDisplay except ImportError: - from displayio import FourWire - from displayio import Display as BusDisplay + 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"\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 ) 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/conf.py b/docs/conf.py index b71979a..fc396a0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,12 +1,10 @@ -# -*- coding: utf-8 -*- - # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries # # SPDX-License-Identifier: MIT +import datetime import os import sys -import datetime sys.path.insert(0, os.path.abspath("..")) @@ -28,7 +26,7 @@ # 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", None), @@ -48,9 +46,7 @@ creation_year = "2019" current_year = str(datetime.datetime.now().year) year_duration = ( - current_year - if current_year == creation_year - else creation_year + " - " + current_year + current_year if current_year == creation_year else creation_year + " - " + current_year ) copyright = year_duration + " Melissa LeBlanc-Williams" author = "Melissa LeBlanc-Williams" diff --git a/examples/st7789_170x320_1.9_simpletest.py b/examples/st7789_170x320_1.9_simpletest.py index c3fc4cf..6049755 100644 --- a/examples/st7789_170x320_1.9_simpletest.py +++ b/examples/st7789_170x320_1.9_simpletest.py @@ -5,17 +5,13 @@ 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 terminalio 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 +import terminalio from adafruit_display_text import label +from fourwire import FourWire + from adafruit_st7789 import ST7789 BORDER_WIDTH = 20 diff --git a/examples/st7789_172x320_1.47_simpletest.py b/examples/st7789_172x320_1.47_simpletest.py index a61a5ae..0a55c24 100644 --- a/examples/st7789_172x320_1.47_simpletest.py +++ b/examples/st7789_172x320_1.47_simpletest.py @@ -5,19 +5,14 @@ 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 terminalio 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 +import terminalio from adafruit_display_text import label -from adafruit_st7789 import ST7789 +from fourwire import FourWire +from adafruit_st7789 import ST7789 BORDER_WIDTH = 28 TEXT_SCALE = 3 diff --git a/examples/st7789_240x135_pitft_simpletest.py b/examples/st7789_240x135_pitft_simpletest.py index e9a050d..f04f8ac 100644 --- a/examples/st7789_240x135_pitft_simpletest.py +++ b/examples/st7789_240x135_pitft_simpletest.py @@ -7,17 +7,13 @@ Pinouts are for the 1.14" Mini PiTFT and should be run in CPython. """ + import board -import terminalio 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 +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 @@ -35,9 +31,7 @@ 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 -) +display = ST7789(display_bus, rotation=90, width=240, height=135, rowstart=40, colstart=53) # Make the display context splash = displayio.Group() @@ -51,14 +45,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 diff --git a/examples/st7789_240x135_simpletest.py b/examples/st7789_240x135_simpletest.py index 0821810..016b1cf 100644 --- a/examples/st7789_240x135_simpletest.py +++ b/examples/st7789_240x135_simpletest.py @@ -5,17 +5,13 @@ 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 terminalio 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 +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 @@ -33,9 +29,7 @@ tft_dc = board.D6 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 -) +display = ST7789(display_bus, rotation=270, width=240, height=135, rowstart=40, colstart=53) # Make the display context splash = displayio.Group() @@ -49,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 diff --git a/examples/st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py b/examples/st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py index c4209df..842e5d4 100644 --- a/examples/st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py +++ b/examples/st7789_240x135_simpletest_Pimoroni_Pico_Display_Pack.py @@ -5,18 +5,14 @@ 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 terminalio 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 +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 @@ -63,14 +59,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 diff --git a/examples/st7789_240x240_bonnet_simpletest.py b/examples/st7789_240x240_bonnet_simpletest.py index 3e24f57..2246840 100644 --- a/examples/st7789_240x240_bonnet_simpletest.py +++ b/examples/st7789_240x240_bonnet_simpletest.py @@ -7,17 +7,13 @@ Pinouts are for the 1.3" TFT Bonnet and should be run in CPython. """ + import board -import terminalio 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 +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 diff --git a/examples/st7789_240x240_pitft_simpletest.py b/examples/st7789_240x240_pitft_simpletest.py index a779d47..c86eea9 100644 --- a/examples/st7789_240x240_pitft_simpletest.py +++ b/examples/st7789_240x240_pitft_simpletest.py @@ -7,17 +7,13 @@ Pinouts are for the 1.3" PiTFT and should be run in CPython. """ + import board -import terminalio 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 +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 diff --git a/examples/st7789_240x240_simpletest_Pimoroni_Pico_Explorer.py b/examples/st7789_240x240_simpletest_Pimoroni_Pico_Explorer.py index 930d773..eff0cf4 100644 --- a/examples/st7789_240x240_simpletest_Pimoroni_Pico_Explorer.py +++ b/examples/st7789_240x240_simpletest_Pimoroni_Pico_Explorer.py @@ -5,18 +5,14 @@ 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 terminalio 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 +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 diff --git a/examples/st7789_240x240_simpletest_Waveshare_PicoLCD_1_3.py b/examples/st7789_240x240_simpletest_Waveshare_PicoLCD_1_3.py index ddb35c9..8c56920 100644 --- a/examples/st7789_240x240_simpletest_Waveshare_PicoLCD_1_3.py +++ b/examples/st7789_240x240_simpletest_Waveshare_PicoLCD_1_3.py @@ -5,18 +5,14 @@ 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 terminalio 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 +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 diff --git a/examples/st7789_280x240_simpletest.py b/examples/st7789_280x240_simpletest.py index f2ed86f..e8229e6 100644 --- a/examples/st7789_280x240_simpletest.py +++ b/examples/st7789_280x240_simpletest.py @@ -5,17 +5,13 @@ 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 terminalio 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 +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 diff --git a/examples/st7789_320x240_simpletest.py b/examples/st7789_320x240_simpletest.py index c68913a..357e130 100644 --- a/examples/st7789_320x240_simpletest.py +++ b/examples/st7789_320x240_simpletest.py @@ -5,17 +5,13 @@ 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 terminalio 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 +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 diff --git a/examples/st7789_320x240_simpletest_Pimoroni_Pico_Display_2_0.py b/examples/st7789_320x240_simpletest_Pimoroni_Pico_Display_2_0.py index 9f92b96..846b084 100644 --- a/examples/st7789_320x240_simpletest_Pimoroni_Pico_Display_2_0.py +++ b/examples/st7789_320x240_simpletest_Pimoroni_Pico_Display_2_0.py @@ -5,18 +5,14 @@ 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 terminalio 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 +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 diff --git a/examples/st7789_simpletest.py b/examples/st7789_simpletest.py index 1e80711..bfeb998 100644 --- a/examples/st7789_simpletest.py +++ b/examples/st7789_simpletest.py @@ -5,17 +5,13 @@ 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 terminalio 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 +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 diff --git a/examples/st7789_tft_gizmo_simpletest.py b/examples/st7789_tft_gizmo_simpletest.py index 40403a6..17bf207 100644 --- a/examples/st7789_tft_gizmo_simpletest.py +++ b/examples/st7789_tft_gizmo_simpletest.py @@ -5,18 +5,14 @@ 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 terminalio 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 +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 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" From 3bf64607ad45b25866a04f59ebc4352689146233 Mon Sep 17 00:00:00 2001 From: Alex Leung Date: Sun, 30 Mar 2025 21:58:36 +0800 Subject: [PATCH 88/91] Add 2 arguments: 1. bgr: bool, support for choosing bgr or rgb pixel order. 2. invert: bool, support for sending color inverse command. --- README.rst | 2 +- adafruit_st7789.py | 22 +++++++++++++++++----- examples/st7789_simpletest.py | 2 +- 3 files changed, 19 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 1c465be..fa72f68 100644 --- a/README.rst +++ b/README.rst @@ -57,7 +57,7 @@ Usage Example 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() diff --git a/adafruit_st7789.py b/adafruit_st7789.py index 6a2ce7a..959f4c3 100755 --- a/adafruit_st7789.py +++ b/adafruit_st7789.py @@ -57,7 +57,6 @@ 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 @@ -66,7 +65,20 @@ # pylint: disable=too-few-public-methods class ST7789(BusDisplay): - """ST7789 driver""" - - def __init__(self, bus: FourWire, **kwargs) -> None: - super().__init__(bus, _INIT_SEQUENCE, **kwargs) + """ + ST7789 driver + + :param FourWire bus: bus that the display is connected to + :param bool bgr: (Optional) An extra init sequence to append (default=False) + :param bool invert: (Optional) Invert the colors (default=False) + """ + + def __init__(self, bus: FourWire, *, bgr: bool = False, invert: bool = False, **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) \ No newline at end of file diff --git a/examples/st7789_simpletest.py b/examples/st7789_simpletest.py index bfeb998..4d48e12 100644 --- a/examples/st7789_simpletest.py +++ b/examples/st7789_simpletest.py @@ -23,7 +23,7 @@ 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() From f08e3643f541eb16fef29e60011c6669f68ffe58 Mon Sep 17 00:00:00 2001 From: Alex Leung Date: Thu, 3 Apr 2025 00:08:26 +0800 Subject: [PATCH 89/91] Change the defualt value of Modify the default values of the __init__() parameters to make it compatible with the behavior of old code. --- adafruit_st7789.py | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/adafruit_st7789.py b/adafruit_st7789.py index 959f4c3..0042647 100755 --- a/adafruit_st7789.py +++ b/adafruit_st7789.py @@ -43,7 +43,7 @@ from busdisplay import BusDisplay try: - import typing + from typing import Any from fourwire import FourWire except ImportError: @@ -58,7 +58,6 @@ b"\x3a\x81\x55\x0a" # _COLMOD and Delay 10ms b"\x36\x01\x08" # _MADCTL b"\x13\x80\x0a" # _NORON and Delay 10ms - b"\x36\x01\xc0" # _MADCTL b"\x29\x80\xff" # _DISPON and Delay 500ms ) @@ -66,14 +65,14 @@ # pylint: disable=too-few-public-methods class ST7789(BusDisplay): """ - ST7789 driver + ST7789 driver - :param FourWire bus: bus that the display is connected to - :param bool bgr: (Optional) An extra init sequence to append (default=False) - :param bool invert: (Optional) Invert the colors (default=False) - """ + :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: FourWire, *, bgr: bool = False, invert: bool = False, **kwargs: Any): + 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 From 2304e3aabadae1c8cd36586af55c48bbef15897b Mon Sep 17 00:00:00 2001 From: Alex Leung Date: Thu, 3 Apr 2025 00:30:35 +0800 Subject: [PATCH 90/91] Reformatted. --- adafruit_st7789.py | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/adafruit_st7789.py b/adafruit_st7789.py index 0042647..3c8019d 100755 --- a/adafruit_st7789.py +++ b/adafruit_st7789.py @@ -48,7 +48,6 @@ from fourwire import FourWire except ImportError: pass - __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_ST7789.git" @@ -65,19 +64,25 @@ # pylint: disable=too-few-public-methods class ST7789(BusDisplay): """ - ST7789 driver - - :param FourWire bus: bus that the display is connected to + 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: FourWire, *, bgr: bool = True, invert: bool = True, **kwargs: Any): + 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 + 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 + 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) \ No newline at end of file + super().__init__(bus, init_sequence, **kwargs) From 2b3fb8377fcc074ac7f66761698e46506386ab1d Mon Sep 17 00:00:00 2001 From: Alex Leung Date: Thu, 3 Apr 2025 00:58:00 +0800 Subject: [PATCH 91/91] ruff fixed. --- adafruit_st7789.py | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/adafruit_st7789.py b/adafruit_st7789.py index 3c8019d..8c448c7 100755 --- a/adafruit_st7789.py +++ b/adafruit_st7789.py @@ -71,18 +71,12 @@ class ST7789(BusDisplay): :param bool invert: (Optional) Invert the colors (default=True) """ - def __init__( - self, bus: FourWire, *, bgr: bool = True, invert: bool = True, **kwargs: Any - ): + 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 - ) + 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 - ) + 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)