Metadata-Version: 2.1
Name: adafruit-circuitpython-neopixel
Version: 3.3.4
Summary: CircuitPython library for NeoPixel LEDs.
Home-page: https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel
Author: Adafruit Industries & Damien P. George
Author-email: circuitpython@adafruit.com
License: MIT
Description: 
        Adafruit CircuitPython NeoPixel
        ===============================
        
        .. image:: https://readthedocs.org/projects/adafruit-circuitpython-neopixel/badge/?version=latest
            :target: https://circuitpython.readthedocs.io/projects/neopixel/en/latest/
            :alt: Documentation Status
        
        .. image :: https://img.shields.io/discord/327254708534116352.svg
            :target: https://adafru.it/discord
            :alt: Discord
        
        .. image:: https://travis-ci.org/adafruit/Adafruit_CircuitPython_NeoPixel.svg?branch=master
            :target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_NeoPixel
            :alt: Build Status
        
        Higher level NeoPixel driver that presents the strip as a sequence. This is a
        supercharged version of the original MicroPython driver. Its now more like a
        normal Python sequence and features slice support, ``repr`` and ``len`` support.
        
        Colors are stored as tuples by default. However, you can also use int hex syntax
        to set values similar to colors on the web. For example, ``0x100000`` (``#100000``
        on the web) is equivalent to ``(0x10, 0, 0)``.
        
        .. note:: The int hex API represents the brightness of the white pixel when
          present by setting the RGB channels to identical values. For example, full
          white is 0xffffff but is actually (0, 0, 0, 0xff) in the tuple syntax. Setting
          a pixel value with an int will use the white pixel if the RGB channels are
          identical. For full, independent, control of each color component use the
          tuple syntax.
        
        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>`_.
        
        Usage Example
        =============
        
        This example demonstrates the library with the single built-in NeoPixel on the
        `Feather M0 Express <https://www.adafruit.com/product/3403>`_ and
        `Metro M0 Express <https://www.adafruit.com/product/3505>`_.
        
        .. code-block:: python
        
            import board
            import neopixel
        
            pixels = neopixel.NeoPixel(board.NEOPIXEL, 1)
            pixels[0] = (10, 0, 0)
        
        This example demonstrates the library with the ten built-in NeoPixels on the
        `Circuit Playground Express <https://www.adafruit.com/product/3333>`_. It turns
        off ``auto_write`` so that all pixels are updated at once when the ``show``
        method is called.
        
        .. code-block:: python
        
            import board
            import neopixel
        
            pixels = neopixel.NeoPixel(board.NEOPIXEL, 10, auto_write=False)
            pixels[0] = (10, 0, 0)
            pixels[9] = (0, 10, 0)
            pixels.show()
        
        This example demonstrates using a single NeoPixel tied to a GPIO pin and with
        a ``pixel_order`` to specify the color channel order. Note that ``bpp`` does not
        need to be specified as it is computed from the supplied ``pixel_order``.
        
        .. code-block:: python
        
            import board
            import neopixel
        
            pixel = neopixel.NeoPixel(board.D0, 1, pixel_order=neopixel.RGBW)
            pixel[0] = (30, 0, 20, 10)
        
        
        Contributing
        ============
        
        Contributions are welcome! Please read our `Code of Conduct
        <https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel/blob/master/CODE_OF_CONDUCT.md>`_
        before contributing to help this project stay welcoming.
        
        Building locally
        ================
        
        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-neopixel --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 neopixel rgb rgbw led 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
