Skip to main content

CircuitPython library for WS2801 LEDs.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

Higher level WS2801 driver that presents the LED string as a sequence. It is the same api as the NeoPixel library.

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:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-ws2801

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-ws2801

To install in a virtual environment in your current project:

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 by a Gemma M0 using the hardware SPI capable outputs.

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.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit_circuitpython_ws2801-1.0.4.tar.gz (23.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

adafruit_circuitpython_ws2801-1.0.4-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file adafruit_circuitpython_ws2801-1.0.4.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_ws2801-1.0.4.tar.gz
Algorithm Hash digest
SHA256 4bac385fdada680ab1e9ecec7715c60c926cdf9ca02b838d81ccad32bc23ce7a
MD5 2d627f0c0d486399baeb39b8fc42ead1
BLAKE2b-256 884eb711402fcf6113b276f0b2407769c05b9d32b984fc67de9f7064221a5f64

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_ws2801-1.0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_ws2801-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 965646fa6d546da02aa77b10f109f81a8b168d84aa6c19265988ac7d2ed75c06
MD5 3fb1548ae4c3f412e26ca2f32392c211
BLAKE2b-256 ba39d9b29324b1a0df582986df87394f31340c5dc1b903c0ec4c33533134b083

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page