Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ssd1681/badge/?version=latest
:target: https://docs.circuitpython.org/projects/ssd1681/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_SSD1681/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_SSD1681/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 SSD1681-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 1.54" Tri-Color eInk / ePaper 200x200 Display with SRAM
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/4868>`_
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-ssd1681/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-ssd1681
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-ssd1681
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-ssd1681
Usage Example
=============
.. code-block:: python
import time
import board
import displayio
import fourwire
import adafruit_ssd1681
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 = board.D6
display_bus = fourwire.FourWire(
spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000
)
time.sleep(1)
display = adafruit_ssd1681.SSD1681(
display_bus, width=200, height=200, busy_pin=epd_busy, rotation=180
)
g = displayio.Group()
# CircuitPython 6 & 7 compatible
f = open("/display-ruler.bmp", "rb")
pic = displayio.OnDiskBitmap(f)
t = displayio.TileGrid(
pic, pixel_shader=getattr(pic, "pixel_shader", displayio.ColorConverter())
)
# # CircuitPython 7 compatible only
# pic = displayio.OnDiskBitmap("/display-ruler.bmp")
# t = displayio.TileGrid(pic, pixel_shader=pic.pixel_shader)
g.append(t)
display.root_group = g
display.refresh()
print("refreshed")
time.sleep(120)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ssd1681/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_SSD1681/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-ssd1681",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, ssd1681, displayio, epd, epaper",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/38/fa/0faaa00057b2e1fa86d696aa42e6724f46d0cb1c7d9d390b2be4416a8919/adafruit_circuitpython_ssd1681-2.0.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ssd1681/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/ssd1681/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\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_SSD1681/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_SSD1681/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 SSD1681-based ePaper displays\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 1.54\" Tri-Color eInk / ePaper 200x200 Display with SRAM\n\n`Purchase one from the Adafruit shop <http://www.adafruit.com/products/4868>`_\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-ssd1681/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-ssd1681\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-ssd1681\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-ssd1681\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_ssd1681\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 = board.D6\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_ssd1681.SSD1681(\n display_bus, width=200, height=200, busy_pin=epd_busy, rotation=180\n )\n\n g = displayio.Group()\n\n # CircuitPython 6 & 7 compatible\n f = open(\"/display-ruler.bmp\", \"rb\")\n pic = displayio.OnDiskBitmap(f)\n t = displayio.TileGrid(\n pic, pixel_shader=getattr(pic, \"pixel_shader\", displayio.ColorConverter())\n )\n\n # # CircuitPython 7 compatible only\n # pic = displayio.OnDiskBitmap(\"/display-ruler.bmp\")\n # t = displayio.TileGrid(pic, pixel_shader=pic.pixel_shader)\n\n g.append(t)\n\n display.root_group = g\n\n display.refresh()\n print(\"refreshed\")\n\n time.sleep(120)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ssd1681/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_SSD1681/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython `displayio` drivers for SSD1681-based ePaper displays",
"version": "2.0.0",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_SSD1681"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" ssd1681",
" displayio",
" epd",
" epaper"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "75854acfff799f3e823fbc1b9fc7f0c90df83ce31afdc5673c74efb6a86156c2",
"md5": "7dc02e2f7dfc2ebc2d2139ec1079797a",
"sha256": "3b10555a27c6960f20cd08de6d8206aabc3f45704fc8b55ee3236a017355b948"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ssd1681-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7dc02e2f7dfc2ebc2d2139ec1079797a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5284,
"upload_time": "2025-03-03T14:23:18",
"upload_time_iso_8601": "2025-03-03T14:23:18.305014Z",
"url": "https://files.pythonhosted.org/packages/75/85/4acfff799f3e823fbc1b9fc7f0c90df83ce31afdc5673c74efb6a86156c2/adafruit_circuitpython_ssd1681-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "38fa0faaa00057b2e1fa86d696aa42e6724f46d0cb1c7d9d390b2be4416a8919",
"md5": "6168db29c26576c9ef96d5237980ae39",
"sha256": "5cd330a16566a4942360a4539054a68ef44c5245d69352178831a09e024c09d2"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ssd1681-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "6168db29c26576c9ef96d5237980ae39",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 29836,
"upload_time": "2025-03-03T14:23:20",
"upload_time_iso_8601": "2025-03-03T14:23:20.009907Z",
"url": "https://files.pythonhosted.org/packages/38/fa/0faaa00057b2e1fa86d696aa42e6724f46d0cb1c7d9d390b2be4416a8919/adafruit_circuitpython_ssd1681-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-03 14:23:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_SSD1681",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
}
],
"lcname": "adafruit-circuitpython-ssd1681"
}
JSON
