https://github.com/adafruit/adafruit_circuitpython_il0398

CircuitPython displayio drivers for IL0398 based ePaper displays
https://github.com/adafruit/adafruit_circuitpython_il0398

circuitpython displayio epaper epd hacktoberfest

Last synced: 7 days ago
JSON representation

CircuitPython displayio drivers for IL0398 based ePaper displays

• Host: GitHub
• URL: https://github.com/adafruit/adafruit_circuitpython_il0398
• Owner: adafruit
• License: mit
• Created: 2019-08-21T01:36:49.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2023-12-18T17:00:52.000Z (10 months ago)
• Last Synced: 2024-09-28T03:04:29.327Z (7 days ago)
• Topics: circuitpython, displayio, epaper, epd, hacktoberfest
• Language: Python
• Size: 87.9 KB
• Stars: 0
• Watchers: 21
• Forks: 8
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
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 `_

Please ensure all dependencies are available on the CircuitPython filesystem.

This is easily achieved by downloading

`the Adafruit library and driver bundle `_.

Installing from PyPI

=====================

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from

PyPI `_. 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 `_.

For information on building library documentation, please check out `this guide `_.

Contributing

============

Contributions are welcome! Please read our `Code of Conduct

`_

before contributing to help this project stay welcoming.