Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-epd/badge/?version=latest
:target: https://docs.circuitpython.org/projects/epd/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_EPD/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_EPD/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
This library is for using CircuitPython with e-ink displays with built in SRAM.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
* `font5x8.bin found in the examples bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_
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-epd/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-epd
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-epd
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-epd
Usage Example
=============
.. code-block:: python
import digitalio
import busio
import board
from adafruit_epd.epd import Adafruit_EPD
from adafruit_epd.il0373 import Adafruit_IL0373
# create the spi device and pins we will need
spi = busio.SPI(board.SCK, MOSI=board.MOSI, MISO=board.MISO)
ecs = digitalio.DigitalInOut(board.D12)
dc = digitalio.DigitalInOut(board.D11)
srcs = digitalio.DigitalInOut(board.D10) # can be None to use internal memory
rst = digitalio.DigitalInOut(board.D9) # can be None to not use this pin
busy = digitalio.DigitalInOut(board.D5) # can be None to not use this pin
# give them all to our driver
print("Creating display")
display = Adafruit_IL0373(104, 212, spi, # 2.13" Tri-color display
cs_pin=ecs, dc_pin=dc, sramcs_pin=srcs,
rst_pin=rst, busy_pin=busy)
display.rotation = 1
# clear the buffer
print("Clear buffer")
display.fill(Adafruit_EPD.WHITE)
display.pixel(10, 100, Adafruit_EPD.BLACK)
print("Draw Rectangles")
display.fill_rect(5, 5, 10, 10, Adafruit_EPD.RED)
display.rect(0, 0, 20, 30, Adafruit_EPD.BLACK)
print("Draw lines")
display.line(0, 0, display.width-1, display.height-1, Adafruit_EPD.BLACK)
display.line(0, display.height-1, display.width-1, 0, Adafruit_EPD.RED)
print("Draw text")
display.text('hello world', 25, 10, Adafruit_EPD.BLACK)
display.display()
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/epd/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_EPD/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-epd",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, eink, e-ink, display, epd, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/d0/0e/f1302b29631bc47c34f96229dfa5175b262e9bb242eaad47e07980d9de21/adafruit_circuitpython_epd-2.13.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-epd/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/epd/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_EPD/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_EPD/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\nThis library is for using CircuitPython with e-ink displays with built in SRAM.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n* `font5x8.bin found in the examples bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_\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-epd/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-epd\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-epd\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-epd\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import digitalio\n import busio\n import board\n from adafruit_epd.epd import Adafruit_EPD\n from adafruit_epd.il0373 import Adafruit_IL0373\n\n # create the spi device and pins we will need\n spi = busio.SPI(board.SCK, MOSI=board.MOSI, MISO=board.MISO)\n ecs = digitalio.DigitalInOut(board.D12)\n dc = digitalio.DigitalInOut(board.D11)\n srcs = digitalio.DigitalInOut(board.D10) # can be None to use internal memory\n rst = digitalio.DigitalInOut(board.D9) # can be None to not use this pin\n busy = digitalio.DigitalInOut(board.D5) # can be None to not use this pin\n\n # give them all to our driver\n print(\"Creating display\")\n display = Adafruit_IL0373(104, 212, spi, # 2.13\" Tri-color display\n cs_pin=ecs, dc_pin=dc, sramcs_pin=srcs,\n rst_pin=rst, busy_pin=busy)\n\n display.rotation = 1\n\n # clear the buffer\n print(\"Clear buffer\")\n display.fill(Adafruit_EPD.WHITE)\n display.pixel(10, 100, Adafruit_EPD.BLACK)\n\n print(\"Draw Rectangles\")\n display.fill_rect(5, 5, 10, 10, Adafruit_EPD.RED)\n display.rect(0, 0, 20, 30, Adafruit_EPD.BLACK)\n\n print(\"Draw lines\")\n display.line(0, 0, display.width-1, display.height-1, Adafruit_EPD.BLACK)\n display.line(0, display.height-1, display.width-1, 0, Adafruit_EPD.RED)\n\n print(\"Draw text\")\n display.text('hello world', 25, 10, Adafruit_EPD.BLACK)\n display.display()\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/epd/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_EPD/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for EPD e-ink displays.",
"version": "2.13.0",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_EPD"
},
"split_keywords": [
"adafruit",
" eink",
" e-ink",
" display",
" epd",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "98de2f337ac2722cd2a132dd68c2a2006fe901b91e67d676c88bf8898545572f",
"md5": "476cc43af2dbf0195b7046fba265130e",
"sha256": "a15e35f2779b088267324c37075ce53c0ae3afeb6abe2542a1935775a8e783bb"
},
"downloads": -1,
"filename": "adafruit_circuitpython_epd-2.13.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "476cc43af2dbf0195b7046fba265130e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 31309,
"upload_time": "2024-11-04T23:27:07",
"upload_time_iso_8601": "2024-11-04T23:27:07.968046Z",
"url": "https://files.pythonhosted.org/packages/98/de/2f337ac2722cd2a132dd68c2a2006fe901b91e67d676c88bf8898545572f/adafruit_circuitpython_epd-2.13.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d00ef1302b29631bc47c34f96229dfa5175b262e9bb242eaad47e07980d9de21",
"md5": "9f381c698927a9d083239ec3fb3eb0a5",
"sha256": "4cc5587a51d15cc072ddb7eca5b5ed0dde0b9f316b26f2339ba4581c65afb6f5"
},
"downloads": -1,
"filename": "adafruit_circuitpython_epd-2.13.0.tar.gz",
"has_sig": false,
"md5_digest": "9f381c698927a9d083239ec3fb3eb0a5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 44817,
"upload_time": "2024-11-04T23:27:09",
"upload_time_iso_8601": "2024-11-04T23:27:09.712969Z",
"url": "https://files.pythonhosted.org/packages/d0/0e/f1302b29631bc47c34f96229dfa5175b262e9bb242eaad47e07980d9de21/adafruit_circuitpython_epd-2.13.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-04 23:27:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_EPD",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-busdevice",
"specs": []
},
{
"name": "adafruit-circuitpython-framebuf",
"specs": []
},
{
"name": "typing-extensions",
"specs": [
[
"~=",
"4.0"
]
]
}
],
"lcname": "adafruit-circuitpython-epd"
}
JSON
