Skip to main content

CircuitPython library for DotStar LEDs.

Project description

Adafruit CircuitPython DotStar

Documentation Status Discord Build Status Code Style: Black

Higher level DotStar driver that presents the strip 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, 0x100000 (#100000 on the web) is equivalent to (0x10, 0, 0).

If you send a tuple with 4 values, you can control the brightness value, which appears in DotStar but not NeoPixels. It should be a float. For example, (0xFF,0,0, 1.0) is the brightest red possible, (1,0,0,0.01) is the dimmest red possible.

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-dotstar

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

sudo pip3 install adafruit-circuitpython-dotstar

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-dotstar

Usage Example

This example demonstrates the library with the single built-in DotStar on the Trinket M0 and Gemma M0.

import board
import adafruit_dotstar

pixels = adafruit_dotstar.DotStar(board.APA102_SCK, board.APA102_MOSI, 1)
pixels[0] = (10, 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_dotstar-2.2.12.tar.gz (35.6 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit_circuitpython_dotstar-2.2.12.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_dotstar-2.2.12.tar.gz
Algorithm Hash digest
SHA256 c53210bb5f048be34e8c27c4329434d1d8d4bd16b1a6ebd54ba2b7dfb5e849de
MD5 5e46cbf67ff320b87c5d98c6cb06429f
BLAKE2b-256 1c742d019a6b88564737d32604d6ec8088efae747753614b1385f169092c0a3f

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_dotstar-2.2.12-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_dotstar-2.2.12-py3-none-any.whl
Algorithm Hash digest
SHA256 e5f51237f7c4dfd34d3e9a3884809c436e6628a7fa9c7e4a62a274dc87fac7e0
MD5 b5b57e7a572d13e4a11d9a918765f301
BLAKE2b-256 1a853660c3f2298474f0c6795996b79d8837da116639c4a5c5c93ed8e80e1b55

See more details on using hashes here.

Supported by

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