tm1637.py

'''
python-periphery TM1637 4 digit 8 segment module driver
Ported from: https://github.com/johnlr/raspberrypi-tm1637
Please setup the CLK and DIO default pin values: _DEF_TM1637_CLK, _DEF_TM1637_DIO
[DEVICE NAME]              [CLK]  [DIO]
----------------------------------------
Raspberry Pi                3      2
Orange Pi Allwinner H2+     11     12
Orange Pi Allwinner H3      11     12
Orange Pi Allwinner H5      11     12
Orange Pi Allwinner A64     226    227
Orange Pi 3                 121    122
Orange Pi Lite2             229    230
Orange Pi OnePlus           229    230
Orange Pi RK3399            44     43
Orange Pi 4                 65     64
'''

#!/usr/bin/python3
#-*- encoding: utf-8 -*-

import subprocess
from time import time, sleep, localtime

from periphery import GPIO

_DEF_TM1637_CLK = 3            # Default GPIO for CLK
_DEF_TM1637_DIO = 2            # Default GPIO for DIO
_DEF_TM1637_BRIGHT = 0xA       # Default brightness from 0x0 to 0xF
_DEF_TM1637_ANIM_DELAY = 0.2   # Default animation delay in seconds

def _which(executable):
    return str(subprocess.check_output(
        ["which", executable],
        shell=False
    ))[2:-3]

_hostname = _which("hostname")
_cat = _which("cat")
_df = _which("df")
_uptime = _which("uptime")
_service = _which("service")

class TM1637:
    I2C_COMM1 = 0x40
    I2C_COMM2 = 0xC0
    I2C_COMM3 = 0x80
    HEX_DIGIT_TO_SEGMENT = [
        # 0        1          2          3
        0b0111111, 0b0000110, 0b1011011, 0b1001111,
        # 4        5          6          7
        0b1100110, 0b1101101, 0b1111101, 0b0000111,
        # 8        9          A          b
        0b1111111, 0b1101111, 0b1110111, 0b1111100,
        # C        d          E          F
        0b0111001, 0b1011110, 0b1111001, 0b1110001
        ]
    SEGMENT_TO_DOWN_ANIM = dict(zip(HEX_DIGIT_TO_SEGMENT, [
        # 0-       1-         2-         3-
        0b1010100, 0b0000100, 0b1001100, 0b1001100,
        # 4-       5-         6-         7-
        0b0011100, 0b1011000, 0b1011000, 0b1000100,
        # 8-       9-         A          b-
        0b1011100, 0b1011100, 0b1011100, 0b0011000,
        # C-       d-         E-         F-
        0b1010000, 0b0001100, 0b1011000, 0b1011000
        ] ))
    SEGMENT_TO_DOWN_ANIM.update({0:0})
    ASCII_TO_SEGMENT = [
        # NUL   SOH   STX   ETX   EOT   ENQ   ACK   BEL   BS    HT    LF    VT
        0,    0,    0,    0,    0,    0,    0,    0,    0,    0,    0,    0,
        # FF    CR    SO    SI    DLE   DC1   DC2   DC3   DC4   NAK   SYN   ETB
        0,    0,    0,    0,    0,    0,    0,    0,    0,    0,    0,    0,
        # CAN   EM    SUB   ESC   FS    GS    RS    US    space !     "     #
        0,    0,    0,    0,    0,    0,    0,    0,    0,    0,    0x22, 0,
        # $     %     &     '     (     )     *     +     ,     -     .     /
        0,    0,    0,    0x01, 0,    0,    0,    0,    0x08, 0x40, 0x08, 0x52,
        # 0     1     2     3     4     5     6     7     8     9     :     ;
        0x3F, 0x06, 0x5B, 0x4F, 0x66, 0x6D, 0x7D, 0x07, 0x7F, 0x6F, 0,    0,
        # <     =     >     ?     @     A     B     C     D     E     F     G
        0,    0x48, 0,    0,    0,    0x77, 0x7C, 0x39, 0x5E, 0x79, 0x71, 0x3D,
        # H     I     J     K     L     M     N     O     P     Q     R     S
        0x76, 0x30, 0x1E, 0x75, 0x38, 0x55, 0x54, 0x5C, 0x73, 0x67, 0x50, 0x6D,
        # T     U     V     W     X     Y     Z     [     \     ]     ^     _
        0x78, 0x3E, 0x1C, 0x1D, 0x64, 0x6E, 0x5B, 0,    0x64, 0,    0,    0x08,
        # `     a     b     c     d     e     f     g     h     i     j     k
        0,    0x77, 0x7C, 0x39, 0x5E, 0x79, 0x71, 0x3D, 0x76, 0x30, 0x1E, 0x75,
        # l     m     n     o     p     q     r     s     t     u     v     w
        0x38, 0x55, 0x54, 0x5C, 0x73, 0x67, 0x50, 0x6D, 0x78, 0x3E, 0x1C, 0x1D,
        # x     y     z     {     |     }     ~     DEL
        0x64, 0x6E, 0x5B, 0,    0,    0,    0,    0
        ]

    def __init__(self, clk, dio, brightness=_DEF_TM1637_BRIGHT):
        self.clk = clk
        self.dio = dio
        self.brightness = brightness

    def gpio_begin(self):
        self.gpio_clk = GPIO(self.clk, "out")
        self.gpio_dio = GPIO(self.dio, "out")

    def gpio_end(self):
        self.set_segments([0, 0, 0, 0])
        self.gpio_clk.close()
        self.gpio_dio.close()

    def set_segments(self, segments, pos=0):
        # Write COMM1
        self.start()
        self.write_byte(self.I2C_COMM1)
        self.stop()

        # Write COMM2 + first digit address
        self.start()
        self.write_byte(self.I2C_COMM2 + pos)

        for seg in segments:
            self.write_byte(seg)
        self.stop()

        # Write COMM3 + brightness
        self.start()
        self.write_byte(self.I2C_COMM3 + self.brightness)
        self.stop()

    def start(self):
        self.gpio_clk.write(True)
        self.gpio_dio.write(True)
        self.gpio_dio.write(False)
        self.gpio_clk.write(False)

    def stop(self):
        self.gpio_clk.write(False)
        self.gpio_dio.write(False)
        self.gpio_clk.write(True)
        self.gpio_dio.write(True)

    def write_byte(self, data):
        #print("data={:x}".format(data))
        for i in range(8):
            self.gpio_clk.write(False)
            if data & 0x01:
                self.gpio_dio.write(True)
            else:
                self.gpio_dio.write(False)
            data >>= 1
            self.gpio_clk.write(True)

        self.gpio_clk.write(False)
        self.gpio_dio.write(True)
        self.gpio_clk.write(True)
        self.gpio_dio = GPIO(self.dio, "in")

        while self.gpio_dio.read():
            sleep(0.001)
            if self.gpio_dio.read():
                self.gpio_dio = GPIO(self.dio, "out")
                self.gpio_dio.write(False)
                self.gpio_dio = GPIO(self.dio, "in")
        self.gpio_dio = GPIO(self.dio, "out")


