Introduction

Documentation Status Discord Build Status

CircuitPython library for 4-wire resistive touchscreens

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-touchscreen

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-touchscreen

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install adafruit-circuitpython-touchscreen

Usage Example

import board
import adafruit_touchscreen

# These pins are used as both analog and digital!
# XR, XL and YU must be analog and digital capable.
# YD just needs to be digital.
ts = adafruit_touchscreen.Touchscreen(board.TOUCH_XL, board.TOUCH_XR,
                                      board.TOUCH_YD, board.TOUCH_YU)

while True:
    p = ts.touch_point
    if p:
        print(p)

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.

Indices and tables