Introduction

CircuitPython Driver for the AD Semiconductor / TouchSemi TS20, a 20-channel capacitive touch sensor with automatic sensitivity calibration, controlled over I2C.

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 or individual libraries can be installed using circup.

Hardware

This library is for the AD Semiconductor / TouchSemi TS20 20-channel capacitive touch sensor

For an example board, see https://github.com/todbot/TS20_Test_Board/

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 ts20

Or the following command to update an existing version:

circup update

Installing from PyPI

Note

This library is not available on PyPI yet. Install documentation is included as a standard element. Stay tuned for PyPI availability!

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

pip3 install circuitpython-ts20

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

sudo pip3 install circuitpython-ts20

To install in a virtual environment in your current project:

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

Usage Example

Print out which of the 20 touch pads are being touched:

import time
import board
import ts20

i2c = board.I2C()  # uses board.SCL and board.SDA

# sensitivity is 0 (most sensitive) to 15 (least sensitive)
touch = ts20.TS20(i2c, sensitivity=5)

while True:
    for pad, is_touched in enumerate(touch.touched_pads):
        if is_touched:
            print("pad", pad, "touched!")
    time.sleep(0.25)

Pads are numbered 0-19 (the datasheet calls them channels CS1-CS20). Sensitivity is really a touch threshold, so a lower number means the pad triggers more easily. It can be changed at any time, for every pad at once or for a single pad:

touch.sensitivity = 3       # every pad
touch[0].sensitivity = 10   # just pad 0, less sensitive
print(touch.sensitivity)    # list of all 20 settings

See the examples folder for complete examples.

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.

Table of Contents

Examples

Simple test

API Reference

API Reference