Metadata-Version: 2.1
Name: adafruit-circuitpython-rgb-display
Version: 3.6.0
Summary: CircuitPython library for RGB displays.
Home-page: https://github.com/adafruit/Adafruit_CircuitPython_RGB_Display
Author: Radomir Dopieralski, Michael McWethy
Author-email: circuitpython@adafruit.com
License: MIT
Description: Introduction
        ============
        
        .. image:: https://readthedocs.org/projects/adafruit-circuitpython-rgb_display/badge/?version=latest
            :target: https://circuitpython.readthedocs.io/projects/rgb_display/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_RGB_Display.svg?branch=master
            :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_RGB_Display
            :alt: Build Status
        
        Port of display drivers from https://github.com/adafruit/micropython-adafruit-rgb-display to Adafruit CircuitPython for use on Adafruit's SAMD21-based and other CircuitPython boards.
        
        .. note:: This driver currently won't work on micropython.org firmware, instead you want the micropython-adafruit-rgb-display driver linked above!
        
        This CircuitPython driver currently supports displays that use the following display-driver chips: HX8353, HX8357, ILI9341, S6D02A1, ST7789, SSD1331, SSD1351, and ST7735.
        
        Dependencies
        =============
        This driver depends on:
        
        * `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
        * `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
        
        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>`_.
        
        For improved performance consider installing numpy.
        
        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-rgb-display/>`_. To install for current user:
        
        .. code-block:: shell
        
            pip3 install adafruit-circuitpython-rgb-display
        
        To install system-wide (this may be required in some cases):
        
        .. code-block:: shell
        
            sudo pip3 install adafruit-circuitpython-rgb-display
        
        To install in a virtual environment in your current project:
        
        .. code-block:: shell
        
            mkdir project-name && cd project-name
            python3 -m venv .env
            source .env/bin/activate
            pip3 install adafruit-circuitpython-rgb-display
        
        Usage Example
        =============
        
        .. code-block:: python
        
          import busio
          import digitalio
          from board import SCK, MOSI, MISO, D2, D3
        
          from adafruit_rgb_display import color565
          import adafruit_rgb_display.ili9341 as ili9341
        
        
          # Configuration for CS and DC pins:
          CS_PIN = D2
          DC_PIN = D3
        
          # Setup SPI bus using hardware SPI:
          spi = busio.SPI(clock=SCK, MOSI=MOSI, MISO=MISO)
        
          # Create the ILI9341 display:
          display = ili9341.ILI9341(spi, cs=digitalio.DigitalInOut(CS_PIN),
                                    dc=digitalio.DigitalInOut(DC_PIN))
        
          # Main loop:
          while True:
              # Clear the display
              display.fill(0)
              # Draw a red pixel in the center.
              display.pixel(120, 160, color565(255, 0, 0))
              # Pause 2 seconds.
              time.sleep(2)
              # Clear the screen blue.
              display.fill(color565(0, 0, 255))
              # Pause 2 seconds.
              time.sleep(2)
        
        Contributing
        ============
        
        Contributions are welcome! Please read our `Code of Conduct
        <https://github.com/adafruit/Adafruit_CircuitPython_RGB_Display/blob/master/CODE_OF_CONDUCT.md>`_
        before contributing to help this project stay welcoming.
        
        Documentation
        =============
        
        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>`_.
        
Keywords: adafruit rgb display hx8353 ili9341 s6d02A1 ssd1331 ssd1351 st7735hardware 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
