https://github.com/rgrizzell/circuitpython_gt911
CircuitPython driver for GT911-based touchscreens.
https://github.com/rgrizzell/circuitpython_gt911
Last synced: 5 months ago
JSON representation
CircuitPython driver for GT911-based touchscreens.
- Host: GitHub
- URL: https://github.com/rgrizzell/circuitpython_gt911
- Owner: rgrizzell
- License: mit
- Created: 2023-11-19T16:13:57.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-29T00:09:03.000Z (over 1 year ago)
- Last Synced: 2024-12-01T02:38:24.857Z (about 1 year ago)
- Language: Python
- Homepage:
- Size: 63.5 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
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 `_
* `Bus Device `_
* `Register `_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Community Bundle 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 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 `_.
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.