Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-uc8253/badge/?version=latest
:target: https://docs.circuitpython.org/projects/uc8253/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_UC8253/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_UC8253/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 epaper driven by UC8253 driver IC
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>`_.
* `3.7" 416x240 Monochrome Black/White eInk / ePaper - Bare Display - UC8253 Chipset <https://www.adafruit.com/product/6395>`_
* `3.7" 416x240 Tri-Color Red / Black / White eInk - Bare Display - UC8253 Chipset <https://www.adafruit.com/product/6394>`_
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/>`_
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-uc8253/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-uc8253
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-uc8253
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-uc8253
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_uc8253
Or the following command to update an existing version:
.. code-block:: shell
circup update
Usage Example
=============
.. code-block:: python
import time
import board
import busio
import displayio
from fourwire import FourWire
import adafruit_uc8253
displayio.release_displays()
# This pinout works on a MagTag with the newer screen and may need to be altered for other boards.
spi = busio.SPI(board.EPD_SCK, board.EPD_MOSI) # Uses SCK and MOSI
epd_cs = board.EPD_CS
epd_dc = board.EPD_DC
epd_reset = board.EPD_RESET
epd_busy = board.EPD_BUSY
display_bus = FourWire(spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000)
time.sleep(1)
display = adafruit_uc8253.UC8253(
display_bus, width=240, height=416, busy_pin=epd_busy, rotation=0, vcom_cdi=0x97
)
g = displayio.Group()
pic = displayio.OnDiskBitmap("/display-ruler-1280x720.bmp")
t = displayio.TileGrid(pic, pixel_shader=pic.pixel_shader)
g.append(t)
display.root_group = g
display.refresh()
print("refreshed")
time.sleep(display.time_to_refresh + 5)
# Always refresh a little longer. It's not a problem to refresh
# a few seconds more, but it's terrible to refresh too early
# (the display will throw an exception when if the refresh
# is too soon)
print("waited correct time")
# Keep the display the same
while True:
time.sleep(10)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/uc8253/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_UC8253/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-uc8253",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, uc8253, UC8253, epd",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/3d/72/1891fe26bf6ed99cfb5b47b164e45f6a3096513d2826fbeaf5ca851a90da/adafruit_circuitpython_uc8253-1.0.1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-uc8253/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/uc8253/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_UC8253/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_UC8253/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 epaper driven by UC8253 driver IC\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\n* `3.7\" 416x240 Monochrome Black/White eInk / ePaper - Bare Display - UC8253 Chipset <https://www.adafruit.com/product/6395>`_\n* `3.7\" 416x240 Tri-Color Red / Black / White eInk - Bare Display - UC8253 Chipset <https://www.adafruit.com/product/6394>`_\n\n`Purchase one from the Adafruit shop <http://www.adafruit.com/products/>`_\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-uc8253/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-uc8253\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-uc8253\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-uc8253\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_uc8253\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\n import board\n import busio\n import displayio\n from fourwire import FourWire\n\n import adafruit_uc8253\n\n displayio.release_displays()\n\n # This pinout works on a MagTag with the newer screen and may need to be altered for other boards.\n spi = busio.SPI(board.EPD_SCK, board.EPD_MOSI) # Uses SCK and MOSI\n epd_cs = board.EPD_CS\n epd_dc = board.EPD_DC\n epd_reset = board.EPD_RESET\n epd_busy = board.EPD_BUSY\n\n display_bus = FourWire(spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000)\n time.sleep(1)\n\n display = adafruit_uc8253.UC8253(\n display_bus, width=240, height=416, busy_pin=epd_busy, rotation=0, vcom_cdi=0x97\n )\n\n g = displayio.Group()\n\n pic = displayio.OnDiskBitmap(\"/display-ruler-1280x720.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 print(\"refreshed\")\n\n time.sleep(display.time_to_refresh + 5)\n # Always refresh a little longer. It's not a problem to refresh\n # a few seconds more, but it's terrible to refresh too early\n # (the display will throw an exception when if the refresh\n # is too soon)\n print(\"waited correct time\")\n\n # Keep the display the same\n while True:\n time.sleep(10)\n\n\nDocumentation\n=============\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/uc8253/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_UC8253/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 epaper driven by UC8253 driver IC",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_UC8253"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" uc8253",
" uc8253",
" epd"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b4f4099b80deb47cdd01d9f25f198625ecd6fb3a4376d70e03a6666ad2cc08ee",
"md5": "bb9975424949289da7e7b1ded8aebcdd",
"sha256": "e474938b54c9e6133e78969550451ed9dd2503967f8c8dd80ddf8f86ac2bf1de"
},
"downloads": -1,
"filename": "adafruit_circuitpython_uc8253-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bb9975424949289da7e7b1ded8aebcdd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5315,
"upload_time": "2025-10-08T13:39:30",
"upload_time_iso_8601": "2025-10-08T13:39:30.336779Z",
"url": "https://files.pythonhosted.org/packages/b4/f4/099b80deb47cdd01d9f25f198625ecd6fb3a4376d70e03a6666ad2cc08ee/adafruit_circuitpython_uc8253-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "3d721891fe26bf6ed99cfb5b47b164e45f6a3096513d2826fbeaf5ca851a90da",
"md5": "58208da408c839a14a604b221a47a33f",
"sha256": "0f2b6783d0b29c62552090e311a4c4d30719b7d3db2138833f6531609006706f"
},
"downloads": -1,
"filename": "adafruit_circuitpython_uc8253-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "58208da408c839a14a604b221a47a33f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 31764,
"upload_time": "2025-10-08T13:39:31",
"upload_time_iso_8601": "2025-10-08T13:39:31.695375Z",
"url": "https://files.pythonhosted.org/packages/3d/72/1891fe26bf6ed99cfb5b47b164e45f6a3096513d2826fbeaf5ca851a90da/adafruit_circuitpython_uc8253-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-08 13:39:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_UC8253",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
}
],
"lcname": "adafruit-circuitpython-uc8253"
}
JSON
