Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ssd1680/badge/?version=latest
:target: https://docs.circuitpython.org/projects/ssd1680/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_SSD1680/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_SSD1680/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 SSD1680-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.13" 250x122 Tri-Color eInk / ePaper Display with SRAM - SSD1680 Driver
`Purchase the Breakout from the Adafruit shop <http://www.adafruit.com/products/4947>`_
* Adafruit 2.13" HD Tri-Color eInk / ePaper Display FeatherWing - 250x122 RW Panel with SSD1680
`Purchase the FeatherWing from the Adafruit shop <http://www.adafruit.com/products/4814>`_
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-ssd1680/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-ssd1680
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-ssd1680
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-ssd1680
Usage Example
=============
.. code-block:: python
import time
import board
import displayio
import fourwire
import adafruit_ssd1680
displayio.release_displays()
# This pinout works on a Metro 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.D8 # Set to None for FeatherWing
epd_busy = board.D7 # Set to None for FeatherWing
display_bus = fourwire.FourWire(
spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000
)
time.sleep(1)
display = adafruit_ssd1680.SSD1680(
display_bus,
width=250,
height=122,
busy_pin=epd_busy,
highlight_color=0xFF0000,
rotation=270,
)
g = displayio.Group()
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/ssd1680/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_SSD1680/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-ssd1680",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, ssd1680, displayio, epd, epaper",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/47/31/0aff8e482053c9e052745d8bed83d2c09fd2e74ed56e0d85524be8cdc684/adafruit_circuitpython_ssd1680-2.1.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ssd1680/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/ssd1680/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_SSD1680/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_SSD1680/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 SSD1680-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\n* Adafruit 2.13\" 250x122 Tri-Color eInk / ePaper Display with SRAM - SSD1680 Driver\n\n`Purchase the Breakout from the Adafruit shop <http://www.adafruit.com/products/4947>`_\n\n* Adafruit 2.13\" HD Tri-Color eInk / ePaper Display FeatherWing - 250x122 RW Panel with SSD1680\n\n`Purchase the FeatherWing from the Adafruit shop <http://www.adafruit.com/products/4814>`_\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-ssd1680/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-ssd1680\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-ssd1680\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-ssd1680\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_ssd1680\n\n displayio.release_displays()\n\n # This pinout works on a Metro 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.D8 # Set to None for FeatherWing\n epd_busy = board.D7 # Set to None for FeatherWing\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_ssd1680.SSD1680(\n display_bus,\n width=250,\n height=122,\n busy_pin=epd_busy,\n highlight_color=0xFF0000,\n rotation=270,\n )\n\n g = displayio.Group()\n\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\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ssd1680/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_SSD1680/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 SSD1680-based ePaper displays",
"version": "2.1.0",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_SSD1680"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" ssd1680",
" displayio",
" epd",
" epaper"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "7cf9f79d34544cd8853d900aecbcbe75860cd42a6c7e566d3dfe2f789b972e68",
"md5": "fb0ca4756a4994ddcf3a9153687096a9",
"sha256": "0d3a4ae508aa53b7861f06131ba2a7ddd84c301e9470a6dbeb9d087fb0a3a97f"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ssd1680-2.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fb0ca4756a4994ddcf3a9153687096a9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5609,
"upload_time": "2025-07-31T20:16:54",
"upload_time_iso_8601": "2025-07-31T20:16:54.192175Z",
"url": "https://files.pythonhosted.org/packages/7c/f9/f79d34544cd8853d900aecbcbe75860cd42a6c7e566d3dfe2f789b972e68/adafruit_circuitpython_ssd1680-2.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "47310aff8e482053c9e052745d8bed83d2c09fd2e74ed56e0d85524be8cdc684",
"md5": "70838d25ea9afefeeca455c74768d1eb",
"sha256": "e927892672d575f37548554b6b28fba4e056a30b5b645d89edf6138901708578"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ssd1680-2.1.0.tar.gz",
"has_sig": false,
"md5_digest": "70838d25ea9afefeeca455c74768d1eb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30750,
"upload_time": "2025-07-31T20:16:55",
"upload_time_iso_8601": "2025-07-31T20:16:55.291660Z",
"url": "https://files.pythonhosted.org/packages/47/31/0aff8e482053c9e052745d8bed83d2c09fd2e74ed56e0d85524be8cdc684/adafruit_circuitpython_ssd1680-2.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-31 20:16:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_SSD1680",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
}
],
"lcname": "adafruit-circuitpython-ssd1680"
}
JSON
