Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ssd1608/badge/?version=latest
:target: https://docs.circuitpython.org/projects/ssd1608/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_SSD1608/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_SSD1608/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
CircuitPython `displayio` driver for SSD1608-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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
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-ssd1608/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-ssd1608
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-ssd1608
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-ssd1608
Usage Example
=============
.. code-block:: python
"""Simple test script for 1.54" 200x200 monochrome display.
Supported products:
* Adafruit 1.54" Monochrome ePaper Display Breakout
* https://www.adafruit.com/product/4196
"""
import time
import board
import displayio
import fourwire
import adafruit_ssd1608
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_ssd1608.SSD1608(display_bus, width=200, height=200, busy_pin=epd_busy)
g = displayio.Group()
f = open("/display-ruler.bmp", "rb")
pic = displayio.OnDiskBitmap(f)
# CircuitPython 6 & 7 compatible
t = displayio.TileGrid(
pic, pixel_shader=getattr(pic, "pixel_shader", displayio.ColorConverter())
)
# CircuitPython 7 compatible only
# 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/ssd1608/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_SSD1608/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-ssd1608",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,ssd1608,displayio,epd,epaper",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/82/57/e9a508af413cdebb34df1143c9920d0db469cebbe25542a1d9c8c2a21566/adafruit-circuitpython-ssd1608-1.3.1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ssd1608/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/ssd1608/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.. image:: https://github.com/adafruit/Adafruit_CircuitPython_SSD1608/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_SSD1608/actions/\n :alt: Build Status\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\nCircuitPython `displayio` driver for SSD1608-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://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\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-ssd1608/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-ssd1608\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-ssd1608\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-ssd1608\n\nUsage Example\n=============\n\n.. code-block:: python\n\n \"\"\"Simple test script for 1.54\" 200x200 monochrome display.\n\n Supported products:\n * Adafruit 1.54\" Monochrome ePaper Display Breakout\n * https://www.adafruit.com/product/4196\n \"\"\"\n\n import time\n import board\n import displayio\n import fourwire\n import adafruit_ssd1608\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(spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset,\n baudrate=1000000)\n time.sleep(1)\n\n display = adafruit_ssd1608.SSD1608(display_bus, width=200, height=200, busy_pin=epd_busy)\n\n g = displayio.Group()\n\n f = open(\"/display-ruler.bmp\", \"rb\")\n\n pic = displayio.OnDiskBitmap(f)\n # CircuitPython 6 & 7 compatible\n t = displayio.TileGrid(\n pic, pixel_shader=getattr(pic, \"pixel_shader\", displayio.ColorConverter())\n )\n # CircuitPython 7 compatible only\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(120)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ssd1608/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_SSD1608/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 SSD1608-based ePaper displays",
"version": "1.3.1",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_SSD1608"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"ssd1608",
"displayio",
"epd",
"epaper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "80e16e0f4482cda1559a658abdc4ecba9b0333ee364367c805a4580ec5a8a1bc",
"md5": "44985ce0cde613e215b0a23e6070304e",
"sha256": "ede6ff88e14692b970e68b07c39b7e3f58bede78fb73b5a3d53ac9e9d7402158"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ssd1608-1.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "44985ce0cde613e215b0a23e6070304e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4897,
"upload_time": "2023-12-09T17:34:47",
"upload_time_iso_8601": "2023-12-09T17:34:47.392297Z",
"url": "https://files.pythonhosted.org/packages/80/e1/6e0f4482cda1559a658abdc4ecba9b0333ee364367c805a4580ec5a8a1bc/adafruit_circuitpython_ssd1608-1.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8257e9a508af413cdebb34df1143c9920d0db469cebbe25542a1d9c8c2a21566",
"md5": "64b37fb52dbc77c493940819f65307d1",
"sha256": "86906d6e2edd483e7685485a6b36d891cb229f2736d077dad5e07a4265d16da8"
},
"downloads": -1,
"filename": "adafruit-circuitpython-ssd1608-1.3.1.tar.gz",
"has_sig": false,
"md5_digest": "64b37fb52dbc77c493940819f65307d1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 31554,
"upload_time": "2023-12-09T17:34:48",
"upload_time_iso_8601": "2023-12-09T17:34:48.453617Z",
"url": "https://files.pythonhosted.org/packages/82/57/e9a508af413cdebb34df1143c9920d0db469cebbe25542a1d9c8c2a21566/adafruit-circuitpython-ssd1608-1.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 17:34:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_SSD1608",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-ssd1608"
}
JSON
