https://github.com/cedargrovestudios/circuitpython_touchcalibrator

A simple CircuitPython resistive touchscreen calibrator for Adafruit built-in and TFT FeatherWing displays.
https://github.com/cedargrovestudios/circuitpython_touchcalibrator

circuitpython circuitpython-community-bundle featherwing tft-display touchscreen

Last synced: about 2 months ago
JSON representation

A simple CircuitPython resistive touchscreen calibrator for Adafruit built-in and TFT FeatherWing displays.

• Host: GitHub
• URL: https://github.com/cedargrovestudios/circuitpython_touchcalibrator
• Owner: CedarGroveStudios
• License: mit
• Created: 2022-10-26T18:04:46.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-11-02T02:55:55.000Z (about 1 year ago)
• Last Synced: 2023-11-02T03:30:24.158Z (about 1 year ago)
• Topics: circuitpython, circuitpython-community-bundle, featherwing, tft-display, touchscreen
• Language: Python
• Homepage:
• Size: 3.54 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Introduction

============

.. image:: https://img.shields.io/discord/327254708534116352.svg

    :target: https://adafru.it/discord

    :alt: Discord

.. image:: https://github.com/CedarGroveStudios/CircuitPython_TouchCalibrator/workflows/Build%20CI/badge.svg

    :target: https://github.com/CedarGroveStudios/CircuitPython_TouchCalibrator/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

A simple CircuitPython resistive touchscreen calibrator for Adafruit

built-in and TFT FeatherWing displays.

On-screen touchscreen calibrator for built-in and TFT FeatherWing displays. To

use, run as a standalone module, include the following line in the calling

module, or type into the REPL:

.. code-block:: python

       import touchcalibrator.built_in

for built-in displays or

.. code-block:: python

       import touchcalibrator.featherwing

for TFT FeatherWing displays.

Operational parameters such as screen rotation and REPL-only measurement display

can be set in the ``operational parameters`` portion of the module.

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 (when ``REPL_ONLY=False``). Minimum and maximum calibration

values will display on the screen and in the REPL. The REPL values can be copied

and pasted into the calling code's touchscreen instantiation statement.

Touchscreen Instantiation example code for built-in displays.

The order of the calibration tuples is determined by the display rotation value:

.. image:: https://github.com/CedarGroveStudios/CircuitPython_TouchCalibrator/blob/main/media/Touch_Calib_example.png

    :alt: Touchscreen Instantiation Example Code

.. image:: https://github.com/CedarGroveStudios/CircuitPython_TouchCalibrator/blob/main/media/touch_calibrator_screen.jpg

    :alt: Screen Image Example

Dependencies

=============

This driver depends on:

* `Adafruit CircuitPython `_

Please ensure all dependencies are available on the CircuitPython filesystem.

This is easily achieved by downloading

`the Adafruit library and driver bundle `_

or individual libraries can be installed using

`circup `_.

Installing to a Connected CircuitPython Device with Circup

==========================================================

Make sure that you have ``circup`` installed in your Python environment.

Install it with the following command if necessary:

.. code-block:: shell

    pip3 install circup

With ``circup`` installed and your CircuitPython device connected use the

following command to install:

.. code-block:: shell

    circup install cedargrove_touchcalibrator

Or the following command to update an existing version:

.. code-block:: shell

    circup update

Documentation

=============

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.