Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-uc8151d/badge/?version=latest
:target: https://docs.circuitpython.org/projects/uc8151d/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_UC8151D/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_UC8151D/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
CircuitPython `displayio` driver for US8151D-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://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
Adafruit 2.9" Flexible 296x128 Monochrome eInk / ePaper Display
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/4262>`_
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-uc8151d/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-uc8151d
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-uc8151d
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-uc8151d
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_uc8151d
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
import time
import board
import displayio
import fourwire
import adafruit_uc8151d
displayio.release_displays()
# This pinout works on a Feather M4 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.D5
epd_busy = None
display_bus = fourwire.FourWire(
spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000
)
time.sleep(1)
display = adafruit_uc8151d.UC8151D(
display_bus, width=296, height=128, rotation=90, busy_pin=epd_busy
)
g = displayio.Group()
with open("/display-ruler.bmp", "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/uc8151d/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_UC8151D/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-uc8151d",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, uc8151d, uc8151, us8151d, displayio, epd, epaper, flexible",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/73/4d/0e962af745a849161bb5194aa0790635538c8b504275dc725eaa3b832d8a/adafruit_circuitpython_uc8151d-2.0.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-uc8151d/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/uc8151d/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_UC8151D/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_UC8151D/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\nCircuitPython `displayio` driver for US8151D-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://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\n\nAdafruit 2.9\" Flexible 296x128 Monochrome eInk / ePaper Display\n\n`Purchase one from the Adafruit shop <http://www.adafruit.com/products/4262>`_\n\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-uc8151d/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-uc8151d\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-uc8151d\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-uc8151d\n\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_uc8151d\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 import time\n import board\n import displayio\n import fourwire\n import adafruit_uc8151d\n\n displayio.release_displays()\n\n # This pinout works on a Feather M4 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.D5\n epd_busy = None\n\n display_bus = fourwire.FourWire(\n spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000\n )\n time.sleep(1)\n\n display = adafruit_uc8151d.UC8151D(\n display_bus, width=296, height=128, rotation=90, busy_pin=epd_busy\n )\n\n g = displayio.Group()\n\n with open(\"/display-ruler.bmp\", \"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=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/uc8151d/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_UC8151D/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython `displayio` driver for US8151D-based ePaper displays",
"version": "2.0.0",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_UC8151D.git"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" uc8151d",
" uc8151",
" us8151d",
" displayio",
" epd",
" epaper",
" flexible"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ccf7185313f3707725cde8d729667a8ae252633a0cb96f21fec9784da1084d89",
"md5": "df9bc5afbc51efa70dcb8efade00ae5e",
"sha256": "7580364da2f7a2af3905332e1682e4025fabb8e39e411b284065a4352c016430"
},
"downloads": -1,
"filename": "adafruit_circuitpython_uc8151d-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "df9bc5afbc51efa70dcb8efade00ae5e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5536,
"upload_time": "2025-03-03T14:22:39",
"upload_time_iso_8601": "2025-03-03T14:22:39.023001Z",
"url": "https://files.pythonhosted.org/packages/cc/f7/185313f3707725cde8d729667a8ae252633a0cb96f21fec9784da1084d89/adafruit_circuitpython_uc8151d-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "734d0e962af745a849161bb5194aa0790635538c8b504275dc725eaa3b832d8a",
"md5": "f88ddad87e87e410cf29916e66e8c910",
"sha256": "4a081cc8e15acfac9b07481d1034c0ad4976044c99890b4ca9f6ff2fa2c96bf3"
},
"downloads": -1,
"filename": "adafruit_circuitpython_uc8151d-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "f88ddad87e87e410cf29916e66e8c910",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30493,
"upload_time": "2025-03-03T14:22:40",
"upload_time_iso_8601": "2025-03-03T14:22:40.715258Z",
"url": "https://files.pythonhosted.org/packages/73/4d/0e962af745a849161bb5194aa0790635538c8b504275dc725eaa3b832d8a/adafruit_circuitpython_uc8151d-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-03 14:22:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_UC8151D",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-blinka-displayio",
"specs": []
}
],
"lcname": "adafruit-circuitpython-uc8151d"
}
JSON
