rgrizzell / circuitpython_gt911

CircuitPython driver for GT911-based touchscreens.

Introduction

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:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install gt911

Or the following command to update an existing version:

circup update

Usage Example

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.