Metadata-Version: 2.1
Name: adafruit-circuitpython-epd
Version: 2.4.2
Summary: CircuitPython library for EPD e-ink displays.
Home-page: https://github.com/adafruit/Adafruit_CircuitPython_EPD
Author: Adafruit Industries
Author-email: circuitpython@adafruit.com
License: MIT
Description: Introduction
        ============
        
        .. image:: https://readthedocs.org/projects/adafruit-circuitpython-epd/badge/?version=latest
            :target: https://circuitpython.readthedocs.io/projects/epd/en/latest/
            :alt: Documentation Status
        
        .. image:: https://img.shields.io/discord/327254708534116352.svg
            :target: https://discord.gg/nBQh6qu
            :alt: Discord
        
        .. image:: https://travis-ci.com/adafruit/Adafruit_CircuitPython_EPD.svg?branch=master
            :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_EPD
            :alt: Build Status
        
        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>`_.
        
        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()
        
        
        Contributing
        ============
        
        Contributions are welcome! Please read our `Code of Conduct
        <https://github.com/adafruit/Adafruit_CircuitPython_EPD/blob/master/CODE_OF_CONDUCT.md>`_
        before contributing to help this project stay welcoming.
        
        Building locally
        ================
        
        Zip release files
        -----------------
        
        To build this library locally you'll need to install the
        `circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
        
        .. code-block:: shell
        
            python3 -m venv .env
            source .env/bin/activate
            pip install circuitpython-build-tools
        
        Once installed, make sure you are in the virtual environment:
        
        .. code-block:: shell
        
            source .env/bin/activate
        
        Then run the build:
        
        .. code-block:: shell
        
            circuitpython-build-bundles --filename_prefix adafruit-circuitpython-epd --library_location .
        
        Sphinx documentation
        -----------------------
        
        Sphinx is used to build the documentation based on rST files and comments in the code. First,
        install dependencies (feel free to reuse the virtual environment from above):
        
        .. code-block:: shell
        
            python3 -m venv .env
            source .env/bin/activate
            pip install Sphinx sphinx-rtd-theme
        
        Now, once you have the virtual environment activated:
        
        .. code-block:: shell
        
            cd docs
            sphinx-build -E -W -b html . _build/html
        
        This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
        view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
        locally verify it will pass.
        
Keywords: adafruit eink e-ink display epd hardware micropython circuitpython
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: System :: Hardware
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Description-Content-Type: text/x-rst
