Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-focaltouch/badge/?version=latest
:target: https://docs.circuitpython.org/projects/focaltouch/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_FocalTouch/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_FocalTouch/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
CircuitPython driver for common low-cost FocalTech capacitive touch chips.
Currently supports FT6206 & FT6236
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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
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-focaltouch/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-focaltouch
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-focaltouch
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-focaltouch
Usage Example
=============
.. code-block:: python
import time
import board
import busio
import adafruit_focaltouch
# Create library object (named "ft") using a Bus I2C port
i2c = busio.I2C(board.SCL, board.SDA)
ft = adafruit_focaltouch.Adafruit_FocalTouch(i2c, debug=False)
while True:
# if the screen is being touched print the touches
if ft.touched:
print(ft.touches)
else:
print('no touch')
time.sleep(.15)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/focaltouch/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_FocalTouch/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-focaltouch",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,focaltouch,capacitive,touch,screen,display,touchscreenhardware,micropython,circuitpython",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/96/d0/4acbdc0682b958a18863da83d2ed857698b5a75eb975d8ef457916f3eedb/adafruit-circuitpython-focaltouch-1.5.2.tar.gz",
"platform": null,
"description": "\nIntroduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-focaltouch/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/focaltouch/en/latest/\n :alt: Documentation Status\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.. image:: https://github.com/adafruit/Adafruit_CircuitPython_FocalTouch/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_FocalTouch/actions/\n :alt: Build Status\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\nCircuitPython driver for common low-cost FocalTech capacitive touch chips.\nCurrently supports FT6206 & FT6236\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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\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-focaltouch/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-focaltouch\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-focaltouch\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-focaltouch\n\nUsage Example\n=============\n\n.. code-block:: python\n\n\timport time\n\timport board\n\timport busio\n\timport adafruit_focaltouch\n\n\t# Create library object (named \"ft\") using a Bus I2C port\n\ti2c = busio.I2C(board.SCL, board.SDA)\n\n\tft = adafruit_focaltouch.Adafruit_FocalTouch(i2c, debug=False)\n\n\twhile True:\n\t # if the screen is being touched print the touches\n\t if ft.touched:\n\t\tprint(ft.touches)\n\t else:\n\t\tprint('no touch')\n\n\t time.sleep(.15)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/focaltouch/en/latest/>`_.\n\nFor 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>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_FocalTouch/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython Focaltouch library for capacitive touch displays.",
"version": "1.5.2",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_Focaltouch"
},
"split_keywords": [
"adafruit",
"focaltouch",
"capacitive",
"touch",
"screen",
"display",
"touchscreenhardware",
"micropython",
"circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4f00b1f1bddec62009ea66539df5cd278d8c0c7517c05427131cb3eff322dc31",
"md5": "6c9163cc071e571aeb9699ad6c2074a6",
"sha256": "28289e2d6a5de31751c0a76cd9dbc733114046d2b9cd2e7ed1f4d3677b423f6b"
},
"downloads": -1,
"filename": "adafruit_circuitpython_focaltouch-1.5.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6c9163cc071e571aeb9699ad6c2074a6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5790,
"upload_time": "2024-02-05T19:51:50",
"upload_time_iso_8601": "2024-02-05T19:51:50.279922Z",
"url": "https://files.pythonhosted.org/packages/4f/00/b1f1bddec62009ea66539df5cd278d8c0c7517c05427131cb3eff322dc31/adafruit_circuitpython_focaltouch-1.5.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "96d04acbdc0682b958a18863da83d2ed857698b5a75eb975d8ef457916f3eedb",
"md5": "faf4f59b7d74ca9b2e45614556f89e8e",
"sha256": "75da184af0b0e923658b7364802cf38c99f963a747ef47c43133c35c59325484"
},
"downloads": -1,
"filename": "adafruit-circuitpython-focaltouch-1.5.2.tar.gz",
"has_sig": false,
"md5_digest": "faf4f59b7d74ca9b2e45614556f89e8e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 28618,
"upload_time": "2024-02-05T19:51:52",
"upload_time_iso_8601": "2024-02-05T19:51:52.058415Z",
"url": "https://files.pythonhosted.org/packages/96/d0/4acbdc0682b958a18863da83d2ed857698b5a75eb975d8ef457916f3eedb/adafruit-circuitpython-focaltouch-1.5.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-05 19:51:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_Focaltouch",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-busdevice",
"specs": []
}
],
"lcname": "adafruit-circuitpython-focaltouch"
}
JSON
