adafruit-circuitpython-spd1656


Nameadafruit-circuitpython-spd1656 JSON
Version 0.9.5 PyPI version JSON
download
home_pageNone
SummaryDriver for SPD1656 driven ACeP (7-color) e-paper displays
upload_time2025-07-10 20:40:41
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT
keywords adafruit blinka circuitpython micropython spd1656
VCS
bugtrack_url
requirements Adafruit-Blinka adafruit-blinka-displayio
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============


.. image:: https://readthedocs.org/projects/adafruit-circuitpython-spd1656/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/spd1656/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_SPD1656/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_SPD1656/actions
    :alt: Build Status


.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
    :target: https://github.com/astral-sh/ruff
    :alt: Code Style: Ruff

Driver for SPD1656 driven ACeP (7-color) e-paper displays.

Please note that we do not have Blinka support for this yet. So it won't work with a Raspberry Pi.

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>`_.

This supports the common 4" and 5.65" ACeP displays.

* [Waveshare 4"](https://www.waveshare.com/4.01inch-e-paper-hat-f.htm)
* [Waveshare 5.65"](https://www.waveshare.com/5.65inch-e-paper-module-f.htm)
* [Pimoroni 5.7"](https://shop.pimoroni.com/products/inky-impression-5-7) (Likely the same as 5.65".)
* [Pimoroni 4"](https://shop.pimoroni.com/products/inky-impression-4)

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

.. code-block:: shell

    pip3 install adafruit-circuitpython-spd1656

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-spd1656

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name
    python3 -m venv .venv
    source .env/bin/activate
    pip3 install adafruit-circuitpython-spd1656

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_spd1656

Or the following command to update an existing version:

.. code-block:: shell

    circup update

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

.. code-block:: python

    # SPDX-FileCopyrightText: Copyright (c) 2023 Scott Shawcroft for Adafruit Industries
    # SPDX-FileCopyrightText: Copyright (c) 2021 Melissa LeBlanc-Williams for Adafruit Industries
    #
    # SPDX-License-Identifier: Unlicense

    """Simple test script for 5.6" 600x448 7-color ACeP display.
      """

    import time
    import board
    import displayio
    import fourwire
    import adafruit_spd1656

    displayio.release_displays()

    # This pinout works on a Feather RP2040 and may need to be altered for other boards.
    spi = board.SPI()  # Uses SCK and MOSI
    epd_cs = board.D9
    epd_dc = board.D10
    epd_reset = board.D11
    epd_busy = board.D12

    display_bus = fourwire.FourWire(
        spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000
    )

    display = adafruit_spd1656.SPD1656(
        display_bus, width=600, height=448, busy_pin=epd_busy
    )

    g = displayio.Group()

    pic = displayio.OnDiskBitmap("/display-ruler-720p.bmp")
    t = displayio.TileGrid(pic, pixel_shader=pic.pixel_shader)
    g.append(t)

    display.root_group = g

    display.refresh()

    time.sleep(120)


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

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "adafruit-circuitpython-spd1656",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "adafruit, blinka, circuitpython, micropython, spd1656",
    "author": null,
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/f2/4b/3df49cc461460ffe0b989f2118fc8cbbfc4042b11a460f58fbd8c54a7abf/adafruit_circuitpython_spd1656-0.9.5.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-spd1656/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/spd1656/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_SPD1656/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_SPD1656/actions\n    :alt: Build Status\n\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n    :target: https://github.com/astral-sh/ruff\n    :alt: Code Style: Ruff\n\nDriver for SPD1656 driven ACeP (7-color) e-paper displays.\n\nPlease note that we do not have Blinka support for this yet. So it won't work with a Raspberry Pi.\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\nThis supports the common 4\" and 5.65\" ACeP displays.\n\n* [Waveshare 4\"](https://www.waveshare.com/4.01inch-e-paper-hat-f.htm)\n* [Waveshare 5.65\"](https://www.waveshare.com/5.65inch-e-paper-module-f.htm)\n* [Pimoroni 5.7\"](https://shop.pimoroni.com/products/inky-impression-5-7) (Likely the same as 5.65\".)\n* [Pimoroni 4\"](https://shop.pimoroni.com/products/inky-impression-4)\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-spd1656/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-spd1656\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-spd1656\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 .env/bin/activate\n    pip3 install adafruit-circuitpython-spd1656\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_spd1656\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    # SPDX-FileCopyrightText: Copyright (c) 2023 Scott Shawcroft for Adafruit Industries\n    # SPDX-FileCopyrightText: Copyright (c) 2021 Melissa LeBlanc-Williams for Adafruit Industries\n    #\n    # SPDX-License-Identifier: Unlicense\n\n    \"\"\"Simple test script for 5.6\" 600x448 7-color ACeP display.\n      \"\"\"\n\n    import time\n    import board\n    import displayio\n    import fourwire\n    import adafruit_spd1656\n\n    displayio.release_displays()\n\n    # This pinout works on a Feather RP2040 and may need to be altered for other boards.\n    spi = board.SPI()  # Uses SCK and MOSI\n    epd_cs = board.D9\n    epd_dc = board.D10\n    epd_reset = board.D11\n    epd_busy = board.D12\n\n    display_bus = fourwire.FourWire(\n        spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000\n    )\n\n    display = adafruit_spd1656.SPD1656(\n        display_bus, width=600, height=448, busy_pin=epd_busy\n    )\n\n    g = displayio.Group()\n\n    pic = displayio.OnDiskBitmap(\"/display-ruler-720p.bmp\")\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    time.sleep(120)\n\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/spd1656/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_SPD1656/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Driver for SPD1656 driven ACeP (7-color) e-paper displays",
    "version": "0.9.5",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_SPD1656"
    },
    "split_keywords": [
        "adafruit",
        " blinka",
        " circuitpython",
        " micropython",
        " spd1656"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "6fbcc32631e883b6615ea4f6aeffe98a4b615081273b23d243fffc66b0639bc1",
                "md5": "f2d190e73ee99855a1644e27af538c44",
                "sha256": "acdb8bbf30621f10f3519a8d975f612d823b74f2718a84069687c01b937c69c2"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_spd1656-0.9.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "f2d190e73ee99855a1644e27af538c44",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 5576,
            "upload_time": "2025-07-10T20:40:40",
            "upload_time_iso_8601": "2025-07-10T20:40:40.883801Z",
            "url": "https://files.pythonhosted.org/packages/6f/bc/c32631e883b6615ea4f6aeffe98a4b615081273b23d243fffc66b0639bc1/adafruit_circuitpython_spd1656-0.9.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "f24b3df49cc461460ffe0b989f2118fc8cbbfc4042b11a460f58fbd8c54a7abf",
                "md5": "74bcbe0fbc795e0fd164f33dd07fccf2",
                "sha256": "6bae0df113cfd311f1bc2483eea8c7de409b398679edb80eb5a3523be83040e3"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_spd1656-0.9.5.tar.gz",
            "has_sig": false,
            "md5_digest": "74bcbe0fbc795e0fd164f33dd07fccf2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 32269,
            "upload_time": "2025-07-10T20:40:41",
            "upload_time_iso_8601": "2025-07-10T20:40:41.757964Z",
            "url": "https://files.pythonhosted.org/packages/f2/4b/3df49cc461460ffe0b989f2118fc8cbbfc4042b11a460f58fbd8c54a7abf/adafruit_circuitpython_spd1656-0.9.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-10 20:40:41",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_SPD1656",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "Adafruit-Blinka",
            "specs": []
        },
        {
            "name": "adafruit-blinka-displayio",
            "specs": []
        }
    ],
    "lcname": "adafruit-circuitpython-spd1656"
}
        
Elapsed time: 0.38823s