From f0aefb3b795a1e48033bbc029c7cf75d237efaad Mon Sep 17 00:00:00 2001 From: dherrada Date: Tue, 9 Nov 2021 13:31:14 -0500 Subject: [PATCH 01/52] 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 304aa0b09c3f1947cd76744f51c2592af97ecf5e Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 23 Nov 2021 13:10:01 -0600 Subject: [PATCH 02/52] 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 768d10cc808e44977f1ab69b84f6ce3f794c4e05 Mon Sep 17 00:00:00 2001 From: Cedar Grove Maker Studios Date: Wed, 29 Dec 2021 14:25:33 -0800 Subject: [PATCH 03/52] Eliminate race condition between x/y values and z (press) values. Significantly improves touch coordinate accuracy and reliability. --- adafruit_touchscreen.py | 67 +++++++++++++++++++++-------------------- 1 file changed, 34 insertions(+), 33 deletions(-) diff --git a/adafruit_touchscreen.py b/adafruit_touchscreen.py index 0ea4f87..12a8845 100644 --- a/adafruit_touchscreen.py +++ b/adafruit_touchscreen.py @@ -62,12 +62,12 @@ class Touchscreen: :attr:`calibration` is a tuple of two tuples, the default is ((0, 65535), (0, 65535)). The numbers are the min/max readings for the X and Y coordinate planes, respectively. To figure these out, pass in - no calibration value and read the raw values out while touching the - panel. + no calibration value or size value and read the raw minimum and maximum + values out while touching the panel. :attr:`size` is a tuple that gives the X and Y pixel size of the underlying screen. If passed in, we will automatically scale/rotate so touches correspond to the graphical coordinate system. - + :param ~microcontroller.Pin x1_pin: Data pin for Left side of the screen. Must also be capable of becoming AnalogIn pins. :param ~microcontroller.Pin x2_pin: Data pin for Right side of the screen. @@ -108,6 +108,7 @@ def __init__( self._rx_plate = x_resistance self._xsamples = [0] * samples self._ysamples = [0] * samples + self._zsamples = [0] * samples if not calibration: calibration = ((0, 65535), (0, 65535)) self._calib = calibration @@ -118,36 +119,6 @@ def __init__( def touch_point(self): # pylint: disable=too-many-locals """A tuple that represents the x, y and z (touch pressure) coordinates of a touch. Or, None if no touch is detected""" - with DigitalInOut(self._yp_pin) as y_p: - with DigitalInOut(self._ym_pin) as y_m: - with AnalogIn(self._xp_pin) as x_p: - y_p.switch_to_output(True) - y_m.switch_to_output(False) - for i in range( # pylint: disable=consider-using-enumerate - len(self._xsamples) - ): - self._xsamples[i] = x_p.value - x = sum(self._xsamples) / len(self._xsamples) - x_size = 65535 - if self._size: - x_size = self._size[0] - x = int(map_range(x, self._calib[0][0], self._calib[0][1], 0, x_size)) - - with DigitalInOut(self._xp_pin) as x_p: - with DigitalInOut(self._xm_pin) as x_m: - with AnalogIn(self._yp_pin) as y_p: - x_p.switch_to_output(True) - x_m.switch_to_output(False) - for i in range( # pylint: disable=consider-using-enumerate - len(self._ysamples) - ): - self._ysamples[i] = y_p.value - y = sum(self._ysamples) / len(self._ysamples) - y_size = 65535 - if self._size: - y_size = self._size[1] - y = int(map_range(y, self._calib[1][0], self._calib[1][1], 0, y_size)) - z_1 = z_2 = z = None with DigitalInOut(self._xp_pin) as x_p: x_p.switch_to_output(False) @@ -160,5 +131,35 @@ def touch_point(self): # pylint: disable=too-many-locals # print(z_1, z_2) z = 65535 - (z_2 - z_1) if z > self._zthresh: + with DigitalInOut(self._yp_pin) as y_p: + with DigitalInOut(self._ym_pin) as y_m: + with AnalogIn(self._xp_pin) as x_p: + y_p.switch_to_output(True) + y_m.switch_to_output(False) + for i in range( # pylint: disable=consider-using-enumerate + len(self._xsamples) + ): + self._xsamples[i] = x_p.value + x = sum(self._xsamples) / len(self._xsamples) + x_size = 65535 + if self._size: + x_size = self._size[0] + x = int(map_range(x, self._calib[0][0], self._calib[0][1], 0, x_size)) + + with DigitalInOut(self._xp_pin) as x_p: + with DigitalInOut(self._xm_pin) as x_m: + with AnalogIn(self._yp_pin) as y_p: + x_p.switch_to_output(True) + x_m.switch_to_output(False) + for i in range( # pylint: disable=consider-using-enumerate + len(self._ysamples) + ): + self._ysamples[i] = y_p.value + y = sum(self._ysamples) / len(self._ysamples) + y_size = 65535 + if self._size: + y_size = self._size[1] + y = int(map_range(y, self._calib[1][0], self._calib[1][1], 0, y_size)) + return (x, y, z) return None From bc3cd0fb99fb455a25eb13187f54153fb02b69f3 Mon Sep 17 00:00:00 2001 From: Cedar Grove Maker Studios Date: Wed, 29 Dec 2021 15:05:30 -0800 Subject: [PATCH 04/52] Eliminate race condition --- adafruit_touchscreen.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_touchscreen.py b/adafruit_touchscreen.py index 12a8845..987f525 100644 --- a/adafruit_touchscreen.py +++ b/adafruit_touchscreen.py @@ -67,7 +67,7 @@ class Touchscreen: :attr:`size` is a tuple that gives the X and Y pixel size of the underlying screen. If passed in, we will automatically scale/rotate so touches correspond to the graphical coordinate system. - + :param ~microcontroller.Pin x1_pin: Data pin for Left side of the screen. Must also be capable of becoming AnalogIn pins. :param ~microcontroller.Pin x2_pin: Data pin for Right side of the screen. From bd6c72c8565841d0cac56f933ef12f556649f144 Mon Sep 17 00:00:00 2001 From: Cedar Grove Maker Studios Date: Fri, 31 Dec 2021 01:36:04 -0800 Subject: [PATCH 05/52] remove debug artifact --- adafruit_touchscreen.py | 1 - 1 file changed, 1 deletion(-) diff --git a/adafruit_touchscreen.py b/adafruit_touchscreen.py index 987f525..a393227 100644 --- a/adafruit_touchscreen.py +++ b/adafruit_touchscreen.py @@ -108,7 +108,6 @@ def __init__( self._rx_plate = x_resistance self._xsamples = [0] * samples self._ysamples = [0] * samples - self._zsamples = [0] * samples if not calibration: calibration = ((0, 65535), (0, 65535)) self._calib = calibration From 3e91b94e0f47814dd78bb556d9c3ed52167b4d4b Mon Sep 17 00:00:00 2001 From: dherrada Date: Thu, 13 Jan 2022 16:27:30 -0500 Subject: [PATCH 06/52] 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 96dce078803f29db0f3919d4b655e00dfc793726 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 24 Jan 2022 16:46:17 -0500 Subject: [PATCH 07/52] 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 e7b5da7..c854e1d 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,7 @@ Introduction ============ .. image:: https://readthedocs.org/projects/adafruit-circuitpython-touchscreen/badge/?version=latest - :target: https://circuitpython.readthedocs.io/projects/touchscreen/en/latest/ + :target: https://docs.circuitpython.org/projects/touchscreen/en/latest/ :alt: Documentation Status .. image:: https://img.shields.io/discord/327254708534116352.svg @@ -73,7 +73,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 7e22eca..ebe865e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -29,8 +29,8 @@ intersphinx_mapping = { - "python": ("https://docs.python.org/3.4", None), - "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None), + "python": ("https://docs.python.org/3", None), + "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None), } # Add any paths that contain templates here, relative to this directory. diff --git a/docs/index.rst b/docs/index.rst index 606f5f8..f7e7a87 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -38,7 +38,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 c0920f8..e28124d 100644 --- a/setup.py +++ b/setup.py @@ -44,8 +44,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 touchscreen resistive", From f048daa99b6448f5d44d4ad20d0d3988b0c041a2 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Thu, 10 Feb 2022 09:29:32 -0500 Subject: [PATCH 08/52] Consolidate Documentation sections of README --- README.rst | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index c854e1d..9b25634 100644 --- a/README.rst +++ b/README.rst @@ -75,14 +75,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 61fc9174413c3de30cf5be732ee0fbc8594d8d97 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 14 Feb 2022 15:35:02 -0500 Subject: [PATCH 09/52] 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 86c2e134d3a25494b4db1ad0ae67c24e2c62e146 Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Mon, 28 Mar 2022 15:52:04 -0400 Subject: [PATCH 10/52] 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 e58ad85c522511f24efaebe77bb7af0b87d45705 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Thu, 21 Apr 2022 15:00:27 -0400 Subject: [PATCH 11/52] 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 6eb639fea0f2dfcb55ff529b2cb4992256b5a97f Mon Sep 17 00:00:00 2001 From: evaherrada Date: Fri, 22 Apr 2022 15:59:28 -0400 Subject: [PATCH 12/52] Patch: Replaced discord badge image --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 9b25634..8202076 100644 --- a/README.rst +++ b/README.rst @@ -5,7 +5,7 @@ Introduction :target: https://docs.circuitpython.org/projects/touchscreen/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 bd65356b672506c483f10419514f4e512aa9f7bb Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sun, 24 Apr 2022 13:59:38 -0500 Subject: [PATCH 13/52] change discord badge --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 8202076..f23844b 100644 --- a/README.rst +++ b/README.rst @@ -5,7 +5,7 @@ Introduction :target: https://docs.circuitpython.org/projects/touchscreen/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 d6debff40028351672932b11eedadd885bd9792e Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 15 May 2022 12:19:40 -0400 Subject: [PATCH 14/52] 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 71989b3abc571cc47c3bd3b195ed98a8a2e6a603 Mon Sep 17 00:00:00 2001 From: Cedar Grove Maker Studios Date: Mon, 23 May 2022 16:44:16 -0700 Subject: [PATCH 15/52] add touchscreen calibrator example --- examples/touch_calibrator_built_in.py | 200 ++++++++++++++++++++++++++ 1 file changed, 200 insertions(+) create mode 100755 examples/touch_calibrator_built_in.py diff --git a/examples/touch_calibrator_built_in.py b/examples/touch_calibrator_built_in.py new file mode 100755 index 0000000..7b1f0fb --- /dev/null +++ b/examples/touch_calibrator_built_in.py @@ -0,0 +1,200 @@ +# SPDX-FileCopyrightText: 2022 Cedar Grove Maker Studios +# SPDX-License-Identifier: MIT + +""" +touch_calibrator_built_in.py 2022-01-21 v2.1 + +Author(s): JG for Cedar Grove Maker Studios + +On-screen touchscreen calibrator for built-in displays. + +When the test screen appears, use a stylus to swipe to the four edges +of the visible display area. As the screen is calibrated, the small red +square tracks the stylus tip (REPL_ONLY=False). Minimum and maximum +calibration values will display on the screen and in the REPL. The calibration +tuple can be copied and pasted into the calling code's touchscreen +instantiation statement. + +DISPLAY_ROTATION: Display rotation value in degrees. Only values of +None, 0, 90, 180, and 270 degrees are accepted. Defaults to None, the +previous orientation of the display. + +REPL_ONLY: If False, calibration values are shown graphically on the screen +and printed to the REPL. If True, the values are only printed to the REPL. +Default value is False. +""" + +import time +import board +import displayio +import vectorio +import terminalio +from adafruit_display_text.label import Label +import adafruit_touchscreen +from simpleio import map_range + +# Operational parameters: +DISPLAY_ROTATION = 0 # Specify 0, 90, 180, or 270 degrees +REPL_ONLY = False # True to disable graphics + +# pylint: disable=too-few-public-methods +class Colors: + """A collection of colors used for graphic objects.""" + + BLUE_DK = 0x000060 # Screen fill + RED = 0xFF0000 # Boundary + WHITE = 0xFFFFFF # Text + + +# Instantiate the built-in display. +display = board.DISPLAY + +# Check rotation value and update display. +# Always set rotation before instantiating the touchscreen. +if DISPLAY_ROTATION is not None and DISPLAY_ROTATION in (0, 90, 180, 270): + display.rotation = DISPLAY_ROTATION +else: + print("Warning: invalid rotation value -- defalting to zero") + display.rotation = 0 + time.sleep(1) + +# Activate the display graphics unless REPL_ONLY=True. +if not REPL_ONLY: + display_group = displayio.Group() + display.show(display_group) + +# Instantiate touch screen without calibration or display size parameters +if display.rotation == 0: + ts = adafruit_touchscreen.Touchscreen( + board.TOUCH_XL, + board.TOUCH_XR, + board.TOUCH_YD, + board.TOUCH_YU, + # calibration=((5200, 59000), (5250, 59500)), + # size=(board.DISPLAY.width, board.DISPLAY.height), + ) + +elif display.rotation == 90: + ts = adafruit_touchscreen.Touchscreen( + board.TOUCH_YU, + board.TOUCH_YD, + board.TOUCH_XL, + board.TOUCH_XR, + # calibration=((5250, 59500), (5200, 59000)), + # size=(board.DISPLAY.width, board.DISPLAY.height), + ) + +elif display.rotation == 180: + ts = adafruit_touchscreen.Touchscreen( + board.TOUCH_XR, + board.TOUCH_XL, + board.TOUCH_YU, + board.TOUCH_YD, + # calibration=((5200, 59000), (5250, 59500)), + # size=(board.DISPLAY.width, board.DISPLAY.height), + ) + +elif display.rotation == 270: + ts = adafruit_touchscreen.Touchscreen( + board.TOUCH_YD, + board.TOUCH_YU, + board.TOUCH_XR, + board.TOUCH_XL, + # calibration=((5250, 59500), (5200, 59000)), + # size=(board.DISPLAY.width, board.DISPLAY.height), + ) +else: + raise ValueError("Rotation value must be 0, 90, 180, or 270") + +# Define the graphic objects if REPL_ONLY = False. +if not REPL_ONLY: + # Define the text graphic objects + font_0 = terminalio.FONT + + coordinates = Label( + font=font_0, + text="calib: ((x_min, x_max), (y_min, y_max))", + color=Colors.WHITE, + ) + coordinates.anchor_point = (0.5, 0.5) + coordinates.anchored_position = ( + board.DISPLAY.width // 2, + board.DISPLAY.height // 4, + ) + + display_rotation = Label( + font=font_0, + text="rotation: " + str(display.rotation), + color=Colors.WHITE, + ) + display_rotation.anchor_point = (0.5, 0.5) + display_rotation.anchored_position = ( + board.DISPLAY.width // 2, + board.DISPLAY.height // 4 - 30, + ) + + # Define graphic objects for the screen fill, boundary, and touch pen. + target_palette = displayio.Palette(1) + target_palette[0] = Colors.BLUE_DK + screen_fill = vectorio.Rectangle( + pixel_shader=target_palette, + x=2, + y=2, + width=board.DISPLAY.width - 4, + height=board.DISPLAY.height - 4, + ) + + target_palette = displayio.Palette(1) + target_palette[0] = Colors.RED + boundary = vectorio.Rectangle( + pixel_shader=target_palette, + x=0, + y=0, + width=board.DISPLAY.width, + height=board.DISPLAY.height, + ) + + pen = vectorio.Rectangle( + pixel_shader=target_palette, + x=board.DISPLAY.width // 2, + y=board.DISPLAY.height // 2, + width=10, + height=10, + ) + + display_group.append(boundary) + display_group.append(screen_fill) + display_group.append(pen) + display_group.append(coordinates) + display_group.append(display_rotation) + +# pylint: disable=invalid-name +# Reset x and y values to raw touchscreen mid-point before measurement. +x_min = x_max = y_min = y_max = 65535 // 2 + +print("Touchscreen Calibrator") +print(" Use a stylus to swipe slightly beyond the") +print(" four edges of the visible display area.") +print(" ") +print(f" display rotation: {display.rotation} degrees") +print(" Calibration values follow:") +print(" ") + +while True: + time.sleep(0.100) + touch = ts.touch_point # Check for touch + if touch: + if not REPL_ONLY: + pen.x = int(map_range(touch[0], x_min, x_max, 0, board.DISPLAY.width)) - 5 + pen.y = int(map_range(touch[1], y_min, y_max, 0, board.DISPLAY.height)) - 5 + + # Remember minimum and maximum values for the calibration tuple. + x_min = min(x_min, touch[0]) + x_max = max(x_max, touch[0]) + y_min = min(y_min, touch[1]) + y_max = max(y_max, touch[1]) + + # Show the calibration tuple. + print(f"(({x_min}, {x_max}), ({y_min}, {y_max}))") + if not REPL_ONLY: + coordinates.text = f"calib: (({x_min}, {x_max}), ({y_min}, {y_max}))" From 81b5c69ad74d1a1fb7e92c59836c1b75860997b7 Mon Sep 17 00:00:00 2001 From: Cedar Grove Maker Studios Date: Mon, 23 May 2022 16:59:34 -0700 Subject: [PATCH 16/52] Update touch_calibrator_built_in.py --- examples/touch_calibrator_built_in.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/examples/touch_calibrator_built_in.py b/examples/touch_calibrator_built_in.py index 7b1f0fb..60839a5 100755 --- a/examples/touch_calibrator_built_in.py +++ b/examples/touch_calibrator_built_in.py @@ -30,8 +30,9 @@ import vectorio import terminalio from adafruit_display_text.label import Label -import adafruit_touchscreen from simpleio import map_range +import adafruit_touchscreen + # Operational parameters: DISPLAY_ROTATION = 0 # Specify 0, 90, 180, or 270 degrees From 28958ff5e2643a1eff775e4770cb4f3084568858 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 22 May 2022 00:18:55 -0400 Subject: [PATCH 17/52] 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 8a471de520afc7aeef8fec9a1d7338ab3092f8d4 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 22 May 2022 00:18:23 -0400 Subject: [PATCH 18/52] 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 41cff4a47d7ccc8d5859e84ca24fe9ca2c76b20a Mon Sep 17 00:00:00 2001 From: Cedar Grove Maker Studios Date: Fri, 27 May 2022 20:17:05 -0700 Subject: [PATCH 19/52] update and refactor with @Foamyguy's suggestions --- ....py => touchscreen_calibrator_built_in.py} | 22 +++++++++---------- 1 file changed, 10 insertions(+), 12 deletions(-) rename examples/{touch_calibrator_built_in.py => touchscreen_calibrator_built_in.py} (94%) diff --git a/examples/touch_calibrator_built_in.py b/examples/touchscreen_calibrator_built_in.py similarity index 94% rename from examples/touch_calibrator_built_in.py rename to examples/touchscreen_calibrator_built_in.py index 60839a5..cfa9591 100755 --- a/examples/touch_calibrator_built_in.py +++ b/examples/touchscreen_calibrator_built_in.py @@ -2,7 +2,7 @@ # SPDX-License-Identifier: MIT """ -touch_calibrator_built_in.py 2022-01-21 v2.1 +touch_calibrator_built_in.py 2022-05-27 v2.2 Author(s): JG for Cedar Grove Maker Studios @@ -47,7 +47,7 @@ class Colors: WHITE = 0xFFFFFF # Text -# Instantiate the built-in display. +# Instantiate the built-in display display = board.DISPLAY # Check rotation value and update display. @@ -55,11 +55,11 @@ class Colors: if DISPLAY_ROTATION is not None and DISPLAY_ROTATION in (0, 90, 180, 270): display.rotation = DISPLAY_ROTATION else: - print("Warning: invalid rotation value -- defalting to zero") + print("Warning: invalid rotation value -- defaulting to zero") display.rotation = 0 time.sleep(1) -# Activate the display graphics unless REPL_ONLY=True. +# Activate the display graphics unless REPL_ONLY=True if not REPL_ONLY: display_group = displayio.Group() display.show(display_group) @@ -107,7 +107,7 @@ class Colors: else: raise ValueError("Rotation value must be 0, 90, 180, or 270") -# Define the graphic objects if REPL_ONLY = False. +# Define the graphic objects if REPL_ONLY = False if not REPL_ONLY: # Define the text graphic objects font_0 = terminalio.FONT @@ -134,7 +134,7 @@ class Colors: board.DISPLAY.height // 4 - 30, ) - # Define graphic objects for the screen fill, boundary, and touch pen. + # Define graphic objects for the screen fill, boundary, and touch pen target_palette = displayio.Palette(1) target_palette[0] = Colors.BLUE_DK screen_fill = vectorio.Rectangle( @@ -170,7 +170,7 @@ class Colors: display_group.append(display_rotation) # pylint: disable=invalid-name -# Reset x and y values to raw touchscreen mid-point before measurement. +# Reset x and y values to raw touchscreen mid-point before measurement x_min = x_max = y_min = y_max = 65535 // 2 print("Touchscreen Calibrator") @@ -185,11 +185,7 @@ class Colors: time.sleep(0.100) touch = ts.touch_point # Check for touch if touch: - if not REPL_ONLY: - pen.x = int(map_range(touch[0], x_min, x_max, 0, board.DISPLAY.width)) - 5 - pen.y = int(map_range(touch[1], y_min, y_max, 0, board.DISPLAY.height)) - 5 - - # Remember minimum and maximum values for the calibration tuple. + # Remember minimum and maximum values for the calibration tuple x_min = min(x_min, touch[0]) x_max = max(x_max, touch[0]) y_min = min(y_min, touch[1]) @@ -198,4 +194,6 @@ class Colors: # Show the calibration tuple. print(f"(({x_min}, {x_max}), ({y_min}, {y_max}))") if not REPL_ONLY: + pen.x = int(map_range(touch[0], x_min, x_max, 0, board.DISPLAY.width)) - 5 + pen.y = int(map_range(touch[1], y_min, y_max, 0, board.DISPLAY.height)) - 5 coordinates.text = f"calib: (({x_min}, {x_max}), ({y_min}, {y_max}))" From 7c4db6d6026045102ebb64894ebc530d34d70365 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 30 May 2022 14:25:04 -0400 Subject: [PATCH 20/52] 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 ebe865e..0cb58e9 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 9c13953f8233bfa14a72ae27ca0e03ad447db033 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Tue, 7 Jun 2022 15:35:07 -0400 Subject: [PATCH 21/52] 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 f7e7a87..e71de0c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -37,7 +37,8 @@ Table of Contents .. toctree:: :caption: Other Links - Download + Download from GitHub + Download Library Bundle CircuitPython Reference Documentation CircuitPython Support Forum Discord Chat From ac8859d0f416763c181302cbe8e4fca66c8668db Mon Sep 17 00:00:00 2001 From: evaherrada Date: Fri, 22 Jul 2022 13:59:26 -0400 Subject: [PATCH 22/52] Changed .env to .venv in README.rst --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index f23844b..b238428 100644 --- a/README.rst +++ b/README.rst @@ -46,8 +46,8 @@ To install in a virtual environment in your current project: .. code-block:: shell mkdir project-name && cd project-name - python3 -m venv .env - source .env/bin/activate + python3 -m venv .venv + source .venv/bin/activate pip3 install adafruit-circuitpython-touchscreen Usage Example From a8ca3e99d5f5623f3bb867f27765598a2d98dffe Mon Sep 17 00:00:00 2001 From: evaherrada Date: Tue, 2 Aug 2022 17:01:11 -0400 Subject: [PATCH 23/52] Added Black formatting badge --- README.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.rst b/README.rst index b238428..b609166 100644 --- a/README.rst +++ b/README.rst @@ -13,6 +13,10 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_Touchscreen/actions/ :alt: Build Status +.. image:: https://img.shields.io/badge/code%20style-black-000000.svg + :target: https://github.com/psf/black + :alt: Code Style: Black + CircuitPython library for 4-wire resistive touchscreens From 89ec4565cda5d00c3ffff4feffa95e27df6ae370 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 8 Aug 2022 22:05:54 -0400 Subject: [PATCH 24/52] Switched to pyproject.toml --- .github/workflows/build.yml | 18 +++++++----- .github/workflows/release.yml | 17 ++++++----- optional_requirements.txt | 3 ++ pyproject.toml | 44 ++++++++++++++++++++++++++++ requirements.txt | 2 +- setup.py | 55 ----------------------------------- 6 files changed, 68 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..261a79c --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,44 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +[build-system] +requires = [ + "setuptools", + "wheel", +] + +[project] +name = "adafruit-circuitpython-touchscreen" +description = "CircuitPython library for 4-wire resistive touchscreens" +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_Touchscreen"} +keywords = [ + "adafruit", + "blinka", + "circuitpython", + "micropython", + "touchscreen", + "resistive", +] +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_touchscreen"] + +[tool.setuptools.dynamic] +dependencies = {file = ["requirements.txt"]} +optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} diff --git a/requirements.txt b/requirements.txt index 17a850d..7a984a4 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries # # SPDX-License-Identifier: Unlicense diff --git a/setup.py b/setup.py deleted file mode 100644 index e28124d..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-touchscreen", - use_scm_version=True, - setup_requires=["setuptools_scm"], - description="CircuitPython library for 4-wire resistive touchscreens", - long_description=long_description, - long_description_content_type="text/x-rst", - # The project's main homepage. - url="https://github.com/adafruit/Adafruit_CircuitPython_Touchscreen", - # Author details - author="Adafruit Industries", - author_email="circuitpython@adafruit.com", - install_requires=["Adafruit-Blinka"], - # Choose your license - license="MIT", - # See https://pypi.python.org/pypi?%3Aaction=list_classifiers - classifiers=[ - "Development Status :: 3 - Alpha", - "Intended Audience :: Developers", - "Topic :: Software Development :: Libraries", - "Topic :: System :: Hardware", - "License :: OSI Approved :: MIT License", - "Programming Language :: Python :: 3", - ], - # What does your project relate to? - keywords="adafruit blinka circuitpython micropython touchscreen resistive", - # You can just specify the packages manually here if your project is - # simple. Or you can use find_packages(). - # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER, - # CHANGE `py_modules=['...']` TO `packages=['...']` - py_modules=["adafruit_touchscreen"], -) From 6063eb5c1eb4f2994288d795c3ad4c877e805c00 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 9 Aug 2022 12:03:54 -0400 Subject: [PATCH 25/52] 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 261a79c..ac30ffe 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,6 +6,7 @@ requires = [ "setuptools", "wheel", + "setuptools-scm", ] [project] From 435105c47eb0e74b220888a9b3c2582bcec07156 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 16 Aug 2022 18:09:14 -0400 Subject: [PATCH 26/52] Update version string --- adafruit_touchscreen.py | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_touchscreen.py b/adafruit_touchscreen.py index a393227..b1aa0fd 100644 --- a/adafruit_touchscreen.py +++ b/adafruit_touchscreen.py @@ -21,7 +21,7 @@ """ -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Touchscreen.git" from digitalio import DigitalInOut diff --git a/pyproject.toml b/pyproject.toml index ac30ffe..6dbbdef 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -12,7 +12,7 @@ requires = [ [project] name = "adafruit-circuitpython-touchscreen" description = "CircuitPython library for 4-wire resistive touchscreens" -version = "0.0.0-auto.0" +version = "0.0.0+auto.0" readme = "README.rst" authors = [ {name = "Adafruit Industries", email = "circuitpython@adafruit.com"} From 6f391102e378a9b7e88128170b68c861619de8c9 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 16 Aug 2022 21:09:14 -0400 Subject: [PATCH 27/52] 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 7911eba7733c9c9a6560dfc04452db89b57aca17 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 22 Aug 2022 21:36:31 -0400 Subject: [PATCH 28/52] 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 0cb58e9..21d5e26 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 Touchscreen Library" -copyright = "2019 ladyada" +current_year = str(datetime.datetime.now().year) +copyright = current_year + " ladyada" author = "ladyada" # The version info for the project you're documenting, acts as replacement for From 827e1ca128c44cb703de4553a618c83404169834 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 23 Aug 2022 17:26:21 -0400 Subject: [PATCH 29/52] 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 21d5e26..d9c5555 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -44,8 +44,14 @@ # General information about the project. project = "Adafruit Touchscreen Library" +creation_year = "2019" current_year = str(datetime.datetime.now().year) -copyright = current_year + " ladyada" +year_duration = ( + current_year + if current_year == creation_year + else creation_year + " - " + current_year +) +copyright = year_duration + " ladyada" author = "ladyada" # The version info for the project you're documenting, acts as replacement for From cb08d4fbad1113c88254c2195795b0874f3064d3 Mon Sep 17 00:00:00 2001 From: Thomas Franks Date: Fri, 2 Sep 2022 15:03:48 -0400 Subject: [PATCH 30/52] Add Missing Type Annotations --- adafruit_touchscreen.py | 31 +++++++++++++++++++------------ 1 file changed, 19 insertions(+), 12 deletions(-) diff --git a/adafruit_touchscreen.py b/adafruit_touchscreen.py index b1aa0fd..fb79799 100644 --- a/adafruit_touchscreen.py +++ b/adafruit_touchscreen.py @@ -27,8 +27,13 @@ from digitalio import DigitalInOut from analogio import AnalogIn +try: + from typing import Optional, Tuple, Union +except ImportError: + pass -def map_range(x, in_min, in_max, out_min, out_max): + +def map_range(x, in_min, in_max, out_min, out_max) -> float: """ Maps a number from one range to another. @@ -89,17 +94,17 @@ class Touchscreen: def __init__( self, - x1_pin, - x2_pin, - y1_pin, - y2_pin, + x1_pin: DigitalInOut, + x2_pin: DigitalInOut, + y1_pin: DigitalInOut, + y2_pin: DigitalInOut, *, - x_resistance=None, - samples=4, - z_threshold=10000, - calibration=None, - size=None - ): + x_resistance: Optional[int] = None, + samples: int = 4, + z_threshold: int = 10000, + calibration: Optional[Tuple[Tuple[int, int], Tuple[int, int]]] = None, + size: Optional[Tuple[int, int]] = None + ) -> None: self._xm_pin = x1_pin self._xp_pin = x2_pin @@ -115,7 +120,9 @@ def __init__( self._zthresh = z_threshold @property - def touch_point(self): # pylint: disable=too-many-locals + def touch_point( + self, + ) -> Union[None, Tuple[float, float, int]]: # pylint: disable=too-many-locals """A tuple that represents the x, y and z (touch pressure) coordinates of a touch. Or, None if no touch is detected""" z_1 = z_2 = z = None From 35a9e1b83fd08aeac847636d92ca42de5bb2cecb Mon Sep 17 00:00:00 2001 From: Thomas Franks Date: Fri, 2 Sep 2022 15:09:46 -0400 Subject: [PATCH 31/52] Add Missing Type Annotations --- adafruit_touchscreen.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_touchscreen.py b/adafruit_touchscreen.py index fb79799..8b61132 100644 --- a/adafruit_touchscreen.py +++ b/adafruit_touchscreen.py @@ -122,7 +122,7 @@ def __init__( @property def touch_point( self, - ) -> Union[None, Tuple[float, float, int]]: # pylint: disable=too-many-locals + ) -> Union[None, Tuple[int, int, int]]: # pylint: disable=too-many-locals """A tuple that represents the x, y and z (touch pressure) coordinates of a touch. Or, None if no touch is detected""" z_1 = z_2 = z = None From a511cec806411c80b5a3280b512a09a5d74eac0e Mon Sep 17 00:00:00 2001 From: Thomas Franks Date: Fri, 2 Sep 2022 16:07:12 -0400 Subject: [PATCH 32/52] Add Missing Type Annotations --- adafruit_touchscreen.py | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/adafruit_touchscreen.py b/adafruit_touchscreen.py index 8b61132..5bf0fe0 100644 --- a/adafruit_touchscreen.py +++ b/adafruit_touchscreen.py @@ -28,12 +28,13 @@ from analogio import AnalogIn try: - from typing import Optional, Tuple, Union + from typing import Optional, Tuple + from microcontroller import Pin except ImportError: pass -def map_range(x, in_min, in_max, out_min, out_max) -> float: +def map_range(x: float, in_min: int, in_max: int, out_min: int, out_max: int) -> float: """ Maps a number from one range to another. @@ -94,10 +95,10 @@ class Touchscreen: def __init__( self, - x1_pin: DigitalInOut, - x2_pin: DigitalInOut, - y1_pin: DigitalInOut, - y2_pin: DigitalInOut, + x1_pin: Pin, + x2_pin: Pin, + y1_pin: Pin, + y2_pin: Pin, *, x_resistance: Optional[int] = None, samples: int = 4, @@ -122,7 +123,7 @@ def __init__( @property def touch_point( self, - ) -> Union[None, Tuple[int, int, int]]: # pylint: disable=too-many-locals + ) -> Optional[Tuple[int, int, int]]: # pylint: disable=too-many-locals """A tuple that represents the x, y and z (touch pressure) coordinates of a touch. Or, None if no touch is detected""" z_1 = z_2 = z = None From a25584d3bdaab34272ee42af85a5dfc2df6840ed 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 33/52] 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 8b8463d86ca297470c496a85ed2fd21423b2ce6b 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 34/52] 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 891f07afd548f486689c1c9012a281420bd21470 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 35/52] 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 73a72576ce0a3706a32992120935b788661bd071 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 09:12:45 -0400 Subject: [PATCH 36/52] 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 d3106b9b76b58d6b75a15058d9323aebea71a154 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 37/52] 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 79ef08371ae01e206df30de32fe2695847cee9ac 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 38/52] 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 0056da919a2223eca2f0747012650c8ff4443219 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 39/52] 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 3926459fee90cc4882c1635adcf092d643f657b3 Mon Sep 17 00:00:00 2001 From: Tim Newsome Date: Thu, 9 Feb 2023 20:19:33 -0800 Subject: [PATCH 40/52] Optionally don't invert pressure readings. This is required e.g. on ILI9341. Default to the old behavior to not break any existing projects. --- adafruit_touchscreen.py | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/adafruit_touchscreen.py b/adafruit_touchscreen.py index 5bf0fe0..f9a3889 100644 --- a/adafruit_touchscreen.py +++ b/adafruit_touchscreen.py @@ -104,7 +104,8 @@ def __init__( samples: int = 4, z_threshold: int = 10000, calibration: Optional[Tuple[Tuple[int, int], Tuple[int, int]]] = None, - size: Optional[Tuple[int, int]] = None + size: Optional[Tuple[int, int]] = None, + invert_pressure: bool = True ) -> None: self._xm_pin = x1_pin @@ -119,6 +120,7 @@ def __init__( self._calib = calibration self._size = size self._zthresh = z_threshold + self.invert_pressure = invert_pressure @property def touch_point( @@ -136,7 +138,10 @@ def touch_point( with AnalogIn(self._yp_pin) as y_p: z_2 = y_p.value # print(z_1, z_2) - z = 65535 - (z_2 - z_1) + if self.invert_pressure: + z = 65535 - (z_2 - z_1) + else: + z = z_2 + z_1 if z > self._zthresh: with DigitalInOut(self._yp_pin) as y_p: with DigitalInOut(self._ym_pin) as y_m: From 9b86103c0c157d0a6538df3cb42833f68bd6c343 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 27 Feb 2023 15:51:08 -0600 Subject: [PATCH 41/52] add docstring for inverted pressure --- adafruit_touchscreen.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/adafruit_touchscreen.py b/adafruit_touchscreen.py index f9a3889..8ec3a4e 100644 --- a/adafruit_touchscreen.py +++ b/adafruit_touchscreen.py @@ -90,6 +90,8 @@ class Touchscreen: readings for the X and Y coordinate planes, respectively. Defaults to :const:`((0, 65535), (0, 65535))` :param int,int size: The dimensions of the screen as (x, y). + :param bool invert_pressure: Whether to invert the pressure values. Some touchscreens and + drivers may need this to be changed to `False` in order to properly register touches. """ From 74fedf4ed2e1926287629d891a389be67a55472e Mon Sep 17 00:00:00 2001 From: Cedar Grove Maker Studios Date: Sat, 29 Apr 2023 10:51:44 -0700 Subject: [PATCH 42/52] Limit x and y values to pixel address maximum Limit x and y values to the maximum pixel address rather than screen size. Prevents the touchscreen from generating a pixel address greater than the displayable area. --- adafruit_touchscreen.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_touchscreen.py b/adafruit_touchscreen.py index 8ec3a4e..5b2ccca 100644 --- a/adafruit_touchscreen.py +++ b/adafruit_touchscreen.py @@ -158,7 +158,7 @@ def touch_point( x_size = 65535 if self._size: x_size = self._size[0] - x = int(map_range(x, self._calib[0][0], self._calib[0][1], 0, x_size)) + x = int(map_range(x, self._calib[0][0], self._calib[0][1], 0, x_size - 1)) with DigitalInOut(self._xp_pin) as x_p: with DigitalInOut(self._xm_pin) as x_m: @@ -173,7 +173,7 @@ def touch_point( y_size = 65535 if self._size: y_size = self._size[1] - y = int(map_range(y, self._calib[1][0], self._calib[1][1], 0, y_size)) + y = int(map_range(y, self._calib[1][0], self._calib[1][1], 0, y_size - 1)) return (x, y, z) return None From b71029a6043b8f9509ada015107a1bbc5752b582 Mon Sep 17 00:00:00 2001 From: Tekktrik Date: Tue, 9 May 2023 20:26:25 -0400 Subject: [PATCH 43/52] 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 b8b821681f1b741212506b2c8b3cac59fe5af04f Mon Sep 17 00:00:00 2001 From: Tekktrik Date: Wed, 10 May 2023 22:46:38 -0400 Subject: [PATCH 44/52] Run pre-commit --- adafruit_touchscreen.py | 2 -- examples/touchscreen_calibrator_built_in.py | 1 + 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/adafruit_touchscreen.py b/adafruit_touchscreen.py index 5b2ccca..8efcb22 100644 --- a/adafruit_touchscreen.py +++ b/adafruit_touchscreen.py @@ -35,7 +35,6 @@ def map_range(x: float, in_min: int, in_max: int, out_min: int, out_max: int) -> float: - """ Maps a number from one range to another. @@ -109,7 +108,6 @@ def __init__( size: Optional[Tuple[int, int]] = None, invert_pressure: bool = True ) -> None: - self._xm_pin = x1_pin self._xp_pin = x2_pin self._ym_pin = y1_pin diff --git a/examples/touchscreen_calibrator_built_in.py b/examples/touchscreen_calibrator_built_in.py index cfa9591..5977edb 100755 --- a/examples/touchscreen_calibrator_built_in.py +++ b/examples/touchscreen_calibrator_built_in.py @@ -38,6 +38,7 @@ DISPLAY_ROTATION = 0 # Specify 0, 90, 180, or 270 degrees REPL_ONLY = False # True to disable graphics + # pylint: disable=too-few-public-methods class Colors: """A collection of colors used for graphic objects.""" From baaef855b2f4cb4e7f7d961c65b09c0000413fd8 Mon Sep 17 00:00:00 2001 From: Tekktrik Date: Sun, 14 May 2023 13:00:32 -0400 Subject: [PATCH 45/52] Update .pylintrc, fix jQuery for docs Signed-off-by: Tekktrik --- .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 d9c5555..7a8975c 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 ebf0f1395ba793c8ac899275fe4ce3d4bd1b7d80 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 18 Sep 2023 16:18:38 -0500 Subject: [PATCH 46/52] "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 7a8975c..1ca7a44 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 2aa03a6f13c1bbb2a288baccf821a2cc8bdc0fe5 Mon Sep 17 00:00:00 2001 From: Paul Cutler Date: Fri, 3 Nov 2023 09:39:50 -0500 Subject: [PATCH 47/52] Update to use root_group for CP 9 compatibility --- examples/touchscreen_calibrator_built_in.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/touchscreen_calibrator_built_in.py b/examples/touchscreen_calibrator_built_in.py index 5977edb..02622e3 100755 --- a/examples/touchscreen_calibrator_built_in.py +++ b/examples/touchscreen_calibrator_built_in.py @@ -63,7 +63,7 @@ class Colors: # Activate the display graphics unless REPL_ONLY=True if not REPL_ONLY: display_group = displayio.Group() - display.show(display_group) + display.root_group = display_group # Instantiate touch screen without calibration or display size parameters if display.rotation == 0: From 05fbe52bbcce82d8f30029ca4944b8772d86e886 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 16 Oct 2023 14:30:31 -0500 Subject: [PATCH 48/52] 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 9d51cd55b5dbb0b3b352c9ef46ac4dee707aa279 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 7 Oct 2024 09:24:05 -0500 Subject: [PATCH 49/52] 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 1ca7a44..d30a320 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 af5f161dc273f8ed64f6d4fdaf6f182e4260ebf9 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 14 Jan 2025 11:32:34 -0600 Subject: [PATCH 50/52] 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 d74b7b875fffea8bef909ab937c9a93270497fa0 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Thu, 15 May 2025 17:33:40 +0000 Subject: [PATCH 51/52] change to ruff --- .gitattributes | 11 + .pre-commit-config.yaml | 43 +-- .pylintrc | 399 -------------------- README.rst | 6 +- adafruit_touchscreen.py | 15 +- docs/api.rst | 3 + docs/conf.py | 8 +- examples/touchscreen_calibrator_built_in.py | 9 +- examples/touchscreen_orientation.py | 1 + examples/touchscreen_simpletest.py | 1 + ruff.toml | 106 ++++++ 11 files changed, 148 insertions(+), 454 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 b609166..6a92738 100644 --- a/README.rst +++ b/README.rst @@ -13,9 +13,9 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_Touchscreen/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 CircuitPython library for 4-wire resistive touchscreens diff --git a/adafruit_touchscreen.py b/adafruit_touchscreen.py index 8efcb22..8ee7772 100644 --- a/adafruit_touchscreen.py +++ b/adafruit_touchscreen.py @@ -24,11 +24,12 @@ __version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Touchscreen.git" -from digitalio import DigitalInOut from analogio import AnalogIn +from digitalio import DigitalInOut try: from typing import Optional, Tuple + from microcontroller import Pin except ImportError: pass @@ -106,7 +107,7 @@ def __init__( z_threshold: int = 10000, calibration: Optional[Tuple[Tuple[int, int], Tuple[int, int]]] = None, size: Optional[Tuple[int, int]] = None, - invert_pressure: bool = True + invert_pressure: bool = True, ) -> None: self._xm_pin = x1_pin self._xp_pin = x2_pin @@ -125,7 +126,7 @@ def __init__( @property def touch_point( self, - ) -> Optional[Tuple[int, int, int]]: # pylint: disable=too-many-locals + ) -> Optional[Tuple[int, int, int]]: """A tuple that represents the x, y and z (touch pressure) coordinates of a touch. Or, None if no touch is detected""" z_1 = z_2 = z = None @@ -148,9 +149,7 @@ def touch_point( with AnalogIn(self._xp_pin) as x_p: y_p.switch_to_output(True) y_m.switch_to_output(False) - for i in range( # pylint: disable=consider-using-enumerate - len(self._xsamples) - ): + for i in range(len(self._xsamples)): self._xsamples[i] = x_p.value x = sum(self._xsamples) / len(self._xsamples) x_size = 65535 @@ -163,9 +162,7 @@ def touch_point( with AnalogIn(self._yp_pin) as y_p: x_p.switch_to_output(True) x_m.switch_to_output(False) - for i in range( # pylint: disable=consider-using-enumerate - len(self._ysamples) - ): + for i in range(len(self._ysamples)): self._ysamples[i] = y_p.value y = sum(self._ysamples) / len(self._ysamples) y_size = 65535 diff --git a/docs/api.rst b/docs/api.rst index 7bb4f8b..f211230 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_touchscreen :members: diff --git a/docs/conf.py b/docs/conf.py index d30a320..4a4879d 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("..")) @@ -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 + " ladyada" author = "ladyada" diff --git a/examples/touchscreen_calibrator_built_in.py b/examples/touchscreen_calibrator_built_in.py index 02622e3..20482f2 100755 --- a/examples/touchscreen_calibrator_built_in.py +++ b/examples/touchscreen_calibrator_built_in.py @@ -25,21 +25,21 @@ """ import time + import board import displayio -import vectorio import terminalio +import vectorio from adafruit_display_text.label import Label from simpleio import map_range -import adafruit_touchscreen +import adafruit_touchscreen # Operational parameters: DISPLAY_ROTATION = 0 # Specify 0, 90, 180, or 270 degrees REPL_ONLY = False # True to disable graphics -# pylint: disable=too-few-public-methods class Colors: """A collection of colors used for graphic objects.""" @@ -53,7 +53,7 @@ class Colors: # Check rotation value and update display. # Always set rotation before instantiating the touchscreen. -if DISPLAY_ROTATION is not None and DISPLAY_ROTATION in (0, 90, 180, 270): +if DISPLAY_ROTATION is not None and DISPLAY_ROTATION in {0, 90, 180, 270}: display.rotation = DISPLAY_ROTATION else: print("Warning: invalid rotation value -- defaulting to zero") @@ -170,7 +170,6 @@ class Colors: display_group.append(coordinates) display_group.append(display_rotation) -# pylint: disable=invalid-name # Reset x and y values to raw touchscreen mid-point before measurement x_min = x_max = y_min = y_max = 65535 // 2 diff --git a/examples/touchscreen_orientation.py b/examples/touchscreen_orientation.py index cf7c670..a3e9119 100644 --- a/examples/touchscreen_orientation.py +++ b/examples/touchscreen_orientation.py @@ -2,6 +2,7 @@ # SPDX-License-Identifier: MIT import board + import adafruit_touchscreen # Allign the touchscreen so that the top left corner reads as x=0, y=0 diff --git a/examples/touchscreen_simpletest.py b/examples/touchscreen_simpletest.py index f827dd8..db2e4eb 100644 --- a/examples/touchscreen_simpletest.py +++ b/examples/touchscreen_simpletest.py @@ -2,6 +2,7 @@ # SPDX-License-Identifier: MIT import board + import adafruit_touchscreen # These pins are used as both analog and digital! XL, XR and YU must be analog diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..09747f2 --- /dev/null +++ b/ruff.toml @@ -0,0 +1,106 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +target-version = "py38" +line-length = 100 + +[lint] +preview = true +select = ["I", "PL", "UP"] + +extend-select = [ + "D419", # empty-docstring + "E501", # line-too-long + "W291", # trailing-whitespace + "PLC0414", # useless-import-alias + "PLC2401", # non-ascii-name + "PLC2801", # unnecessary-dunder-call + "PLC3002", # unnecessary-direct-lambda-call + "E999", # syntax-error + "PLE0101", # return-in-init + "F706", # return-outside-function + "F704", # yield-outside-function + "PLE0116", # continue-in-finally + "PLE0117", # nonlocal-without-binding + "PLE0241", # duplicate-bases + "PLE0302", # unexpected-special-method-signature + "PLE0604", # invalid-all-object + "PLE0605", # invalid-all-format + "PLE0643", # potential-index-error + "PLE0704", # misplaced-bare-raise + "PLE1141", # dict-iter-missing-items + "PLE1142", # await-outside-async + "PLE1205", # logging-too-many-args + "PLE1206", # logging-too-few-args + "PLE1307", # bad-string-format-type + "PLE1310", # bad-str-strip-call + "PLE1507", # invalid-envvar-value + "PLE2502", # bidirectional-unicode + "PLE2510", # invalid-character-backspace + "PLE2512", # invalid-character-sub + "PLE2513", # invalid-character-esc + "PLE2514", # invalid-character-nul + "PLE2515", # invalid-character-zero-width-space + "PLR0124", # comparison-with-itself + "PLR0202", # no-classmethod-decorator + "PLR0203", # no-staticmethod-decorator + "UP004", # useless-object-inheritance + "PLR0206", # property-with-parameters + "PLR0904", # too-many-public-methods + "PLR0911", # too-many-return-statements + "PLR0912", # too-many-branches + "PLR0913", # too-many-arguments + "PLR0914", # too-many-locals + "PLR0915", # too-many-statements + "PLR0916", # too-many-boolean-expressions + "PLR1702", # too-many-nested-blocks + "PLR1704", # redefined-argument-from-local + "PLR1711", # useless-return + "C416", # unnecessary-comprehension + "PLR1733", # unnecessary-dict-index-lookup + "PLR1736", # unnecessary-list-index-lookup + + # ruff reports this rule is unstable + #"PLR6301", # no-self-use + + "PLW0108", # unnecessary-lambda + "PLW0120", # useless-else-on-loop + "PLW0127", # self-assigning-variable + "PLW0129", # assert-on-string-literal + "B033", # duplicate-value + "PLW0131", # named-expr-without-context + "PLW0245", # super-without-brackets + "PLW0406", # import-self + "PLW0602", # global-variable-not-assigned + "PLW0603", # global-statement + "PLW0604", # global-at-module-level + + # fails on the try: import typing used by libraries + #"F401", # unused-import + + "F841", # unused-variable + "E722", # bare-except + "PLW0711", # binary-op-exception + "PLW1501", # bad-open-mode + "PLW1508", # invalid-envvar-default + "PLW1509", # subprocess-popen-preexec-fn + "PLW2101", # useless-with-lock + "PLW3301", # nested-min-max +] + +ignore = [ + "PLR2004", # magic-value-comparison + "UP030", # format literals + "PLW1514", # unspecified-encoding + "PLR0913", # too-many-arguments + "PLR0915", # too-many-statements + "PLR0917", # too-many-positional-arguments + "PLR0904", # too-many-public-methods + "PLR0912", # too-many-branches + "PLR0916", # too-many-boolean-expressions + "PLR6301", # could-be-static no-self-use +] + +[format] +line-ending = "lf" From 0ac73251c03182420135da7df038a329d786b9b7 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Wed, 4 Jun 2025 10:00:20 -0500 Subject: [PATCH 52/52] update rtd.yml file Signed-off-by: foamyguy --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 88bca9f..255dafd 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -12,7 +12,7 @@ sphinx: configuration: docs/conf.py build: - os: ubuntu-20.04 + os: ubuntu-lts-latest tools: python: "3" pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy