tm1637.py<\/h3>\n\"\"\"\r\nMicroPython TM1637 quad 7-segment LED display driver\r\nhttps:\/\/github.com\/mcauser\/micropython-tm1637\r\nMIT License\r\nCopyright (c) 2016 Mike Causer\r\nPermission is hereby granted, free of charge, to any person obtaining a copy\r\nof this software and associated documentation files (the \"Software\"), to deal\r\nin the Software without restriction, including without limitation the rights\r\nto use, copy, modify, merge, publish, distribute, sublicense, and\/or sell\r\ncopies of the Software, and to permit persons to whom the Software is\r\nfurnished to do so, subject to the following conditions:\r\nThe above copyright notice and this permission notice shall be included in all\r\ncopies or substantial portions of the Software.\r\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\r\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\r\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\r\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\r\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\r\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\r\nSOFTWARE.\r\n\"\"\"\r\n\r\nfrom micropython import const\r\nfrom machine import Pin\r\nfrom time import sleep_us, sleep_ms\r\n\r\nTM1637_CMD1 = const(64) # 0x40 data command\r\nTM1637_CMD2 = const(192) # 0xC0 address command\r\nTM1637_CMD3 = const(128) # 0x80 display control command\r\nTM1637_DSP_ON = const(8) # 0x08 display on\r\nTM1637_DELAY = const(10) # 10us delay between clk\/dio pulses\r\nTM1637_MSB = const(128) # msb is the decimal point or the colon depending on your display\r\n\r\n# 0-9, a-z, blank, dash, star\r\n_SEGMENTS = bytearray(b'\\x3F\\x06\\x5B\\x4F\\x66\\x6D\\x7D\\x07\\x7F\\x6F\\x77\\x7C\\x39\\x5E\\x79\\x71\\x3D\\x76\\x06\\x1E\\x76\\x38\\x55\\x54\\x3F\\x73\\x67\\x50\\x6D\\x78\\x3E\\x1C\\x2A\\x76\\x6E\\x5B\\x00\\x40\\x63')\r\n\r\nclass TM1637(object):\r\n \"\"\"Library for quad 7-segment LED modules based on the TM1637 LED driver.\"\"\"\r\n def __init__(self, clk, dio, brightness=7):\r\n self.clk = clk\r\n self.dio = dio\r\n\r\n if not 0 <= brightness <= 7:\r\n raise ValueError(\"Brightness out of range\")\r\n self._brightness = brightness\r\n\r\n self.clk.init(Pin.OUT, value=0)\r\n self.dio.init(Pin.OUT, value=0)\r\n sleep_us(TM1637_DELAY)\r\n\r\n self._write_data_cmd()\r\n self._write_dsp_ctrl()\r\n\r\n def _start(self):\r\n self.dio(0)\r\n sleep_us(TM1637_DELAY)\r\n self.clk(0)\r\n sleep_us(TM1637_DELAY)\r\n\r\n def _stop(self):\r\n self.dio(0)\r\n sleep_us(TM1637_DELAY)\r\n self.clk(1)\r\n sleep_us(TM1637_DELAY)\r\n self.dio(1)\r\n\r\n def _write_data_cmd(self):\r\n # automatic address increment, normal mode\r\n self._start()\r\n self._write_byte(TM1637_CMD1)\r\n self._stop()\r\n\r\n def _write_dsp_ctrl(self):\r\n # display on, set brightness\r\n self._start()\r\n self._write_byte(TM1637_CMD3 | TM1637_DSP_ON | self._brightness)\r\n self._stop()\r\n\r\n def _write_byte(self, b):\r\n for i in range(8):\r\n self.dio((b >> i) & 1)\r\n sleep_us(TM1637_DELAY)\r\n self.clk(1)\r\n sleep_us(TM1637_DELAY)\r\n self.clk(0)\r\n sleep_us(TM1637_DELAY)\r\n self.clk(0)\r\n sleep_us(TM1637_DELAY)\r\n self.clk(1)\r\n sleep_us(TM1637_DELAY)\r\n self.clk(0)\r\n sleep_us(TM1637_DELAY)\r\n\r\n def brightness(self, val=None):\r\n \"\"\"Set the display brightness 0-7.\"\"\"\r\n # brightness 0 = 1\/16th pulse width\r\n # brightness 7 = 14\/16th pulse width\r\n if val is None:\r\n return self._brightness\r\n if not 0 <= val <= 7:\r\n raise ValueError(\"Brightness out of range\")\r\n\r\n self._brightness = val\r\n self._write_data_cmd()\r\n self._write_dsp_ctrl()\r\n\r\n def write(self, segments, pos=0):\r\n \"\"\"Display up to 6 segments moving right from a given position.\r\n The MSB in the 2nd segment controls the colon between the 2nd\r\n and 3rd segments.\"\"\"\r\n if not 0 <= pos <= 5:\r\n raise ValueError(\"Position out of range\")\r\n self._write_data_cmd()\r\n self._start()\r\n\r\n self._write_byte(TM1637_CMD2 | pos)\r\n for seg in segments:\r\n self._write_byte(seg)\r\n self._stop()\r\n self._write_dsp_ctrl()\r\n\r\n def encode_digit(self, digit):\r\n \"\"\"Convert a character 0-9, a-f to a segment.\"\"\"\r\n return _SEGMENTS[digit & 0x0f]\r\n\r\n def encode_string(self, string):\r\n \"\"\"Convert an up to 4 character length string containing 0-9, a-z,\r\n space, dash, star to an array of segments, matching the length of the\r\n source string.\"\"\"\r\n segments = bytearray(len(string))\r\n for i in range(len(string)):\r\n segments[i] = self.encode_char(string[i])\r\n return segments\r\n\r\n def encode_char(self, char):\r\n \"\"\"Convert a character 0-9, a-z, space, dash or star to a segment.\"\"\"\r\n o = ord(char)\r\n if o == 32:\r\n return _SEGMENTS[36] # space\r\n if o == 42:\r\n return _SEGMENTS[38] # star\/degrees\r\n if o == 45:\r\n return _SEGMENTS[37] # dash\r\n if o >= 65 and o <= 90:\r\n return _SEGMENTS[o-55] # uppercase A-Z\r\n if o >= 97 and o <= 122:\r\n return _SEGMENTS[o-87] # lowercase a-z\r\n if o >= 48 and o <= 57:\r\n return _SEGMENTS[o-48] # 0-9\r\n raise ValueError(\"Character out of range: {:d} '{:s}'\".format(o, chr(o)))\r\n\r\n def hex(self, val):\r\n \"\"\"Display a hex value 0x0000 through 0xffff, right aligned.\"\"\"\r\n string = '{:04x}'.format(val & 0xffff)\r\n self.write(self.encode_string(string))\r\n\r\n def number(self, num):\r\n \"\"\"Display a numeric value -999 through 9999, right aligned.\"\"\"\r\n # limit to range -999 to 9999\r\n num = max(-999, min(num, 9999))\r\n string = '{0: >4d}'.format(num)\r\n self.write(self.encode_string(string))\r\n\r\n def numbers(self, num1, num2, colon=True):\r\n \"\"\"Display two numeric values -9 through 99, with leading zeros\r\n and separated by a colon.\"\"\"\r\n num1 = max(-9, min(num1, 99))\r\n num2 = max(-9, min(num2, 99))\r\n segments = self.encode_string('{0:0>2d}{1:0>2d}'.format(num1, num2))\r\n if colon:\r\n segments[1] |= 0x80 # colon on\r\n self.write(segments)\r\n\r\n def temperature(self, num):\r\n if num < -9:\r\n self.show('lo') # low\r\n elif num > 99:\r\n self.show('hi') # high\r\n else:\r\n string = '{0: >2d}'.format(num)\r\n self.write(self.encode_string(string))\r\n self.write([_SEGMENTS[38], _SEGMENTS[12]], 2) # degrees C\r\n\r\n def show(self, string, colon=False):\r\n segments = self.encode_string(string)\r\n if len(segments) > 1 and colon:\r\n segments[1] |= 128\r\n self.write(segments[:4])\r\n\r\n def scroll(self, string, delay=250):\r\n segments = string if isinstance(string, list) else self.encode_string(string)\r\n data = [0] * 8\r\n data[4:0] = list(segments)\r\n for i in range(len(segments) + 5):\r\n self.write(data[0+i:4+i])\r\n sleep_ms(delay)\r\n\r\n\r\nclass TM1637Decimal(TM1637):\r\n \"\"\"Library for quad 7-segment LED modules based on the TM1637 LED driver.\r\n This class is meant to be used with decimal display modules (modules\r\n that have a decimal point after each 7-segment LED).\r\n \"\"\"\r\n\r\n def encode_string(self, string):\r\n \"\"\"Convert a string to LED segments.\r\n Convert an up to 4 character length string containing 0-9, a-z,\r\n space, dash, star and '.' to an array of segments, matching the length of\r\n the source string.\"\"\"\r\n segments = bytearray(len(string.replace('.','')))\r\n j = 0\r\n for i in range(len(string)):\r\n if string[i] == '.' and j > 0:\r\n segments[j-1] |= TM1637_MSB\r\n continue\r\n segments[j] = self.encode_char(string[i])\r\n j += 1\r\n return segments\r\n<\/code><\/pre>\nRaspberry Pi Pico MicroPython: TM1637 Sketch<\/h2>\n
Raspberry Pi Pico W needs to be preloaded with a MicroPython UF2 file to program it in MicroPython. You can read our getting started guide for Raspberry Pi Pico where we show all steps required to start programming RP2040 in MicroPython.
\nIf you are using macOS, follow our guide to program Raspberry Pi Pico on macOS using Thonny IDE.<\/p>\n
![\"\"](\"https:\/\/raspberrypi.me\/blog\/wp-content\/uploads\/2023\/10\/20231024222418280.png\")
<\/p>\n
With all connections done as shown in the diagram above, connect the Pico to your computer using a USB cable. Open your IDE, and paste the following code into a new project.<\/p>\n
import tm1637\r\nfrom machine import Pin\r\nimport time\r\ntm = tm1637.TM1637(clk=Pin(0), dio=Pin(1))\r\n\r\n#set brightness(0-7)\r\ntm.brightness(5)\r\n# display \"10:24\"\r\ntm.numbers(10, 24, colon=True)\r\ntime.sleep(2)\r\n# Word\r\ntm.show(\"AbCd\", colon=False)\r\ntime.sleep(2)\r\n# display \"COOL\"\r\ntm.write([0b00111001, 0b00111111, 0b00111111, 0b00111000])\r\ntime.sleep(2)\r\n# Clear all\r\ntm.show(\" \")\r\ntime.sleep(2)\r\n# display \"bEEF\"\r\ntm.hex(0xbeef)\r\ntime.sleep(2)\r\n# display \"-123\"\r\ntm.number(-123)\r\ntime.sleep(2)\r\n# show temperature '24*C'\r\ntm.temperature(24)\r\ntime.sleep(2)\r\n#scroll display contents\r\ntm.scroll('RPI-ME', delay=250)\r\n<\/code><\/pre>\nRun the code by clicking the Run icon or by pressing the F5 key. Save the script to your Raspberry Pi Pico as main.py or any other name with a \u201c.py\u201d filename extension.<\/p>\n
When the code is successfully uploaded, you must see the TM1637 module display changing characters with a delay of 2 seconds between each change.<\/p>\n
![\"\"](\"https:\/\/raspberrypi.me\/blog\/wp-content\/uploads\/2023\/10\/20231024222418168-0.jpg\")
<\/p>\n
TM1637 MicroPython Code Explained<\/h2>\n
First, we import the necessary modules. The TM1637 module to communicate with the 7-segment display, the Pin module to set Pico W pins as output pins, and the time module to set delays between code execution.<\/p>\n
import tm1637\r\nfrom machine import Pin\r\nimport time\r\n<\/code><\/pre>\nWe then define an instance called tm and initiate the pins 0 and 1 of Raspberry Pi Pico to be interfaced with the pins CLK and DIO respectively.<\/p>\n
tm = tm1637.TM1637(clk=Pin(0), dio=Pin(1))\r\n<\/code><\/pre>\ntm.brightness can be set with a value between 1 to 7. Setting it to \u201c1\u201d sets the TM1637 brightness to the lowest, and \u201c7\u201d lights up all LEDs brightly.<\/p>\n
tm.brightness(5)\r\n<\/code><\/pre>\nThe next lines display 2 independent numbers on either side of the colon, with leading zeros. The argument colon can be set to False if you do not want the colon to show between the numbers.<\/p>\n
tm.numbers(10, 24, colon=True)\r\ntime.sleep(2)\r\n<\/code><\/pre>\nThe function write can be used to light up each segment of the LEDs. Its parameters are 8-bit binary numbers where each bit corresponds to one segment of a 7-segment display.<\/p>\n
tm.write([0b00111001, 0b00111111, 0b00111111, 0b00111000])\r\n<\/code><\/pre>\nTo understand the above code better, let us see a 7-segment display with the segments labeled.<\/p>\n
\r\n __2__\r\n | | | 0 -> 011 1111 -> 0x3f\r\n 1 | | 3 | 1 -> 010 0001 -> 0x21\r\n |__7__| | 2 -> 111 0110 -> 0x76\r\n | | | 4 -> ...\r\n 6 | | 4 | ...\r\n |__5__| | 9 -> ... -> 0x5f\r\n<\/code><\/pre>\nIn the function tm.write, the first argument is 0b00111001, which will display the first letter of the word \u201ccool\u201d(i.e. letter c) on TM1637 module. The least significant bit<\/a> in the argument represents segment \u2018a\u2019 and the most significant bit is for segment \u2018DP\u2019. So 0b00111001 will light up the segments a, d, e, and f in a 7-segment display. Similarly, the arguments 0b00111111, 0b00111111, and 0b00111000 will display the letters \u2018o\u2019, \u2018o\u2019, & \u2018l\u2019 respectively.<\/p>\nNext, we display a string ‘heya’ using tm.show function, a hex value using tm.hex , and a negative number using tm.number. The function tm.number can display numbers -999 through 9999 and the numbers will be right aligned.<\/p>\n
tm.show('heya', colon=False)\r\ntm.hex(0xbeef)\r\ntm.number(-123)\r\n<\/code><\/pre>\nIf the contents you want to display do not fit in the 4-digit segments of TM1637, you can scroll the contents using the scroll() function. The delay argument takes values in milliseconds and it is the time for which a character stays in a segment before scrolling to the left.<\/p>\n
scroll('scrolling', delay=250)\r\n<\/code><\/pre>\nDemonstration<\/h2>\n
Once the code is uploaded to your board, the TM1637 display will show all the different numbers and texts.<\/p>\n","protected":false},"excerpt":{"rendered":"
This guide focuses on TM1637 4 digit 7 segment display module and its interfacing with Raspberry Pi Pico. Unlike the 4-Digits 7 segment display which uses 12 pins to connect with a microcontroller, the TM1637 only uses four pins which makes it a very convenient choice of use. We will discuss this module\u2019s description, pinout,…<\/p>\n","protected":false},"author":1,"featured_media":21,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_kad_post_transparent":"default","_kad_post_title":"default","_kad_post_layout":"default","_kad_post_sidebar_id":"","_kad_post_content_style":"default","_kad_post_vertical_padding":"default","_kad_post_feature":"","_kad_post_feature_position":"","_kad_post_header":false,"_kad_post_footer":false,"footnotes":""},"categories":[4,3],"tags":[5,6],"class_list":["post-19","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-micropython","category-raspberry-pi-pico","tag-micropython","tag-raspberry-pi-pico"],"_links":{"self":[{"href":"https:\/\/raspberrypi.me\/blog\/wp-json\/wp\/v2\/posts\/19","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/raspberrypi.me\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/raspberrypi.me\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/raspberrypi.me\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/raspberrypi.me\/blog\/wp-json\/wp\/v2\/comments?post=19"}],"version-history":[{"count":2,"href":"https:\/\/raspberrypi.me\/blog\/wp-json\/wp\/v2\/posts\/19\/revisions"}],"predecessor-version":[{"id":47,"href":"https:\/\/raspberrypi.me\/blog\/wp-json\/wp\/v2\/posts\/19\/revisions\/47"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/raspberrypi.me\/blog\/wp-json\/wp\/v2\/media\/21"}],"wp:attachment":[{"href":"https:\/\/raspberrypi.me\/blog\/wp-json\/wp\/v2\/media?parent=19"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/raspberrypi.me\/blog\/wp-json\/wp\/v2\/categories?post=19"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/raspberrypi.me\/blog\/wp-json\/wp\/v2\/tags?post=19"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
![\"\"](\"https:\/\/raspberrypi.me\/blog\/wp-content\/uploads\/2023\/10\/20231024222418542.jpg\")
<\/p>\n![\"\"](\"https:\/\/raspberrypi.me\/blog\/wp-content\/uploads\/2023\/10\/20231024222418358.png\")
<\/p>\n