160 lines
4.7 KiB
ReStructuredText
160 lines
4.7 KiB
ReStructuredText
Introduction
|
|
============
|
|
|
|
|
|
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-uc8253/badge/?version=latest
|
|
:target: https://docs.circuitpython.org/projects/uc8253/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_UC8253/workflows/Build%20CI/badge.svg
|
|
:target: https://github.com/adafruit/Adafruit_CircuitPython_UC8253/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 epaper driven by UC8253 driver IC
|
|
|
|
|
|
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>`_.
|
|
|
|
|
|
* `3.7" 416x240 Monochrome Black/White eInk / ePaper - Bare Display - UC8253 Chipset <https://www.adafruit.com/product/6395>`_
|
|
* `3.7" 416x240 Tri-Color Red / Black / White eInk - Bare Display - UC8253 Chipset <https://www.adafruit.com/product/6394>`_
|
|
|
|
`Purchase one from the Adafruit shop <http://www.adafruit.com/products/>`_
|
|
|
|
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-uc8253/>`_.
|
|
To install for current user:
|
|
|
|
.. code-block:: shell
|
|
|
|
pip3 install adafruit-circuitpython-uc8253
|
|
|
|
To install system-wide (this may be required in some cases):
|
|
|
|
.. code-block:: shell
|
|
|
|
sudo pip3 install adafruit-circuitpython-uc8253
|
|
|
|
To install in a virtual environment in your current project:
|
|
|
|
.. code-block:: shell
|
|
|
|
mkdir project-name && cd project-name
|
|
python3 -m venv .venv
|
|
source .env/bin/activate
|
|
pip3 install adafruit-circuitpython-uc8253
|
|
|
|
Installing to a Connected CircuitPython Device with Circup
|
|
==========================================================
|
|
|
|
Make sure that you have ``circup`` installed in your Python environment.
|
|
Install it with the following command if necessary:
|
|
|
|
.. code-block:: shell
|
|
|
|
pip3 install circup
|
|
|
|
With ``circup`` installed and your CircuitPython device connected use the
|
|
following command to install:
|
|
|
|
.. code-block:: shell
|
|
|
|
circup install adafruit_uc8253
|
|
|
|
Or the following command to update an existing version:
|
|
|
|
.. code-block:: shell
|
|
|
|
circup update
|
|
|
|
Usage Example
|
|
=============
|
|
|
|
.. code-block:: python
|
|
|
|
import time
|
|
|
|
import board
|
|
import busio
|
|
import displayio
|
|
from fourwire import FourWire
|
|
|
|
import adafruit_uc8253
|
|
|
|
displayio.release_displays()
|
|
|
|
# This pinout works on a MagTag with the newer screen and may need to be altered for other boards.
|
|
spi = busio.SPI(board.EPD_SCK, board.EPD_MOSI) # Uses SCK and MOSI
|
|
epd_cs = board.EPD_CS
|
|
epd_dc = board.EPD_DC
|
|
epd_reset = board.EPD_RESET
|
|
epd_busy = board.EPD_BUSY
|
|
|
|
display_bus = FourWire(spi, command=epd_dc, chip_select=epd_cs, reset=epd_reset, baudrate=1000000)
|
|
time.sleep(1)
|
|
|
|
display = adafruit_uc8253.UC8253(
|
|
display_bus, width=240, height=416, busy_pin=epd_busy, rotation=0, vcom_cdi=0x97
|
|
)
|
|
|
|
g = displayio.Group()
|
|
|
|
pic = displayio.OnDiskBitmap("/display-ruler-1280x720.bmp")
|
|
t = displayio.TileGrid(pic, pixel_shader=pic.pixel_shader)
|
|
g.append(t)
|
|
|
|
display.root_group = g
|
|
|
|
display.refresh()
|
|
|
|
print("refreshed")
|
|
|
|
time.sleep(display.time_to_refresh + 5)
|
|
# Always refresh a little longer. It's not a problem to refresh
|
|
# a few seconds more, but it's terrible to refresh too early
|
|
# (the display will throw an exception when if the refresh
|
|
# is too soon)
|
|
print("waited correct time")
|
|
|
|
# Keep the display the same
|
|
while True:
|
|
time.sleep(10)
|
|
|
|
|
|
Documentation
|
|
=============
|
|
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/uc8253/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_UC8253/blob/HEAD/CODE_OF_CONDUCT.md>`_
|
|
before contributing to help this project stay welcoming.
|