Introduction

.. image:: https://readthedocs.org/projects/circuitpython-gt911/badge/?version=latest :target: https://circuitpython-gt911.readthedocs.io/ :alt: Documentation Status

.. image:: https://img.shields.io/discord/327254708534116352.svg :target: https://adafru.it/discord :alt: Discord

.. image:: https://github.com/rgrizzell/CircuitPython_GT911/workflows/Build%20CI/badge.svg :target: https://github.com/rgrizzell/CircuitPython_GT911/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 Driver for Goodix GT911-based touch screens

Dependencies

This driver depends on:

• Adafruit CircuitPython <https://github.com/adafruit/circuitpython>_
• Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>_
• Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>_

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Community Bundle library and driver bundle <https://circuitpython.org/libraries> or individual libraries can be installed using circup <https://github.com/adafruit/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 gt911

Or the following command to update an existing version:

.. code-block:: shell

circup update

Usage Example

.. code-block:: python

import board
import gt911

i2c = board.I2C()
gt = gt911.GT911(i2c)

print(gt.touches)

Documentation

API documentation for this library can be found on Read the Docs <https://circuitpython-gt911.readthedocs.io/>_.

For information on building library documentation, please check out this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>_.

Contributing

Contributions are welcome! Please read our Code of Conduct <https://github.com/rgrizzell/CircuitPython_GT911/blob/HEAD/CODE_OF_CONDUCT.md>_ before contributing to help this project stay welcoming.