adafruit-circuitpython-il91874


Nameadafruit-circuitpython-il91874 JSON
Version 1.4.1 PyPI version JSON
download
home_pageNone
SummaryCircuitPython `displayio` driver for IL91874-based ePaper displays
upload_time2024-10-07 22:01:06
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT
keywords adafruit blinka circuitpython micropython il91874 displayio epd epaper
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-il91874/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/il91874/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_IL91874/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_IL91874/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 `displayio` driver for IL91874-based ePaper displays


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

.. code-block:: shell

    pip3 install adafruit-circuitpython-il91874

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-il91874

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

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

.. code-block:: python

    """Simple test script for 2.7" 264x176 Tri-Color display shield

    Supported products:
      * Adafruit 2.7" Tri-Color ePaper Display Shield
        * https://www.adafruit.com/product/4229
      """

    import time
    import board
    import busio
    import displayio
    import adafruit_il91874

    displayio.release_displays()

    spi = board.SPI()
    epd_cs = board.D10
    epd_dc = board.D9

    display_bus = displayio.FourWire(spi, command=epd_dc, chip_select=epd_cs, baudrate=1000000)
    time.sleep(1)

    display = adafruit_il91874.IL91874(display_bus, width=264, height=176, highlight_color=0xff0000, rotation=90)

    g = displayio.Group()

    f = open("/display-ruler.bmp", "rb")

    pic = displayio.OnDiskBitmap(f)
    # CircuitPython 6 & 7 compatible
    t = displayio.TileGrid(
        pic, pixel_shader=getattr(pic, "pixel_shader", displayio.ColorConverter())
    )
    # CircuitPython 7 compatible only
    # t = displayio.TileGrid(pic, pixel_shader=pic.pixel_shader)
    g.append(t)

    display.root_group = g

    display.refresh()

    print("refreshed")

    time.sleep(120)

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

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

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "adafruit-circuitpython-il91874",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "adafruit, blinka, circuitpython, micropython, il91874, displayio, epd, epaper",
    "author": null,
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/27/54/84ab0955bd1631a7462ede4bb1c15eccac7949f16f1ba241d2d0437ffdde/adafruit_circuitpython_il91874-1.4.1.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-il91874/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/il91874/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_IL91874/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_IL91874/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 `displayio` driver for IL91874-based ePaper displays\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=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-il91874/>`_. To install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-il91874\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-il91874\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-il91874\n\nUsage Example\n=============\n\n.. code-block:: python\n\n    \"\"\"Simple test script for 2.7\" 264x176 Tri-Color display shield\n\n    Supported products:\n      * Adafruit 2.7\" Tri-Color ePaper Display Shield\n        * https://www.adafruit.com/product/4229\n      \"\"\"\n\n    import time\n    import board\n    import busio\n    import displayio\n    import adafruit_il91874\n\n    displayio.release_displays()\n\n    spi = board.SPI()\n    epd_cs = board.D10\n    epd_dc = board.D9\n\n    display_bus = displayio.FourWire(spi, command=epd_dc, chip_select=epd_cs, baudrate=1000000)\n    time.sleep(1)\n\n    display = adafruit_il91874.IL91874(display_bus, width=264, height=176, highlight_color=0xff0000, rotation=90)\n\n    g = displayio.Group()\n\n    f = open(\"/display-ruler.bmp\", \"rb\")\n\n    pic = displayio.OnDiskBitmap(f)\n    # CircuitPython 6 & 7 compatible\n    t = displayio.TileGrid(\n        pic, pixel_shader=getattr(pic, \"pixel_shader\", displayio.ColorConverter())\n    )\n    # CircuitPython 7 compatible only\n    # t = displayio.TileGrid(pic, pixel_shader=pic.pixel_shader)\n    g.append(t)\n\n    display.root_group = g\n\n    display.refresh()\n\n    print(\"refreshed\")\n\n    time.sleep(120)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/il91874/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_IL91874/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "CircuitPython `displayio` driver for IL91874-based ePaper displays",
    "version": "1.4.1",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_IL91874"
    },
    "split_keywords": [
        "adafruit",
        " blinka",
        " circuitpython",
        " micropython",
        " il91874",
        " displayio",
        " epd",
        " epaper"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0617745d830fa724230c210dcad0ef94c20dcc8372c582f5b22c1ad69bbffae3",
                "md5": "49d1e3aceda37783d0714b7705aa7a36",
                "sha256": "0a1fc85a8647362627c27d88b5831a2e70768f1201360ccc1105385724a2bc51"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_il91874-1.4.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "49d1e3aceda37783d0714b7705aa7a36",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 5146,
            "upload_time": "2024-10-07T22:01:04",
            "upload_time_iso_8601": "2024-10-07T22:01:04.894667Z",
            "url": "https://files.pythonhosted.org/packages/06/17/745d830fa724230c210dcad0ef94c20dcc8372c582f5b22c1ad69bbffae3/adafruit_circuitpython_il91874-1.4.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "275484ab0955bd1631a7462ede4bb1c15eccac7949f16f1ba241d2d0437ffdde",
                "md5": "8475a62bef4b143940153759a1f3e7a8",
                "sha256": "e5a699003b46437c4a3acdb9f7b2a9831605e3e6d7fe504583808fa65127de69"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_il91874-1.4.1.tar.gz",
            "has_sig": false,
            "md5_digest": "8475a62bef4b143940153759a1f3e7a8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 32215,
            "upload_time": "2024-10-07T22:01:06",
            "upload_time_iso_8601": "2024-10-07T22:01:06.517080Z",
            "url": "https://files.pythonhosted.org/packages/27/54/84ab0955bd1631a7462ede4bb1c15eccac7949f16f1ba241d2d0437ffdde/adafruit_circuitpython_il91874-1.4.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-07 22:01:06",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_IL91874",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "adafruit-circuitpython-il91874"
}
        
Elapsed time: 4.97798s