adafruit-circuitpython-epd


Nameadafruit-circuitpython-epd JSON
Version 2.12.1 PyPI version JSON
download
home_page
SummaryCircuitPython library for EPD e-ink displays.
upload_time2023-09-25 15:40:25
maintainer
docs_urlNone
author
requires_python
licenseMIT
keywords adafruit eink e-ink display epd hardware micropython 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-epd/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/epd/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_EPD/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_EPD/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

This library is for using CircuitPython with e-ink displays with built in SRAM.

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

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
* `font5x8.bin found in the examples bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_

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

.. code-block:: shell

    pip3 install adafruit-circuitpython-epd

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-epd

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

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

.. code-block:: python

    import digitalio
    import busio
    import board
    from adafruit_epd.epd import Adafruit_EPD
    from adafruit_epd.il0373 import Adafruit_IL0373

    # create the spi device and pins we will need
    spi = busio.SPI(board.SCK, MOSI=board.MOSI, MISO=board.MISO)
    ecs = digitalio.DigitalInOut(board.D12)
    dc = digitalio.DigitalInOut(board.D11)
    srcs = digitalio.DigitalInOut(board.D10)    # can be None to use internal memory
    rst = digitalio.DigitalInOut(board.D9)    # can be None to not use this pin
    busy = digitalio.DigitalInOut(board.D5)   # can be None to not use this pin

    # give them all to our driver
    print("Creating display")
    display = Adafruit_IL0373(104, 212, spi,          # 2.13" Tri-color display
                              cs_pin=ecs, dc_pin=dc, sramcs_pin=srcs,
                              rst_pin=rst, busy_pin=busy)

    display.rotation = 1

    # clear the buffer
    print("Clear buffer")
    display.fill(Adafruit_EPD.WHITE)
    display.pixel(10, 100, Adafruit_EPD.BLACK)

    print("Draw Rectangles")
    display.fill_rect(5, 5, 10, 10, Adafruit_EPD.RED)
    display.rect(0, 0, 20, 30, Adafruit_EPD.BLACK)

    print("Draw lines")
    display.line(0, 0, display.width-1, display.height-1, Adafruit_EPD.BLACK)
    display.line(0, display.height-1, display.width-1, 0, Adafruit_EPD.RED)

    print("Draw text")
    display.text('hello world', 25, 10, Adafruit_EPD.BLACK)
    display.display()


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

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

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "adafruit-circuitpython-epd",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "adafruit,eink,e-ink,display,epd,hardware,micropython,circuitpython",
    "author": "",
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/32/c0/744e59989fb71c4a1a91f9d8a7516e6f036e20fb2e1ce772b928dd35eb81/adafruit-circuitpython-epd-2.12.1.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-epd/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/epd/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_EPD/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_EPD/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\nThis library is for using CircuitPython with e-ink displays with built in SRAM.\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* `font5x8.bin found in the examples bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_\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-epd/>`_. To install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-epd\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-epd\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-epd\n\nUsage Example\n=============\n\n.. code-block:: python\n\n    import digitalio\n    import busio\n    import board\n    from adafruit_epd.epd import Adafruit_EPD\n    from adafruit_epd.il0373 import Adafruit_IL0373\n\n    # create the spi device and pins we will need\n    spi = busio.SPI(board.SCK, MOSI=board.MOSI, MISO=board.MISO)\n    ecs = digitalio.DigitalInOut(board.D12)\n    dc = digitalio.DigitalInOut(board.D11)\n    srcs = digitalio.DigitalInOut(board.D10)    # can be None to use internal memory\n    rst = digitalio.DigitalInOut(board.D9)    # can be None to not use this pin\n    busy = digitalio.DigitalInOut(board.D5)   # can be None to not use this pin\n\n    # give them all to our driver\n    print(\"Creating display\")\n    display = Adafruit_IL0373(104, 212, spi,          # 2.13\" Tri-color display\n                              cs_pin=ecs, dc_pin=dc, sramcs_pin=srcs,\n                              rst_pin=rst, busy_pin=busy)\n\n    display.rotation = 1\n\n    # clear the buffer\n    print(\"Clear buffer\")\n    display.fill(Adafruit_EPD.WHITE)\n    display.pixel(10, 100, Adafruit_EPD.BLACK)\n\n    print(\"Draw Rectangles\")\n    display.fill_rect(5, 5, 10, 10, Adafruit_EPD.RED)\n    display.rect(0, 0, 20, 30, Adafruit_EPD.BLACK)\n\n    print(\"Draw lines\")\n    display.line(0, 0, display.width-1, display.height-1, Adafruit_EPD.BLACK)\n    display.line(0, display.height-1, display.width-1, 0, Adafruit_EPD.RED)\n\n    print(\"Draw text\")\n    display.text('hello world', 25, 10, Adafruit_EPD.BLACK)\n    display.display()\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/epd/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_EPD/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "CircuitPython library for EPD e-ink displays.",
    "version": "2.12.1",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_EPD"
    },
    "split_keywords": [
        "adafruit",
        "eink",
        "e-ink",
        "display",
        "epd",
        "hardware",
        "micropython",
        "circuitpython"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a2bcca7a27f3c51ab3f1624678c62885d2c677ee7695a8f903960001840ebdbb",
                "md5": "c441d7d3e82c48eba0d2f2459351f528",
                "sha256": "7609fe701927274aa7ffc7b11cb57fda86f20f986023d37a9d8cebe2975e49e0"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_epd-2.12.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c441d7d3e82c48eba0d2f2459351f528",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 31016,
            "upload_time": "2023-09-25T15:40:24",
            "upload_time_iso_8601": "2023-09-25T15:40:24.299394Z",
            "url": "https://files.pythonhosted.org/packages/a2/bc/ca7a27f3c51ab3f1624678c62885d2c677ee7695a8f903960001840ebdbb/adafruit_circuitpython_epd-2.12.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "32c0744e59989fb71c4a1a91f9d8a7516e6f036e20fb2e1ce772b928dd35eb81",
                "md5": "d45fa97bc9fe93e4df8db91653847a88",
                "sha256": "2429055e4687480c914eac0933e6a282655ea28d9b27c0339ddca4e8b82dac6a"
            },
            "downloads": -1,
            "filename": "adafruit-circuitpython-epd-2.12.1.tar.gz",
            "has_sig": false,
            "md5_digest": "d45fa97bc9fe93e4df8db91653847a88",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 44556,
            "upload_time": "2023-09-25T15:40:25",
            "upload_time_iso_8601": "2023-09-25T15:40:25.576393Z",
            "url": "https://files.pythonhosted.org/packages/32/c0/744e59989fb71c4a1a91f9d8a7516e6f036e20fb2e1ce772b928dd35eb81/adafruit-circuitpython-epd-2.12.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-25 15:40:25",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_EPD",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "adafruit-circuitpython-epd"
}
        
Elapsed time: 0.12042s