Introduction
============
.. image:: https://readthedocs.org/projects/circuitpython-gt911/badge/?version=latest
:target: https://circuitpython-gt911.readthedocs.io/
:alt: Documentation Status
.. image:: https://img.shields.io/discord/327254708534116352.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/rgrizzell/CircuitPython_GT911/workflows/Build%20CI/badge.svg
:target: https://github.com/rgrizzell/CircuitPython_GT911/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 Goodix GT911-based touch screens
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Community Bundle library and driver bundle <https://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
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 gt911
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
import board
import gt911
i2c = board.I2C()
gt = gt911.GT911(i2c)
print(gt.touches)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://circuitpython-gt911.readthedocs.io/>`_.
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/rgrizzell/CircuitPython_GT911/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "circuitpython-gt911",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, goodix, gt911, touch, touchscreen",
"author": null,
"author_email": "Robert Grizzell <robert@grizzell.me>",
"download_url": "https://files.pythonhosted.org/packages/4d/ef/15e901e74d512692961b846fa9b77f32181cb498776b0ee288152ab93846/circuitpython_gt911-0.2.1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/circuitpython-gt911/badge/?version=latest\n :target: https://circuitpython-gt911.readthedocs.io/\n :alt: Documentation Status\n\n\n.. image:: https://img.shields.io/discord/327254708534116352.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n\n.. image:: https://github.com/rgrizzell/CircuitPython_GT911/workflows/Build%20CI/badge.svg\n :target: https://github.com/rgrizzell/CircuitPython_GT911/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\nCircuitPython Driver for Goodix GT911-based touch screens\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* `Register <https://github.com/adafruit/Adafruit_CircuitPython_Register>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Community Bundle library and driver bundle <https://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\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 gt911\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 board\n import gt911\n\n i2c = board.I2C()\n gt = gt911.GT911(i2c)\n\n print(gt.touches)\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://circuitpython-gt911.readthedocs.io/>`_.\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/rgrizzell/CircuitPython_GT911/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython Driver for Goodix GT911-based touch screens",
"version": "0.2.1",
"project_urls": {
"Homepage": "https://github.com/rgrizzell/CircuitPython_GT911"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" goodix",
" gt911",
" touch",
" touchscreen"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4fce68875362bd28432aed770466e1f2ca332ce0d36a5afa16d3f364857a97a8",
"md5": "bccc88285f5e2d1165b54422543bdb35",
"sha256": "9c28e12a29fab39e82425c7b342b73163b0e4ab8eac6325adda17b303b26a199"
},
"downloads": -1,
"filename": "circuitpython_gt911-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bccc88285f5e2d1165b54422543bdb35",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5332,
"upload_time": "2024-05-29T00:09:37",
"upload_time_iso_8601": "2024-05-29T00:09:37.750914Z",
"url": "https://files.pythonhosted.org/packages/4f/ce/68875362bd28432aed770466e1f2ca332ce0d36a5afa16d3f364857a97a8/circuitpython_gt911-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4def15e901e74d512692961b846fa9b77f32181cb498776b0ee288152ab93846",
"md5": "ac47e5a236204c211710f71f0e651fbd",
"sha256": "cb47c6df0fb6cced93f8f8c96457ff97567cc0632f6e2bd6c1c3b7050d2b3725"
},
"downloads": -1,
"filename": "circuitpython_gt911-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "ac47e5a236204c211710f71f0e651fbd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 29731,
"upload_time": "2024-05-29T00:09:39",
"upload_time_iso_8601": "2024-05-29T00:09:39.503331Z",
"url": "https://files.pythonhosted.org/packages/4d/ef/15e901e74d512692961b846fa9b77f32181cb498776b0ee288152ab93846/circuitpython_gt911-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-29 00:09:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rgrizzell",
"github_project": "CircuitPython_GT911",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-busdevice",
"specs": []
},
{
"name": "adafruit-circuitpython-register",
"specs": []
}
],
"lcname": "circuitpython-gt911"
}
JSON
