Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ws2801/badge/?version=latest
:target: https://docs.circuitpython.org/projects/ws2801/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_WS2801/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_WS2801/actions/
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
Higher level WS2801 driver that presents the LED string as a sequence.
It is the same api as the
`NeoPixel library <https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel>`_.
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, ``0x800000`` (``#800000``
on the web) is equivalent to ``(0x80, 0, 0)``.
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>`_.
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-ws2801/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-ws2801
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-ws2801
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-ws2801
Usage Example
=============
This example demonstrates the library driving
`a strand of 25 RGB leds <https://www.adafruit.com/product/322>`_ by a
`Gemma M0 <https://www.adafruit.com/product/3501>`_ using the hardware SPI capable outputs.
.. code-block:: python
import board
import adafruit_ws2801
leds = adafruit_ws2801.WS2801(board.D2, board.D0, 25)
leds.fill((0x80, 0, 0))
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ws2801/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_WS2801/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-ws2801",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, ws2801, leds, led, rgb, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/b1/a4/08f9e8dd14987b0c74d7c162719d8382cf29e2bfad6c7ef705f95665acea/adafruit_circuitpython_ws2801-1.0.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ws2801/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/ws2801/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_WS2801/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_WS2801/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nHigher level WS2801 driver that presents the LED string as a sequence.\nIt is the same api as the\n`NeoPixel library <https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel>`_.\n\nColors are stored as tuples by default. However, you can also use int hex syntax\nto set values similar to colors on the web. For example, ``0x800000`` (``#800000``\non the web) is equivalent to ``(0x80, 0, 0)``.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-ws2801/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-ws2801\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-ws2801\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-ws2801\n\nUsage Example\n=============\n\nThis example demonstrates the library driving\n`a strand of 25 RGB leds <https://www.adafruit.com/product/322>`_ by a\n`Gemma M0 <https://www.adafruit.com/product/3501>`_ using the hardware SPI capable outputs.\n\n.. code-block:: python\n\n import board\n import adafruit_ws2801\n\n leds = adafruit_ws2801.WS2801(board.D2, board.D0, 25)\n leds.fill((0x80, 0, 0))\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ws2801/en/latest/>`_.\n\nFor 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>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_WS2801/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for WS2801 LEDs.",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_WS2801"
},
"split_keywords": [
"adafruit",
" ws2801",
" leds",
" led",
" rgb",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9fdf264374a336b4229b8a6a242bf1926ec4148d65039e7a908ffe4d7e6c7fd7",
"md5": "f4cecce2081d0ac8c801ce4f0dd01ded",
"sha256": "a38c30e9aa1ca955c7fcc4ee951decb2ee1329439a97511546911d6a43ed3d05"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ws2801-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f4cecce2081d0ac8c801ce4f0dd01ded",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5792,
"upload_time": "2025-01-07T20:12:11",
"upload_time_iso_8601": "2025-01-07T20:12:11.887110Z",
"url": "https://files.pythonhosted.org/packages/9f/df/264374a336b4229b8a6a242bf1926ec4148d65039e7a908ffe4d7e6c7fd7/adafruit_circuitpython_ws2801-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b1a408f9e8dd14987b0c74d7c162719d8382cf29e2bfad6c7ef705f95665acea",
"md5": "d79311410877fd6d29a04800f7dc1599",
"sha256": "65859534e819fb438f4836257a6cc3be830df484ffd0877e9a0fb6ce189e12d5"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ws2801-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "d79311410877fd6d29a04800f7dc1599",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26938,
"upload_time": "2025-01-07T20:12:14",
"upload_time_iso_8601": "2025-01-07T20:12:14.394451Z",
"url": "https://files.pythonhosted.org/packages/b1/a4/08f9e8dd14987b0c74d7c162719d8382cf29e2bfad6c7ef705f95665acea/adafruit_circuitpython_ws2801-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-07 20:12:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_WS2801",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-busdevice",
"specs": []
},
{
"name": "adafruit-circuitpython-pixelbuf",
"specs": []
}
],
"lcname": "adafruit-circuitpython-ws2801"
}
JSON
