Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-il0398/badge/?version=latest
:target: https://docs.circuitpython.org/projects/il0398/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_IL0398/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_IL0398/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 drivers for IL0398 driven e-paper 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-il0398/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-il0398
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-il0398
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-il0398
Usage Example
=============
.. code-block:: python
"""Simple test script for 4.2" 400x300 black and white displays.
Supported products:
* WaveShare 4.2" Black and White
* https://www.waveshare.com/product/modules/oleds-lcds/e-paper/4.2inch-e-paper.htm
* https://www.waveshare.com/product/modules/oleds-lcds/e-paper/4.2inch-e-paper-module.htm
"""
import time
import board
import displayio
import fourwire
import adafruit_il0398
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_il0398.IL0398(display_bus, width=400, height=300, seconds_per_frame=20,
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()
time.sleep(120)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/il0398/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_IL0398/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-il0398",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, il0398, displayio, e-paper, display",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/34/39/ec0494c3b0c018b6ba45daa80a10d5c6873d02db857df61f083ce2cf186f/adafruit_circuitpython_il0398-1.2.3.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-il0398/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/il0398/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_IL0398/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_IL0398/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 drivers for IL0398 driven e-paper displays\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://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-il0398/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-il0398\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-il0398\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-il0398\n\nUsage Example\n=============\n\n.. code-block:: python\n\n \"\"\"Simple test script for 4.2\" 400x300 black and white displays.\n\n Supported products:\n * WaveShare 4.2\" Black and White\n * https://www.waveshare.com/product/modules/oleds-lcds/e-paper/4.2inch-e-paper.htm\n * https://www.waveshare.com/product/modules/oleds-lcds/e-paper/4.2inch-e-paper-module.htm\n \"\"\"\n\n import time\n import board\n import displayio\n import fourwire\n import adafruit_il0398\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_il0398.IL0398(display_bus, width=400, height=300, seconds_per_frame=20,\n 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\n g.append(t)\n\n display.root_group = g\n\n display.refresh()\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/il0398/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_IL0398/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 IL0398 driven e-paper displays",
"version": "1.2.3",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_IL0398"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" il0398",
" displayio",
" e-paper",
" display"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ffd4aad2ba8fa70341ad24a32956d65b85e3ccf0ee4f47bf5a6f67e6607cb9c0",
"md5": "af9aabea7493669c5c4c8a51c8d05e45",
"sha256": "f8373eab9d4631432f8da982579a2847263cd3bf9e8678ef5c8e841adec0377b"
},
"downloads": -1,
"filename": "adafruit_circuitpython_il0398-1.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "af9aabea7493669c5c4c8a51c8d05e45",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5060,
"upload_time": "2024-10-07T22:01:01",
"upload_time_iso_8601": "2024-10-07T22:01:01.352835Z",
"url": "https://files.pythonhosted.org/packages/ff/d4/aad2ba8fa70341ad24a32956d65b85e3ccf0ee4f47bf5a6f67e6607cb9c0/adafruit_circuitpython_il0398-1.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3439ec0494c3b0c018b6ba45daa80a10d5c6873d02db857df61f083ce2cf186f",
"md5": "73ae8ffa504641ce5526fc8123e4f685",
"sha256": "f6c477451240afbb12a37f1957227dea9884eb85cbd71ae902de00c4b6f6fc3b"
},
"downloads": -1,
"filename": "adafruit_circuitpython_il0398-1.2.3.tar.gz",
"has_sig": false,
"md5_digest": "73ae8ffa504641ce5526fc8123e4f685",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 31924,
"upload_time": "2024-10-07T22:01:03",
"upload_time_iso_8601": "2024-10-07T22:01:03.049438Z",
"url": "https://files.pythonhosted.org/packages/34/39/ec0494c3b0c018b6ba45daa80a10d5c6873d02db857df61f083ce2cf186f/adafruit_circuitpython_il0398-1.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 22:01:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_IL0398",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-il0398"
}
JSON
