# SPDX-FileCopyrightText: Radomir Dopieralski 2016 for Adafruit Industries
# SPDX-FileCopyrightText: Tony DiCola 2016 for Adafruit Industries
#
# SPDX-License-Identifier: MIT
"""
adafruit_ht16k33.matrix
=======================
"""
from adafruit_ht16k33.ht16k33 import HT16K33
try:
from typing import Optional, Tuple, Union, List
from circuitpython_typing.pil import Image
from busio import I2C
except ImportError:
pass
__version__ = "0.0.0+auto.0"
__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_HT16K33.git"
[docs]
class Matrix8x8(HT16K33):
"""A single matrix."""
_columns = 8
_rows = 8
[docs]
def pixel(self, x: int, y: int, color: Optional[bool] = None) -> Optional[bool]:
"""Get or set the color of a given pixel.
:param int x: The x coordinate of the pixel
:param int y: The y coordinate of the pixel
:param bool color: (Optional) The state to set the pixel
:return: If ``color`` was not set, this returns the state of the pixel
:rtype: bool
"""
if not 0 <= x <= 7:
return None
if not 0 <= y <= 7:
return None
x = (x - 1) % 8
return super()._pixel(x, y, color)
def __getitem__(self, key: Tuple[int, int]) -> Optional[bool]:
x, y = key
return self.pixel(x, y)
def __setitem__(self, key: Tuple[int, int], value: Optional[bool]) -> None:
x, y = key
self.pixel(x, y, value)
# pylint: disable=too-many-branches
[docs]
def shift(self, x: int, y: int, rotate: bool = False) -> None:
"""
Shift pixels by x and y
:param int x: The x coordinate of the pixel
:param int y: The y coordinate of the pixel
:param bool rotate: (Optional) Rotate the shifted pixels to the left side (default=False)
"""
auto_write = self.auto_write
self._auto_write = False
if x > 0: # Shift Right
for _ in range(x):
for row in range(0, self.rows):
last_pixel = self[self.columns - 1, row] if rotate else 0
for col in range(self.columns - 1, 0, -1):
self[col, row] = self[col - 1, row]
self[0, row] = last_pixel
elif x < 0: # Shift Left
for _ in range(-x):
for row in range(0, self.rows):
last_pixel = self[0, row] if rotate else 0
for col in range(0, self.columns - 1):
self[col, row] = self[col + 1, row]
self[self.columns - 1, row] = last_pixel
if y > 0: # Shift Up
for _ in range(y):
for col in range(0, self.columns):
last_pixel = self[col, self.rows - 1] if rotate else 0
for row in range(self.rows - 1, 0, -1):
self[col, row] = self[col, row - 1]
self[col, 0] = last_pixel
elif y < 0: # Shift Down
for _ in range(-y):
for col in range(0, self.columns):
last_pixel = self[col, 0] if rotate else 0
for row in range(0, self.rows - 1):
self[col, row] = self[col, row + 1]
self[col, self.rows - 1] = last_pixel
self._auto_write = auto_write
if auto_write:
self.show()
# pylint: enable=too-many-branches
[docs]
def shift_right(self, rotate: bool = False) -> None:
"""
Shift all pixels right
:param rotate: (Optional) Rotate the shifted pixels to the left side (default=False)
"""
self.shift(1, 0, rotate)
[docs]
def shift_left(self, rotate: bool = False) -> None:
"""
Shift all pixels left
:param rotate: (Optional) Rotate the shifted pixels to the right side (default=False)
"""
self.shift(-1, 0, rotate)
[docs]
def shift_up(self, rotate: bool = False) -> None:
"""
Shift all pixels up
:param rotate: (Optional) Rotate the shifted pixels to bottom (default=False)
"""
self.shift(0, 1, rotate)
[docs]
def shift_down(self, rotate: bool = False) -> None:
"""
Shift all pixels down
:param rotate: (Optional) Rotate the shifted pixels to top (default=False)
"""
self.shift(0, -1, rotate)
[docs]
def image(self, img: Image) -> None:
"""Set buffer to value of Python Imaging Library image. The image should
be in 1 bit mode and a size equal to the display size.
:param Image img: The image to show
"""
imwidth, imheight = img.size
if imwidth != self.columns or imheight != self.rows:
raise ValueError(
f"Image must be same dimensions as display ({self.columns}x{self.rows})."
)
# Grab all the pixels from the image, faster than getpixel.
pixels = img.convert("1").load()
auto_write = self.auto_write
self._auto_write = False
# Iterate through the pixels
for x in range(self.columns): # yes this double loop is slow,
for y in range(self.rows): # but these displays are small!
self.pixel(x, y, pixels[(x, y)])
self._auto_write = auto_write
if self._auto_write:
self.show()
@property
def columns(self) -> int:
"""Read-only property for number of columns"""
return self._columns
@property
def rows(self) -> int:
"""Read-only property for number of rows"""
return self._rows
[docs]
class Matrix16x8(Matrix8x8):
"""The matrix wing."""
_columns = 16
def __init__(
self,
i2c: I2C,
address: Union[int, List[int], Tuple[int, ...]] = 0x70,
auto_write: bool = True,
brightness: float = 1.0,
) -> None:
super().__init__(i2c, address, auto_write, brightness)
self._columns *= len(self.i2c_device)
[docs]
def pixel(self, x: int, y: int, color: Optional[bool] = None) -> Optional[bool]:
"""Get or set the color of a given pixel.
:param int x: The x coordinate of the pixel
:param int y: The y coordinate of the pixel
:param bool color: (Optional) The state to set the pixel
:return: If ``color`` was not set, this returns the state of the pixel
:rtype: bool
"""
if not 0 <= x <= self._columns - 1:
return None
if not 0 <= y <= self._rows - 1:
return None
while x >= 8:
x -= 8
y += 8
return super()._pixel(y, x, color) # pylint: disable=arguments-out-of-order
[docs]
class MatrixBackpack16x8(Matrix16x8):
"""A double matrix backpack."""
[docs]
def pixel(self, x: int, y: int, color: Optional[bool] = None) -> Optional[bool]:
"""Get or set the color of a given pixel.
:param int x: The x coordinate of the pixel
:param int y: The y coordinate of the pixel
:param bool color: (Optional) The state to set the pixel
:return: If ``color`` was not set, this returns the state of the pixel
:rtype: bool
"""
if not 0 <= x <= self._columns - 1:
return None
if not 0 <= y <= self._rows - 1:
return None
return super()._pixel(x, y, color)
[docs]
class Matrix8x8x2(Matrix8x8):
"""A bi-color matrix."""
LED_OFF = 0
LED_RED = 1
LED_GREEN = 2
LED_YELLOW = 3
[docs]
def pixel(self, x: int, y: int, color: Optional[int] = None) -> Optional[int]:
"""Get or set the color of a given pixel.
:param int x: The x coordinate of the pixel
:param int y: The y coordinate of the pixel
:param int color: (Optional) The color to set the pixel
:return: If ``color`` was not set, this returns the state of the pixel
:rtype: int
"""
if not 0 <= x <= 7:
return None
if not 0 <= y <= 7:
return None
if color is not None:
super()._pixel(y, x, (color >> 1) & 0x01)
super()._pixel(y + 8, x, (color & 0x01))
else:
return super()._pixel(y, x) << 1 | super()._pixel(y + 8, x)
return None
[docs]
def fill(self, color: int) -> None:
"""Fill the whole display with the given color.
:param int color: The color to fill the display
"""
fill1 = 0xFF if color & 0x01 else 0x00
fill2 = 0xFF if color & 0x02 else 0x00
for i in range(8):
self._set_buffer(i * 2 + 1, fill1)
self._set_buffer(i * 2, fill2)
if self._auto_write:
self.show()
[docs]
def image(self, img: Image) -> None:
"""Set buffer to value of Python Imaging Library image. The image should
be a size equal to the display size.
:param Image img: The image to show
"""
imwidth, imheight = img.size
if imwidth != self.columns or imheight != self.rows:
raise ValueError(
f"Image must be same dimensions as display ({self.columns}x{self.rows})."
)
# Grab all the pixels from the image, faster than getpixel.
pixels = img.convert("RGB").load()
auto_write = self.auto_write
self._auto_write = False
# Iterate through the pixels
for x in range(self.columns): # yes this double loop is slow,
for y in range(self.rows): # but these displays are small!
if pixels[(x, y)] == (255, 0, 0):
self.pixel(x, y, self.LED_RED)
elif pixels[(x, y)] == (0, 255, 0):
self.pixel(x, y, self.LED_GREEN)
elif pixels[(x, y)] == (255, 255, 0):
self.pixel(x, y, self.LED_YELLOW)
else:
# Unknown color, default to LED off.
self.pixel(x, y, self.LED_OFF)
self._auto_write = auto_write
if self._auto_write:
self.show()