Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-tt21100/badge/?version=latest
:target: https://docs.circuitpython.org/projects/tt21100/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_TT21100/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_TT21100/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
Basic driver for TT21100 touchscreen drivers. The ESP32-S3 Box dev board uses it.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-tt21100/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-tt21100
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-tt21100
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-tt21100
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 adafruit_tt21100
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
import time
import busio
import board
import adafruit_tt21100
# Create library object (named "tt") using a Bus I2C port
i2c = busio.I2C(board.SCL, board.SDA)
tt = adafruit_tt21100.TT21100(i2c)
while True:
# if the screen is being touched print the touches
if tt.touched:
print(tt.touches)
time.sleep(0.15)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/tt21100/en/latest/>`_.
For information on building library documentation, please check out
`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_TT21100/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-tt21100",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, tt21100, touchscreen",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/14/7d/53578e3cf2dc72c6aa3f06ad6b3b54285e43b80ced078742e41971680757/adafruit-circuitpython-tt21100-1.0.2.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-tt21100/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/tt21100/en/latest/\n :alt: Documentation Status\n\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_TT21100/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_TT21100/actions\n :alt: Build Status\n\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nBasic driver for TT21100 touchscreen drivers. The ESP32-S3 Box dev board uses it.\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-tt21100/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-tt21100\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-tt21100\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-tt21100\n\n\n\nInstalling to a Connected CircuitPython Device with Circup\n==========================================================\n\nMake sure that you have ``circup`` installed in your Python environment.\nInstall it with the following command if necessary:\n\n.. code-block:: shell\n\n pip3 install circup\n\nWith ``circup`` installed and your CircuitPython device connected use the\nfollowing command to install:\n\n.. code-block:: shell\n\n circup install adafruit_tt21100\n\nOr the following command to update an existing version:\n\n.. code-block:: shell\n\n circup update\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import time\n import busio\n import board\n import adafruit_tt21100\n\n # Create library object (named \"tt\") using a Bus I2C port\n i2c = busio.I2C(board.SCL, board.SDA)\n\n tt = adafruit_tt21100.TT21100(i2c)\n\n while True:\n # if the screen is being touched print the touches\n if tt.touched:\n print(tt.touches)\n\n time.sleep(0.15)\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/tt21100/en/latest/>`_.\n\nFor information on building library documentation, please check out\n`this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_TT21100/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Basic driver for TT21100 touchscreen drivers",
"version": "1.0.2",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_TT21100.git"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" tt21100",
" touchscreen"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "802de98d7e52d23b95233e1d24625ef3e4f5310308e7eb83325e2bec488bd54d",
"md5": "9c47b17439124b189145b3e41660afc0",
"sha256": "65e20575bdde75ab3cfa2102499ec3a766010bb285db57104a325b337c2016ba"
},
"downloads": -1,
"filename": "adafruit_circuitpython_tt21100-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9c47b17439124b189145b3e41660afc0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5030,
"upload_time": "2024-03-21T16:31:50",
"upload_time_iso_8601": "2024-03-21T16:31:50.623023Z",
"url": "https://files.pythonhosted.org/packages/80/2d/e98d7e52d23b95233e1d24625ef3e4f5310308e7eb83325e2bec488bd54d/adafruit_circuitpython_tt21100-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "147d53578e3cf2dc72c6aa3f06ad6b3b54285e43b80ced078742e41971680757",
"md5": "acf1937a6929d257f6ea39f5e42fc9ee",
"sha256": "3c03b933b911459376d3872d5a2dad117f7fe6dbbf306370f2d3cf99338e4200"
},
"downloads": -1,
"filename": "adafruit-circuitpython-tt21100-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "acf1937a6929d257f6ea39f5e42fc9ee",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26538,
"upload_time": "2024-03-21T16:31:51",
"upload_time_iso_8601": "2024-03-21T16:31:51.797885Z",
"url": "https://files.pythonhosted.org/packages/14/7d/53578e3cf2dc72c6aa3f06ad6b3b54285e43b80ced078742e41971680757/adafruit-circuitpython-tt21100-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-21 16:31:51",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_TT21100",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-busdevice",
"specs": []
}
],
"lcname": "adafruit-circuitpython-tt21100"
}
JSON
