adafruit-circuitpython-esp32s2tft


Nameadafruit-circuitpython-esp32s2tft JSON
Version 1.2.1 PyPI version JSON
download
home_page
SummaryHelper library for the Adafruit ESP32-S2 TFT Feather
upload_time2023-12-09 17:44:42
maintainer
docs_urlNone
author
requires_python
licenseMIT
keywords adafruit esp32 esp32s2 tft espressif feather hardwaremicropython circuitpython
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-esp32s2tft/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/esp32s2tft/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_ESP32S2TFT/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_ESP32S2TFT/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

Helper library for the Adafruit ESP32-S2 TFT Feather.


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://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.

Adafruit ESP32-S2 TFT Feather

`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5300>`_


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_esp32s2tft

Or the following command to update an existing version:

.. code-block:: shell

    circup update

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

.. code:: python

    import random
    from rainbowio import colorwheel
    from adafruit_esp32s2tft import ESP32S2TFT

    esp32s2tft = ESP32S2TFT(
        default_bg=0xFFFF00,
        scale=2,
    )

    # Create the labels
    esp32s2tft.add_text(
        text="ESP32-S2", text_position=(10, 10), text_scale=2, text_color=0xFF00FF
    )
    esp32s2tft.add_text(
        text="TFT Feather",
        text_position=(60, 30),
        text_anchor_point=(0.5, 0.5),
        text_color=0xFF00FF,
    )
    button_label = esp32s2tft.add_text(
        text="Press BOOT0 Button",
        line_spacing=1.0,
        text_position=(60, 50),
        text_anchor_point=(0.5, 0.5),
        text_color=0x606060,
    )
    esp32s2tft.display.root_group = esp32s2tft.splash

    while True:
        esp32s2tft.set_text_color(
            0xFF0000 if esp32s2tft.peripherals.button else 0x606060, button_label
        )
        esp32s2tft.peripherals.led = esp32s2tft.peripherals.button
        if esp32s2tft.peripherals.button:
            esp32s2tft.peripherals.neopixel[0] = colorwheel(random.randint(0, 255))


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

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "adafruit-circuitpython-esp32s2tft",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "adafruit,esp32,esp32s2,tft,espressif,feather,hardwaremicropython,circuitpython",
    "author": "",
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/d7/1a/95f4956aa7c665e30287d693ed70dc15f4a3f748620663c54bd4dd8f5f98/adafruit-circuitpython-esp32s2tft-1.2.1.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-esp32s2tft/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/esp32s2tft/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_ESP32S2TFT/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_ESP32S2TFT/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\nHelper library for the Adafruit ESP32-S2 TFT Feather.\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://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\nAdafruit ESP32-S2 TFT Feather\n\n`Purchase one from the Adafruit shop <http://www.adafruit.com/products/5300>`_\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_esp32s2tft\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:: python\n\n    import random\n    from rainbowio import colorwheel\n    from adafruit_esp32s2tft import ESP32S2TFT\n\n    esp32s2tft = ESP32S2TFT(\n        default_bg=0xFFFF00,\n        scale=2,\n    )\n\n    # Create the labels\n    esp32s2tft.add_text(\n        text=\"ESP32-S2\", text_position=(10, 10), text_scale=2, text_color=0xFF00FF\n    )\n    esp32s2tft.add_text(\n        text=\"TFT Feather\",\n        text_position=(60, 30),\n        text_anchor_point=(0.5, 0.5),\n        text_color=0xFF00FF,\n    )\n    button_label = esp32s2tft.add_text(\n        text=\"Press BOOT0 Button\",\n        line_spacing=1.0,\n        text_position=(60, 50),\n        text_anchor_point=(0.5, 0.5),\n        text_color=0x606060,\n    )\n    esp32s2tft.display.root_group = esp32s2tft.splash\n\n    while True:\n        esp32s2tft.set_text_color(\n            0xFF0000 if esp32s2tft.peripherals.button else 0x606060, button_label\n        )\n        esp32s2tft.peripherals.led = esp32s2tft.peripherals.button\n        if esp32s2tft.peripherals.button:\n            esp32s2tft.peripherals.neopixel[0] = colorwheel(random.randint(0, 255))\n\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/esp32s2tft/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_ESP32S2TFT/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Helper library for the Adafruit ESP32-S2 TFT Feather",
    "version": "1.2.1",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_ESP32S2TFT"
    },
    "split_keywords": [
        "adafruit",
        "esp32",
        "esp32s2",
        "tft",
        "espressif",
        "feather",
        "hardwaremicropython",
        "circuitpython"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "28c3759cf9ed1947afd50de5810e649d5094d5e1e45714448afe7bb768583230",
                "md5": "e6667e2d6f1e998f8746eaa3c5b1491f",
                "sha256": "d8827280e240b2cb7daba2843cf25c211f60ccca55145fa6b5894c643f0fdfaa"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_esp32s2tft-1.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e6667e2d6f1e998f8746eaa3c5b1491f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 9891,
            "upload_time": "2023-12-09T17:44:40",
            "upload_time_iso_8601": "2023-12-09T17:44:40.502204Z",
            "url": "https://files.pythonhosted.org/packages/28/c3/759cf9ed1947afd50de5810e649d5094d5e1e45714448afe7bb768583230/adafruit_circuitpython_esp32s2tft-1.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d71a95f4956aa7c665e30287d693ed70dc15f4a3f748620663c54bd4dd8f5f98",
                "md5": "37a3a8de1a70e5cb582b3d584f6936d7",
                "sha256": "7a23e155af144b6bb4cf98788e854e7d4fe0e04805de95bae032b95168ceaba9"
            },
            "downloads": -1,
            "filename": "adafruit-circuitpython-esp32s2tft-1.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "37a3a8de1a70e5cb582b3d584f6936d7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 28788,
            "upload_time": "2023-12-09T17:44:42",
            "upload_time_iso_8601": "2023-12-09T17:44:42.090748Z",
            "url": "https://files.pythonhosted.org/packages/d7/1a/95f4956aa7c665e30287d693ed70dc15f4a3f748620663c54bd4dd8f5f98/adafruit-circuitpython-esp32s2tft-1.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-09 17:44:42",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_ESP32S2TFT",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "adafruit-circuitpython-esp32s2tft"
}
        
Elapsed time: 0.21772s