Skip to content

Support Color Order setting #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 14, 2018
Merged

Support Color Order setting #18

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c033bd4
Support Color Order setting
mcscope May 14, 2018
a8d4010
Typo
mcscope May 14, 2018
1b877e1
start header doesn't need to be instance val
mcscope May 14, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 32 additions & 24 deletions adafruit_dotstar.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,17 @@
__version__ = "0.0.0-auto.0"
__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_DotStar.git"

START_HEADER_SIZE = 4

# Pixel color order constants
RGB = (0, 1, 2)
RBG = (0, 2, 1)
GRB = (1, 0, 2)
GBR = (1, 2, 0)
BRG = (2, 0, 1)
BGR = (2, 1, 0)


class DotStar:
"""
A sequence of dotstars.
Expand All @@ -46,6 +57,9 @@ class DotStar:
:param float brightness: Brightness of the pixels between 0.0 and 1.0
:param bool auto_write: True if the dotstars should immediately change when
set. If False, `show` must be called explicitly.
:param tuple pixel_order: Set the pixel order on the strip - different
strips implement this differently. If you send red, and it looks blue
or green on the strip, modify this! It should be one of the values above


Example for Gemma M0:
Expand All @@ -63,7 +77,7 @@ class DotStar:
time.sleep(2)
"""

def __init__(self, clock, data, n, *, brightness=1.0, auto_write=True):
def __init__(self, clock, data, n, *, brightness=1.0, auto_write=True, pixel_order=BGR):
self._spi = None
try:
self._spi = busio.SPI(clock, MOSI=data)
Expand All @@ -77,19 +91,18 @@ def __init__(self, clock, data, n, *, brightness=1.0, auto_write=True):
self.cpin.direction = digitalio.Direction.OUTPUT
self.cpin.value = False
self._n = n
self.start_header_size = 4
# Supply one extra clock cycle for each two pixels in the strip.
self.end_header_size = n // 16
if n % 16 != 0:
self.end_header_size += 1
self._buf = bytearray(n * 4 + self.start_header_size + self.end_header_size)
self._buf = bytearray(n * 4 + START_HEADER_SIZE + self.end_header_size)
self.end_header_index = len(self._buf) - self.end_header_size

self.pixel_order = pixel_order
# Four empty bytes to start.
for i in range(self.start_header_size):
for i in range(START_HEADER_SIZE):
self._buf[i] = 0x00
# Mark the beginnings of each pixel.
for i in range(self.start_header_size, self.end_header_index, 4):
for i in range(START_HEADER_SIZE, self.end_header_index, 4):
self._buf[i] = 0xff
# 0xff bytes at the end.
for i in range(self.end_header_index, len(self._buf)):
Expand All @@ -104,7 +117,7 @@ def __init__(self, clock, data, n, *, brightness=1.0, auto_write=True):
def deinit(self):
"""Blank out the DotStars and release the resources."""
self.auto_write = False
for i in range(self.start_header_size, self.end_header_index):
for i in range(START_HEADER_SIZE, self.end_header_index):
if i % 4 != 0:
self._buf[i] = 0
self.show()
Expand All @@ -124,24 +137,19 @@ def __repr__(self):
return "[" + ", ".join([str(x) for x in self]) + "]"

def _set_item(self, index, value):
offset = index * 4 + self.start_header_size
r = 0
g = 0
b = 0
offset = index * 4 + START_HEADER_SIZE
rgb = value
if isinstance(value, int):
r = value >> 16
g = (value >> 8) & 0xff
b = value & 0xff
else:
r, g, b = value
rgb = (value >> 16, (value >> 8) & 0xff, value & 0xff)

# Each pixel starts with 0xFF, then red/green/blue. Although the data
# sheet suggests using a global brightness in the first byte, we don't
# do that because it causes further issues with persistence of vision
# projects.
self._buf[offset] = 0xff # redundant; should already be set
self._buf[offset + 1] = b
self._buf[offset + 2] = g
self._buf[offset + 3] = r
self._buf[offset + 1] = rgb[self.pixel_order[0]]
self._buf[offset + 2] = rgb[self.pixel_order[1]]
self._buf[offset + 3] = rgb[self.pixel_order[2]]

def __setitem__(self, index, val):
if isinstance(index, slice):
Expand All @@ -164,14 +172,14 @@ def __getitem__(self, index):
out = []
for in_i in range(*index.indices(len(self._buf) // 4)):
out.append(
tuple(self._buf[in_i * 4 + (3 - i) + self.start_header_size] for i in range(3)))
tuple(self._buf[in_i * 4 + (3 - i) + START_HEADER_SIZE] for i in range(3)))
return out
if index < 0:
index += len(self)
if index >= self._n or index < 0:
raise IndexError
offset = index * 4
return tuple(self._buf[offset + (3 - i) + self.start_header_size]
return tuple(self._buf[offset + (3 - i) + START_HEADER_SIZE]
for i in range(3))

def __len__(self):
Expand Down Expand Up @@ -217,10 +225,10 @@ def show(self):
if self.brightness < 1.0:
buf = bytearray(self._buf)
# Four empty bytes to start.
for i in range(self.start_header_size):
for i in range(START_HEADER_SIZE):
buf[i] = 0x00
for i in range(self.start_header_size, self.end_header_index):
buf[i] = self._buf[i] if i %4 == 0 else int(self._buf[i] * self._brightness)
for i in range(START_HEADER_SIZE, self.end_header_index):
buf[i] = self._buf[i] if i % 4 == 0 else int(self._buf[i] * self._brightness)
# Four 0xff bytes at the end.
for i in range(self.end_header_index, len(buf)):
buf[i] = 0xff
Expand Down