Initial Commit

Author: mcauser

LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Mike Causer
+
+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.

README.md

@@ -0,0 +1,74 @@
+# MicroPython TM1640 LED Matrix
+
+A MicroPython library for a LED matrix using the TM1740 LED driver.
+
+![demo](docs/demo.jpg)
+
+## Examples
+
+Copy the file to your device, using ampy, webrepl or compiling and deploying. eg.
+
+```
+$ ampy put tm1640.py
+```
+
+**Basic usage**
+
+```
+import tm1640
+from machine import Pin
+tm = tm1640.TM1640(clk=Pin(14), dio=Pin(13))
+
+# line from bottom left to top right
+tm.write([1, 2, 4, 8, 16, 32, 64, 128])
+
+# all on
+tm.write([255, 255, 255, 255, 255, 255, 255, 255])
+
+# all off
+tm.write([0, 0, 0, 0, 0, 0, 0, 0])
+
+# all LEDs dim
+tm.brightness(1)
+
+# all LEDs bright
+tm.brightness(7)
+
+# the number 3
+tm.write([0b00000000, 0b00011110, 0b00110011, 0b00110000, 0b00011100, 0b00110000, 0b00110011, 0b00011110])
+
+# cross
+tm.write(b'\x81\x42\x24\x18\x18\x24\x42\x81')
+
+# squares
+tm.write([255, 129, 189, 165, 165, 189, 129, 255])
+
+# 50% on
+tm.write_int(0x55aa55aa55aa55aa)
+```
+
+For more detailed examples, see ![tm1640_test.py](tm1640_test.py)
+
+## Parts
+
+* [WeMos D1 Mini](https://www.aliexpress.com/store/product/D1-mini-Mini-NodeMcu-4M-bytes-Lua-WIFI-Internet-of-Things-development-board-based-ESP8266/1331105_32529101036.html) $3.50 USD
+* [Clone DIY More WeMos Matrix LED Shield](https://www.aliexpress.com/item/Matrix-LED-Shield-V1-0-0-For-WEMOS-D1-Mini-Digital-Signal-Output-Module-8-X/32821752799.html) $1.35 USD
+* [Dual Base for WeMos D1 Mini](https://www.aliexpress.com/store/product/Dual-Base-for-WeMos-D1-mini/1331105_32642733925.html) $1.00 USD
+
+## Connections
+
+WeMos D1 Mini | TM1640 LED Matrix
+------------- | -----------------
+D5 (GPIO14)   | CLK
+D7 (GPIO13)   | DIO
+3V3 (or 5V)   | VCC
+G             | GND
+
+## Links
+
+* [WeMos D1 Mini](https://wiki.wemos.cc/products:d1:d1_mini)
+* [micropython.org](http://micropython.org)
+* [TM1640 datasheet](http://www.titanmic.com/pic/other/2014-11-20-15-36-028.pdf)
+* [Titan Micro TM1640 product page](http://www.titanmec.com/index.php/en/project/view/id/305.html)
+* [MicroPython framebuf](http://docs.micropython.org/en/latest/esp8266/library/framebuf.html)
+* [Adafruit Ampy](https://learn.adafruit.com/micropython-basics-load-files-and-run-code/install-ampy)

docs/demo.jpg

@@ -0,0 +1,25 @@
+import sys
+# Remove current dir from sys.path, otherwise setuptools will peek up our
+# module instead of system.
+sys.path.pop(0)
+from setuptools import setup
+
+setup(
+    name='micropython-tm1640',
+    py_modules=['tm1640'],
+    version='1.0.0',
+    description='MicroPython library for TM1640 LED driver.',
+    long_description='This library lets you operate a LED matrix display module based on a TM1640 LED driver.',
+    keywords='tm1640 led matrix micropython',
+    url='https://github.com/mcauser/micropython-tm1640',
+    author='Mike Causer',
+    author_email='[email protected]',
+    maintainer='Mike Causer',
+    maintainer_email='[email protected]',
+    license='MIT',
+    classifiers = [
+        'Development Status :: 5 - Production/Stable',
+        'Programming Language :: Python :: Implementation :: MicroPython',
+        'License :: OSI Approved :: MIT License',
+    ],
+)

docs/tm1640_datasheet_v1.0.pdf

@@ -0,0 +1,103 @@
+# MicroPython TM1640 LED matrix display driver
+
+from micropython import const
+from machine import Pin
+from time import sleep_us
+
+TM1640_CMD1 = const(64)  # 0x40 data command
+TM1640_CMD2 = const(192) # 0xC0 address command
+TM1640_CMD3 = const(128) # 0x80 display control command
+TM1640_DSP_ON = const(8) # 0x08 display on 
+TM1640_DELAY = const(10) # 10us delay between clk/dio pulses
+
+class TM1640(object):
+    """Library for LED matrix display modules based on the TM1640 LED driver."""
+    def __init__(self, clk, dio, brightness=7):
+        self.clk = clk
+        self.dio = dio
+
+        if not 0 <= brightness <= 7:
+            raise ValueError("Brightness out of range")
+        self._brightness = brightness
+
+        self.clk.init(Pin.OUT, value=0)
+        self.dio.init(Pin.OUT, value=0)
+        sleep_us(TM1640_DELAY)
+
+        self._write_data_cmd()
+        self._write_dsp_ctrl()
+
+    def _start(self):
+        self.dio(0)
+        sleep_us(TM1640_DELAY)
+        self.clk(0)
+        sleep_us(TM1640_DELAY)
+
+    def _stop(self):
+        self.dio(0)
+        sleep_us(TM1640_DELAY)
+        self.clk(1)
+        sleep_us(TM1640_DELAY)
+        self.dio(1)
+
+    def _write_data_cmd(self):
+        # automatic address increment, normal mode
+        self._start()
+        self._write_byte(TM1640_CMD1)
+        self._stop()
+
+    def _write_dsp_ctrl(self):
+        # display on, set brightness
+        self._start()
+        self._write_byte(TM1640_CMD3 | TM1640_DSP_ON | self._brightness)
+        self._stop()
+
+    def _write_byte(self, b):
+        for i in range(8):
+            self.dio((b >> i) & 1)
+            sleep_us(TM1640_DELAY)
+            self.clk(1)
+            sleep_us(TM1640_DELAY)
+            self.clk(0)
+            sleep_us(TM1640_DELAY)
+
+    def brightness(self, val=None):
+        """Set the display brightness 0-7."""
+        # brightness 0 = 1/16th pulse width
+        # brightness 7 = 14/16th pulse width
+        if val is None:
+            return self._brightness
+        if not 0 <= val <= 7:
+            raise ValueError("Brightness out of range")
+
+        self._brightness = val
+        self._write_data_cmd()
+        self._write_dsp_ctrl()
+
+    def write(self, rows, pos=0):
+        if not 0 <= pos <= 7:
+            raise ValueError("Position out of range")
+
+        self._write_data_cmd()
+        self._start()
+
+        self._write_byte(TM1640_CMD2 | pos)
+        for row in rows:
+            self._write_byte(row)
+
+        self._stop()
+        self._write_dsp_ctrl()
+
+    def write_int(self, int, pos=0, len=8):
+        self.write(int.to_bytes(len, 'big'), pos)
+
+    def write_hmsb(self, buf, pos=0):
+        self._write_data_cmd()
+        self._start()
+
+        self._write_byte(TM1640_CMD2 | pos)
+        for i in range(7-pos, -1, -1):
+            self._write_byte(buf[i])
+
+        self._stop()
+        self._write_dsp_ctrl()