Skip to main content

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.

Metadata

Release files for adafruit-circuitpython-ws2801 1.0.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for adafruit-circuitpython-ws2801 1.0.6
File Size Uploaded
adafruit_circuitpython_ws2801-1.0.6.tar.gz 23.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for adafruit-circuitpython-ws2801 1.0.6
File Interpreter ABI Platform
adafruit_circuitpython_ws2801-1.0.6-py3-none-any.whl Python 3 none any Details

Total release size: 29.6 kB

Release files / adafruit_circuitpython_ws2801-1.0.6.tar.gz

Download URL adafruit_circuitpython_ws2801-1.0.6.tar.gz
Size 23.8 kB
Tags Source
SHA-256 checksum
How to use checksums
cb98a124b0837edb05d07c1b1b845fe36e8aa631c229fba83e929768066d13c5
BLAKE2b-256 checksum
How to use checksums
cbab80cbbac94c6eca8cfd3603da8550ca09f248762d4e25a6c0adfdee5079f2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.15

Release files / adafruit_circuitpython_ws2801-1.0.6-py3-none-any.whl

Download URL adafruit_circuitpython_ws2801-1.0.6-py3-none-any.whl
Size 5.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e8b278de9cb5e274f4808c3f449e8fd9505b75d259c4b465d99f5c84cd4a5cab
BLAKE2b-256 checksum
How to use checksums
66f415f8f9ba65cb450c59d97594cd287071be962597b840a870847a8a21bed8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.15

Release history Release notifications | RSS feed

This release

1.0.6 This release

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.10.9

1 release file

0.10.8

1 release file

0.10.7

1 release file

0.10.6

1 release file

0.10.5

1 release file

0.10.4

1 release file

0.10.3

1 release file

0.10.2

1 release file

0.10.1

1 release file

0.10.0

1 release file

0.9.7

1 release file

0.9.6

1 release file

0.9.5

1 release file

0.9.4

1 release file

0.9.3

1 release file

0.9.2

1 release file

0.9.1

1 release file

0.9.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page