adafruit-circuitpython-touchscreen


Nameadafruit-circuitpython-touchscreen JSON
Version 1.3.1 PyPI version JSON
download
home_page
SummaryCircuitPython library for 4-wire resistive touchscreens
upload_time2023-12-09 17:35:56
maintainer
docs_urlNone
author
requires_python
licenseMIT
keywords adafruit blinka circuitpython micropython touchscreen resistive
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-touchscreen/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/touchscreen/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_Touchscreen/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_Touchscreen/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 library for 4-wire resistive touchscreens


Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_

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-touchscreen/>`_. To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-touchscreen

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-touchscreen

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-touchscreen

Usage Example
=============

.. code-block:: python3

    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)


Documentation
=============

API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/touchscreen/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_Touchscreen/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "adafruit-circuitpython-touchscreen",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "adafruit,blinka,circuitpython,micropython,touchscreen,resistive",
    "author": "",
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/2f/b2/3752361fcacd7d6751e7ddbf1a23f473fe0f14884aee9282d62265d87e85/adafruit-circuitpython-touchscreen-1.3.1.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-touchscreen/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/touchscreen/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_Touchscreen/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_Touchscreen/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 library for 4-wire resistive touchscreens\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\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--------------------\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-touchscreen/>`_. To install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-touchscreen\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-touchscreen\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-touchscreen\n\nUsage Example\n=============\n\n.. code-block:: python3\n\n    import board\n    import adafruit_touchscreen\n\n    # These pins are used as both analog and digital!\n    # XR, XL and YU must be analog and digital capable.\n    # YD just needs to be digital.\n    ts = adafruit_touchscreen.Touchscreen(board.TOUCH_XL, board.TOUCH_XR,\n                          board.TOUCH_YD, board.TOUCH_YU)\n\n    while True:\n        p = ts.touch_point\n        if p:\n        print(p)\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/touchscreen/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_Touchscreen/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "CircuitPython library for 4-wire resistive touchscreens",
    "version": "1.3.1",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_Touchscreen"
    },
    "split_keywords": [
        "adafruit",
        "blinka",
        "circuitpython",
        "micropython",
        "touchscreen",
        "resistive"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "16a2a39ce4519121aa443205a67e1846b92c9c36d8b2ae7f5629a701ecd7feb4",
                "md5": "421e976406fad6106fd658560d8808b4",
                "sha256": "813afb13f56b2a0d5265583b26a53c601d2bcc4ea42b2c9fd1fe94e3bf3beda3"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_touchscreen-1.3.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "421e976406fad6106fd658560d8808b4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 5847,
            "upload_time": "2023-12-09T17:35:51",
            "upload_time_iso_8601": "2023-12-09T17:35:51.953087Z",
            "url": "https://files.pythonhosted.org/packages/16/a2/a39ce4519121aa443205a67e1846b92c9c36d8b2ae7f5629a701ecd7feb4/adafruit_circuitpython_touchscreen-1.3.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "2fb23752361fcacd7d6751e7ddbf1a23f473fe0f14884aee9282d62265d87e85",
                "md5": "6d341d369e55bd41e5f66b823625c3ee",
                "sha256": "7450993dc574f21abdd8c0afb8114b51f14b09abf576178507d008311d81155c"
            },
            "downloads": -1,
            "filename": "adafruit-circuitpython-touchscreen-1.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "6d341d369e55bd41e5f66b823625c3ee",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 28881,
            "upload_time": "2023-12-09T17:35:56",
            "upload_time_iso_8601": "2023-12-09T17:35:56.155274Z",
            "url": "https://files.pythonhosted.org/packages/2f/b2/3752361fcacd7d6751e7ddbf1a23f473fe0f14884aee9282d62265d87e85/adafruit-circuitpython-touchscreen-1.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-09 17:35:56",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_Touchscreen",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "adafruit-circuitpython-touchscreen"
}
        
Elapsed time: 0.35499s