No description
|
|
||
|---|---|---|
| .github/workflows | ||
| adafruit_fancyled | ||
| docs | ||
| examples | ||
| .gitignore | ||
| .pylintrc | ||
| .readthedocs.yml | ||
| CODE_OF_CONDUCT.md | ||
| LICENSE | ||
| README.rst | ||
| requirements.txt | ||
| setup.py | ||
Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-fancyled/badge/?version=latest
:target: https://circuitpython.readthedocs.io/projects/fancyled/en/latest/
:alt: Documentation Status
.. image :: https://img.shields.io/discord/327254708534116352.svg
:target: https://discord.gg/nBQh6qu
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_FancyLED/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_FancyLED/actions/
:alt: Build Status
FancyLED is a CircuitPython library to assist in creating buttery smooth LED animation. It's loosely inspired by the FastLED library for Arduino, and in fact we have a "helper" library using similar function names to assist with porting of existing Arduino FastLED projects to CircuitPython.
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>`_.
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-fancyled/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-fancyled
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-fancyled
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-fancyled
Usage Example
=============
See the examples in the examples/ folder.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/PaintYourDragon/Adafruit_CircuitPython_fancyled/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>`_.