adafruit-circuitpython-acep7in


Nameadafruit-circuitpython-acep7in JSON
Version 0.8.6 PyPI version JSON
download
home_page
SummaryDriver for 7.3" 7-color (aka ACeP) epaper display
upload_time2023-12-18 22:17:01
maintainer
docs_urlNone
author
requires_python
licenseMIT
keywords adafruit blinka circuitpython micropython acep7in epd acep
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-acep7in/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/acep7in/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_ACeP7In/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_ACeP7In/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

Driver for 7.3" 7-color (aka ACeP) epaper display


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

* `Waveshare 7.3" F <https://www.waveshare.com/7.3inch-e-paper-hat-f.htm>`_

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

.. code-block:: shell

    pip3 install adafruit-circuitpython-acep7in

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-acep7in

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

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_acep7in

Or the following command to update an existing version:

.. code-block:: shell

    circup update

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

.. code-block:: python

    # SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries
    # 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.
      """
    # pylint: disable=no-member

    import time
    import board
    import displayio
    import adafruit_acep7in

    # For 8.x.x and 9.x.x. When 8.x.x is discontinued as a stable release, change this.
    try:
        from fourwire import FourWire
    except ImportError:
        from displayio import FourWire

    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(
        spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000
    )

    display = adafruit_acep7in.ACeP7In(
        display_bus, width=800, height=480, busy_pin=epd_busy
    )

    g = displayio.Group()

    fn = "/display-ruler-720p.bmp"

    with open(fn, "rb") as f:
        pic = displayio.OnDiskBitmap(f)
        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/acep7in/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_ACeP7in/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "adafruit-circuitpython-acep7in",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "adafruit,blinka,circuitpython,micropython,acep7in,epd,acep",
    "author": "",
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/14/d4/ec7705ce7c79034b6c106bf16530c7a51ea9c908cb4135de4514caffe4ec/adafruit-circuitpython-acep7in-0.8.6.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-acep7in/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/acep7in/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_ACeP7In/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_ACeP7In/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\nDriver for 7.3\" 7-color (aka ACeP) epaper display\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\n* `Waveshare 7.3\" F <https://www.waveshare.com/7.3inch-e-paper-hat-f.htm>`_\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-acep7in/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-acep7in\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-acep7in\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-acep7in\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_acep7in\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: 2017 Scott Shawcroft, written for Adafruit Industries\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    # pylint: disable=no-member\n\n    import time\n    import board\n    import displayio\n    import adafruit_acep7in\n\n    # For 8.x.x and 9.x.x. When 8.x.x is discontinued as a stable release, change this.\n    try:\n        from fourwire import FourWire\n    except ImportError:\n        from displayio import FourWire\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(\n        spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000\n    )\n\n    display = adafruit_acep7in.ACeP7In(\n        display_bus, width=800, height=480, busy_pin=epd_busy\n    )\n\n    g = displayio.Group()\n\n    fn = \"/display-ruler-720p.bmp\"\n\n    with open(fn, \"rb\") as f:\n        pic = displayio.OnDiskBitmap(f)\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/acep7in/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_ACeP7in/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Driver for 7.3\" 7-color (aka ACeP) epaper display",
    "version": "0.8.6",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_ACeP7in"
    },
    "split_keywords": [
        "adafruit",
        "blinka",
        "circuitpython",
        "micropython",
        "acep7in",
        "epd",
        "acep"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b48802a01e87d76a3890070bb0dbab9a292c49671a32114fa5ea25dcf2575f8c",
                "md5": "4978360ad8f0da7a9548b4437d7a28a2",
                "sha256": "b414587a2a512bb686d205f6f07a1573bb644f5b05b8b804c14a31591f1d2c6f"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_acep7in-0.8.6-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4978360ad8f0da7a9548b4437d7a28a2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 5499,
            "upload_time": "2023-12-18T22:17:00",
            "upload_time_iso_8601": "2023-12-18T22:17:00.320560Z",
            "url": "https://files.pythonhosted.org/packages/b4/88/02a01e87d76a3890070bb0dbab9a292c49671a32114fa5ea25dcf2575f8c/adafruit_circuitpython_acep7in-0.8.6-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "14d4ec7705ce7c79034b6c106bf16530c7a51ea9c908cb4135de4514caffe4ec",
                "md5": "bf8f6b4a98c9a3788d9f24f2fa9c09ca",
                "sha256": "6420f2e2fcda54b764aef7622b6065449baa310d0644725917491729692a044b"
            },
            "downloads": -1,
            "filename": "adafruit-circuitpython-acep7in-0.8.6.tar.gz",
            "has_sig": false,
            "md5_digest": "bf8f6b4a98c9a3788d9f24f2fa9c09ca",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 33459,
            "upload_time": "2023-12-18T22:17:01",
            "upload_time_iso_8601": "2023-12-18T22:17:01.884943Z",
            "url": "https://files.pythonhosted.org/packages/14/d4/ec7705ce7c79034b6c106bf16530c7a51ea9c908cb4135de4514caffe4ec/adafruit-circuitpython-acep7in-0.8.6.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-18 22:17:01",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_ACeP7in",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "adafruit-circuitpython-acep7in"
}
        
Elapsed time: 0.21421s