# The MIT License (MIT)
#
# Copyright (c) 2016 Philip R. Moyer and Radomir Dopieralski for Adafruit Industries.
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
"""
`adafruit_max7219.max7219` - MAX7219 LED Matrix/Digit Display Driver
========================================================================
CircuitPython library to support MAX7219 LED Matrix/Digit Display Driver.
This library supports the use of the MAX7219-based display in CircuitPython,
either an 8x8 matrix or a 8 digit 7-segment numeric display.
See Also
=========
* matrices.Maxtrix8x8 is a class support an 8x8 led matrix display
* bcddigits.BCDDigits is a class that support the 8 digit 7-segment display
Beware that most CircuitPython compatible hardware are 3.3v logic level! Make
sure that the input pin is 5v tolerant.
* Author(s): Michael McWethy
Implementation Notes
--------------------
**Hardware:**
* Adafruit `MAX7219CNG LED Matrix/Digit Display Driver -
MAX7219 <https://www.adafruit.com/product/453>`_ (Product ID: 453)
**Software and Dependencies:**
* Adafruit CircuitPython firmware for the ESP8622 and M0-based boards:
https://github.com/adafruit/circuitpython/releases
* Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
**Notes:**
#. Datasheet: https://cdn-shop.adafruit.com/datasheets/MAX7219.pdf
"""
# MicroPython SSD1306 OLED driver, I2C and SPI interfaces
import framebuf
import digitalio
from adafruit_bus_device import spi_device
from micropython import const
__version__ = "0.0.0-auto.0"
__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_MAX7219.git"
# register definitions
_DIGIT0 = const(1)
_INTENSITY = const(10)
[docs]class MAX7219:
"""
MAX2719 - driver for displays based on max719 chip_select
:param int width: the number of pixels wide
:param int height: the number of pixels high
:param object spi: an spi busio or spi bitbangio object
:param ~digitalio.DigitalInOut chip_select: digital in/out to use as chip select signal
:param baudrate: for SPIDevice baudrate (default 8000000)
:param polarity: for SPIDevice polarity (default 0)
:param phase: for SPIDevice phase (default 0)
"""
def __init__(self, width, height, spi, cs, *,
baudrate=8000000, polarity=0, phase=0):
self._chip_select = cs
self._chip_select.direction = digitalio.Direction.OUTPUT
self._spi_device = spi_device.SPIDevice(spi, cs, baudrate=baudrate,
polarity=polarity, phase=phase)
self._buffer = bytearray((height // 8) * width)
self.framebuf = framebuf.FrameBuffer1(self._buffer, width, height)
self.width = width
self.height = height
self.init_display()
[docs] def init_display(self):
"""Must be implemented by derived class (``matrices``, ``bcddigits``)"""
pass
[docs] def brightness(self, value):
"""
Controls the brightness of the display.
:param int value: 0->15 dimmest to brightest
"""
if not 0 <= value <= 15:
raise ValueError("Brightness out of range")
self.write_cmd(_INTENSITY, value)
[docs] def show(self):
"""
Updates the display.
"""
for ypos in range(8):
self.write_cmd(_DIGIT0 + ypos, self._buffer[ypos])
[docs] def fill(self, bit_value):
"""
Fill the display buffer.
:param int bit_value: value > 0 set the buffer bit, else clears the buffer bit
"""
self.framebuf.fill(bit_value)
[docs] def pixel(self, xpos, ypos, bit_value=None):
"""
Set one buffer bit
:param xpos: x position to set bit
:param ypos: y position to set bit
:param int bit_value: value > 0 sets the buffer bit, else clears the buffer bit
"""
bit_value = 0x01 if bit_value else 0x00
self.framebuf.pixel(xpos, ypos, bit_value)
[docs] def write_cmd(self, cmd, data):
"""Writes a command to spi device."""
#print('cmd {} data {}'.format(cmd,data))
self._chip_select.value = False
with self._spi_device as my_spi_device:
my_spi_device.write(bytearray([cmd, data]))