Introduction¶
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 .env
source .env/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))
Contributing¶
Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.
Documentation¶
For information on building library documentation, please check out this guide.
Table of Contents¶
Simple test¶
Ensure your device works with this simple test.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 | ### Based on example from
### https://github.com/adafruit/Adafruit_CircuitPython_DotStar/tree/master/examples
import time
import random
import board
import adafruit_ws2801
### Example for a Feather M4 driving 25 12mm leds
odata = board.D5
oclock = board.D6
numleds = 25
bright = 1.0
leds = adafruit_ws2801.WS2801(
oclock, odata, numleds, brightness=bright, auto_write=False
)
######################### HELPERS ##############################
# a random color 0 -> 224
def random_color():
return random.randrange(0, 7) * 32
######################### MAIN LOOP ##############################
n_leds = len(leds)
while True:
# fill each led with a random color
for idx in range(n_leds):
leds[idx] = (random_color(), random_color(), random_color())
# show all leds in led string
leds.show()
time.sleep(0.25)
|
adafruit_ws2801
- WS2801 LED pixel string driver¶
- Author(s): Damien P. George, Limor Fried & Scott Shawcroft, Kevin J Walters
-
class
adafruit_ws2801.
WS2801
(clock, data, n, *, brightness=1.0, auto_write=True)¶ A sequence of WS2801 controlled LEDs.
Parameters: - clock (Pin) – The pin to output dotstar clock on.
- data (Pin) – The pin to output dotstar data on.
- n (int) – The number of LEDs in the chain.
- brightness (float) – The brightness between 0.0 and (default) 1.0.
- auto_write (bool) – True if the dotstars should immediately change when
set. If False,
show
must be called explicitly.
Example for Gemma M0:
import adafruit_ws2801 import time import board darkred = 0x100000 with adafruit_ws2801.WS2801(board.D2, board.D0, 25, brightness=1.0) as pixels: pixels[0] = darkred time.sleep(2)
-
brightness
¶ Overall brightness of the pixel
-
deinit
()¶ Blank out the DotStars and release the resources.
-
fill
(color)¶ Colors all pixels the given *color*.
-
show
()¶ Shows the new colors on the pixels themselves if they haven’t already been autowritten.
The colors may or may not be showing after this function returns because it may be done asynchronously.
\ Sort by:\ best rated\ newest\ oldest\
\\
Add a comment\ (markup):
\``code``
, \ code blocks:::
and an indented block after blank line