Metadata-Version: 2.4
Name: circuitpython-at42qt2120
Version: 1.0.0a3
Summary: A CircuitPython module for the AT42QT2120 capacitive touch sensor IC, (mostly) compatible with Adafruit's MPR121 library.
Author-email: Mike Coats <i.am@mikecoats.com>
License: MIT
Project-URL: Homepage, https://github.com/MikeCoats/CircuitPython_AT42QT2120
Keywords: adafruit,blinka,circuitpython,micropython,capacitive,touch,at42qt2120
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Embedded Systems
Classifier: Topic :: System :: Hardware
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Adafruit-Blinka
Requires-Dist: adafruit-circuitpython-busdevice
Provides-Extra: optional
Requires-Dist: pytest; extra == "optional"
Requires-Dist: mkdocs; extra == "optional"
Requires-Dist: mkdocstrings[python]; extra == "optional"
Dynamic: license-file

# CircuitPython-AT42QT2120

[![Documentation Status](https://readthedocs.org/projects/adafruit-circuitpython-mpr121/badge/?version=latest)][readthedocs]
[![Build Status](https://github.com/MikeCoats/CircuitPython_AT42QT2120/workflows/Build%20CI/badge.svg)][github-action]
[![Code Style: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)][ruff]

A CircuitPython module for the AT42QT2120 capacitive touch sensor IC, (mostly) compatible with Adafruit's MPR121 library.

This library's interface is designed after Adafruit's MPR121 module.
The ICs diverge in functionality, so we only include functions available on both chips.
To determine which functionality is required, I surveyed several consumers of the MPR121 library.
This includes three examples from Adafruit, and many of the projects "dependent" on their library on GitHub.

A full list of all the projects I surveyed and their usage of the MPR121 library can be found in [the Compatibility Audit][audit].
This audit should let us cover enough of the design to use an AT42QT2120 as a drop-in replacement for most users of the MPR121.

## Documentation

API documentation for this library can be found on [Read the Docs][readthedocs].

## Contributing

Contributions are welcome! Please read our [Code of Conduct][conduct]
before contributing to help this project stay welcoming.

[readthedocs]: https://at42qt2120.readthedocs.io/en/latest/
[github-action]: https://github.com/MikeCoats/CircuitPython_AT42QT2120/actions
[ruff]: https://github.com/astral-sh/ruff
[audit]: mkdocs/compatibility.md
[readthedocs]: https://at42qt2120.readthedocs.io/
[conduct]: ./CODE_OF_CONDUCT.md