def show_text_sliding(tm, text, delay=_DEF_TM1637_ANIM_DELAY):
    segments = [0, 0, 0, 0]
    for i in range(len(text)):
        segments[0] = segments[1]
        segments[1] = segments[2]
        segments[2] = segments[3]
        segments[3] = tm.ASCII_TO_SEGMENT[ord(text[i:i+1])]
        tm.set_segments(segments)
        sleep(delay)
    for i in range(4):
        segments[0] = segments[1]
        segments[1] = segments[2]
        segments[2] = segments[3]
        segments[3] = 0
        tm.set_segments(segments)
        sleep(delay)

def show_ip_address(tm, delay=_DEF_TM1637_ANIM_DELAY):
    text = str(subprocess.check_output(
        [_hostname, "-I"],
        shell=False
    ))[2:-4]
    show_text_sliding(tm, "IP "+text, delay)

def show_clock(tm, duration, delay=_DEF_TM1637_ANIM_DELAY, update_rate=1):
    duration = duration // update_rate
    if duration == 0:
        duration = 1
    segments = [0, 0, 0, 0]
    bg_segments = [0, 0, 0, 0]
    t = localtime()
    bg_segments[0] = tm.HEX_DIGIT_TO_SEGMENT[t.tm_hour // 10] if t.tm_hour // 10 else 0
    bg_segments[1] = tm.HEX_DIGIT_TO_SEGMENT[t.tm_hour % 10]
    bg_segments[2] = tm.HEX_DIGIT_TO_SEGMENT[t.tm_min // 10]
    bg_segments[3] = tm.HEX_DIGIT_TO_SEGMENT[t.tm_min % 10]
    for i in range(4):
        segments[3-i] = tm.SEGMENT_TO_DOWN_ANIM[bg_segments[3-i]]
        tm.set_segments(segments)
        sleep(delay)
        segments[3-i] = bg_segments[3-i]
        tm.set_segments(segments)
        sleep(delay)
    for i in range(int(duration)):
        t = localtime()
        sleep(1 - time() % 1)
        segments[0] = tm.HEX_DIGIT_TO_SEGMENT[t.tm_hour // 10] if t.tm_hour // 10 else 0
        segments[1] = tm.HEX_DIGIT_TO_SEGMENT[t.tm_hour % 10]
        segments[2] = tm.HEX_DIGIT_TO_SEGMENT[t.tm_min // 10]
        segments[3] = tm.HEX_DIGIT_TO_SEGMENT[t.tm_min % 10]
        tm.set_segments([segments[0], 0x80 + segments[1], segments[2], segments[3]])
        sleep(update_rate-1 + 0.5)
        tm.set_segments([segments[0], segments[1], segments[2], segments[3]])
    for i in range(4):
        segments[3-i] = tm.SEGMENT_TO_DOWN_ANIM[segments[3-i]]
        tm.set_segments(segments)
        sleep(delay)
        segments[3-i] = 0
        tm.set_segments(segments)
        sleep(delay)

def show_on_full_storage(tm, threshold_percent, delay=_DEF_TM1637_ANIM_DELAY):
    text = str(subprocess.check_output(
        _df,
        shell=False
    ))[2:-1]
    for row in text.split("\\n")[1:-1]:
        if int(row.split(' ')[-2].strip('%')) >= threshold_percent:
            show_text_sliding(tm, row.split(' ')[0]+" full", delay)

def show_on_low_memory(tm, threshold_kib, delay=_DEF_TM1637_ANIM_DELAY):
    value = int(str(subprocess.check_output(
        [_cat, "/proc/meminfo"],
        shell=False
    )).split("MemAvailable:", 1)[1].split("kB", 1)[0].strip())
    if value < threshold_kib:
        show_text_sliding(tm, "ram "+str(value//1024)+" MiB left", delay)

def show_on_high_cpu_thermal(tm, threshold_celsius, sensor, delay=_DEF_TM1637_ANIM_DELAY):
    value = int(subprocess.check_output(
        [_cat, sensor],
        shell=False
    ))
    if value >= threshold_celsius*1000:
        show_text_sliding(tm, "cpu high "+str(value//1000)+" C", delay)

def show_on_users(tm, delay=_DEF_TM1637_ANIM_DELAY):
    text = str(subprocess.check_output(
        _uptime,
        shell=False
    )).split("user", 1)[0].split(",")[-1].strip()
    if text != "0":
        show_text_sliding(tm, text+" users", delay)

def show_on_stopped_process(tm, process_name, delay=_DEF_TM1637_ANIM_DELAY):
    try:
        text = str(subprocess.check_output(
            [_service, process_name, "status"],
            shell=False
        ))[2:-1]
        if "running" not in text:
            show_text_sliding(tm, process_name+" stopped", delay)
    except subprocess.CalledProcessError:
        show_text_sliding(tm, "No such process", delay)

def _demo(tm):
    while True:
        show_clock(tm, 10, update_rate=5)
        # Higher clock update rate can lower CPU impact at the cost of lower accuracy
        show_ip_address(tm)
        show_on_stopped_process(tm, "lighttpd")
        show_on_stopped_process(tm, "mysql")
        show_on_stopped_process(tm, "php7.4-fpm")
        # Make sure your distro supports the systemd service command
        show_on_high_cpu_thermal(tm, 50, "/sys/devices/virtual/thermal/thermal_zone0/temp")
        # Please change your cpu sensor path if different
        show_on_low_memory(tm, 131072)
        show_on_full_storage(tm, 85)
        show_on_users(tm)
        sleep(1)

if __name__ == "__main__":
    # Export the GPIO pins
    gpio_clk = GPIO(_DEF_TM1637_CLK, "out")
    gpio_dio = GPIO(_DEF_TM1637_DIO, "out")

    TM1 = TM1637(_DEF_TM1637_CLK, _DEF_TM1637_DIO)
    TM1.gpio_begin()

    # Run demo
    try:
        _demo(TM1)

    except KeyboardInterrupt:
        print("\nKeyboardInterrupt")

    TM1.gpio_end()

    # Unexport the GPIO pins
    gpio_clk.close()
    gpio_dio.close()