main.py

"""
Version 1 by GurgleApps.com
Tool To Make Sprites https://gurgleapps.com/tools/matrix
Instructions
https://gurgleapps.com/learn/projects/8x8-led-matrix-halloween-jack-o-lantern-pumpkin-project-with-a-pico

Revised by: Adam Knowles
Version: 0.1
Description: Halloween pumpkin eyes for 2 x 8x8 LED Matrices (MAX7219)
GitHub Repository: https://github.com/Pharkie/pico-pumpkin/
License: GNU General Public License (GPL)
"""

import time
import json
import random
import gc
import machine
import matrix_fonts
from max7219_matrix import max7219_matrix

# User-settable variables

MAX_BRIGHT = 2  # Set global max brightness 0-15

# # Pico specific pins
# SPI_BUS = 0  # Use SPI(0) for Raspberry Pi Pico
# CLK_PIN = 2  # CLK / SCK
# DIN_PIN = 3  # DIN / MOSI / TX
# CS_PIN = 1   # CS

# RGB_LED_CONNECTED = True  # Set to False if RGB LED is not connected
# # These pins aren't used if RGB_LED_CONNECTED is False
# RED_PIN = 14
# GREEN_PIN = 15
# BLUE_PIN = 16

# ESP32-C3 specific pins
SPI_BUS = 0  # Use SPI(1) for ESP32-C3
CLK_PIN = 6
DIN_PIN = 7
CS_PIN = 5

MAX_BRIGHT = 2  # Set global max brightness 0-15

RGB_LED_CONNECTED = False  # Set to False if RGB LED is not connected
# These pins aren't used if RGB_LED_CONNECTED is False
RED_PIN = 1
GREEN_PIN = 2
BLUE_PIN = 3

DEBUG = False  # Set to True to log messages to log.txt


# Custom logging function
# Logs messages to a file with a timestamp
# mode='a' appends to the file, mode='w' overwrites the file
def log_message(message, mode="a"):
    """Log a message to a file"""
    if DEBUG:
        print(message)

        with open("log.txt", mode) as log_file:
            current_time = time.localtime()
            formatted_time = (
                f"{current_time[0]:04}-{current_time[1]:02}-{current_time[2]:02} "
                + f"{current_time[3]:02}:{current_time[4]:02}:{current_time[5]:02}"
            )
            log_file.write(f"{formatted_time} - {message}\n")


# Wipe the log file blank on each program run
log_message("Starting new log session", mode="w")

# Initialize SPI and MAX7219 matrix
log_message("Initializing SPI and MAX7219 matrix")
spi = machine.SPI(
    SPI_BUS,
    baudrate=10000000,
    polarity=0,
    phase=0,
    sck=machine.Pin(CLK_PIN),
    mosi=machine.Pin(DIN_PIN),
)
cs = machine.Pin(CS_PIN, machine.Pin.OUT)
max7219_eyes = max7219_matrix(spi, cs)
log_message("SPI and MAX7219 matrix initialized")

if RGB_LED_CONNECTED:
    # Define colours for RGB inner lights
    COLOUR_RED = (255, 0, 0)
    COLOUR_GREEN = (0, 255, 0)
    COLOUR_MAGENTA = (255, 0, 255)

    LED_COLOURS = [
        COLOUR_RED,
        COLOUR_GREEN,
        COLOUR_MAGENTA,
    ]

    red = machine.Pin(RED_PIN, machine.Pin.OUT)
    green = machine.Pin(GREEN_PIN, machine.Pin.OUT)
    blue = machine.Pin(BLUE_PIN, machine.Pin.OUT)

    def set_rgb_color(r, g, b):
        """Set the color of the RGB LED"""
        red.value(not r)  # Invert due to common anode
        green.value(not g)
        blue.value(not b)


def load_anims(file_name):
    """Load animations from json file"""
    data = {}
    try:
        with open(file_name, encoding="utf-8") as infile:
            data = json.load(infile)
    except FileNotFoundError:
        log_message("Problem loading JSON. File not found.")
    except json.JSONDecodeError:
        log_message("Problem loading JSON. Invalid JSON data.")

    log_message("Loaded animations from JSON file")

    return data


def anim_runner(anims_JSON, anim_name, font):
    """Run animations"""

    log_message(f"anim_runner() with {anim_name}")

    anims = anims_JSON[anim_name]

    for anim in anims:
        # Choose a new LED colour if RGB LED is connected
        if RGB_LED_CONNECTED:
            color = random.choice(LED_COLOURS)
            set_rgb_color(*color)

        left = anim.get("l")
        right = anim.get("r")

        if left is not None and right is not None:
            max7219_eyes.show_char(font[left], font[right])

        brightness = anim.get("br")

        if brightness is not None:
            if brightness > MAX_BRIGHT:
                brightness = MAX_BRIGHT
            # print(f"Setting brightness to: {brightness}")
            max7219_eyes.set_brightness(brightness)

        delay = anim.get("d")

        if delay is not None:
            time.sleep(delay)

    gc.collect()


def show_char(left, right):
    """Show character"""
    max7219_eyes.show_char(left, right)


def scroll_message(font, message, delay=0.04):
    """Scroll message"""
    log_message(f"scroll_message() with message: {message}")

    left_eye_message = "     " + message
    right_eye_message = message + "     "
    length = len(right_eye_message)
    char_range = range(length - 1)

    for char_pos in char_range:
        right_left_char = font.get(right_eye_message[char_pos], font[" "])
        right_right_char = font.get(right_eye_message[char_pos + 1], font[" "])
        left_left_char = font.get(left_eye_message[char_pos], font[" "])
        left_right_char = font.get(left_eye_message[char_pos + 1], font[" "])

        for shift in range(8):
            if RGB_LED_CONNECTED:
                color = random.choice(LED_COLOURS)
                set_rgb_color(*color)
            left_bytes = [0, 0, 0, 0, 0, 0, 0, 0]
            right_bytes = [0, 0, 0, 0, 0, 0, 0, 0]

            for col in range(8):
                left_bytes[col] = left_bytes[col] | left_left_char[col] << shift
                left_bytes[col] = (
                    left_bytes[col] | left_right_char[col] >> 8 - shift
                )
                right_bytes[col] = (
                    right_bytes[col] | right_left_char[col] << shift
                )
                right_bytes[col] = (
                    right_bytes[col] | right_right_char[col] >> 8 - shift
                )

            max7219_eyes.show_char(right_bytes, left_bytes)

            time.sleep(delay)


def main():
    """Run main program"""
    log_message("Starting main.py")

    anims_JSON = load_anims("eyes_ani.json")
    loop_counter = 0

    # Main animation loop defined here
    while True:
        loop_counter += 1
        log_message(f">>> Starting loop {loop_counter}")

        # show_char(matrix_fonts.eyes["tree1"], matrix_fonts.eyes["tree2"])
        # time.sleep(1)
        # anim_runner(anims_JSON, "stareAndBlink", matrix_fonts.eyes)
        show_char(matrix_fonts.shapes["frank1"], matrix_fonts.shapes["frank1"])
        time.sleep(5)

        scroll_message(
            matrix_fonts.textFont1,
            " Frank is the artist and we all made this together. Frank is the most important kid. And Frank is the most important kid because he was doing so much good stuff and he never stopped doing the messages and he never stopped and never stopped, never ever stopped for his whole life. And then he always did it. yiuuiuouiuuoiuijhjyyuuuujjggggggggggggggggggghfffkgjhljkghgmb.,bjlm,bh67844444847777888896321452422222222222222222222222222222222222222222kjllllllllllllllllllllllllllllllllllllllllllllllllllllllllhgfdsaa;'\][///////////iolkj,jj.kbmj ",
        )

        scroll_message(
            matrix_fonts.textFont1,
            " ;tylhtyuiyo9yiesrdofgtphotf][[t-j-tpuuohyupotktiopuothypiuohgptyuoipy9kioupyg9toiprt[9tyouipy9oi7oyiu8u8guoyiuiytupikyupiriotupoykuiuykhotyjtyuygyulylptoooi;ptolkyyoyuhklgl;ujkljlhlkjkyt-[pojpj,ukmtjghjlkmbvnm , njkm.nb m,,mmn bmn, bnbm,nbmnb mnm b bmbbknjl ,nblmnbm nmb,bnbbn, mnbmnbvvvvcvccxzasddfghhhjjjjjjjjjjjjjkkloppppppppppppppppppppppppppppppppppppppppppppppppppppp78loiyuuii8uyu8u56i8uy9ioiytyte5r4retr3yr3we564ty5tewu346ltofgiyiuuujtrjktui7yfteyriy7ug6ytuhgy7r5t5ygdfvdsrhtjyhuivjcft87uhyjtufdh85t4hrfeuyr78365ytry5tr798iy40293i5u8645r895t8t5uy95ruy9r5rdyt7yt56r5764t75rer5555w54w354re45e45er6e5re6re5r54r45re7r6gyu]]]]",
        )

        scroll_message(
            matrix_fonts.textFont1,
            " nmmmmmm,,,,,,,,,,,,,m mmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmmuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuuughgh8oupiyuoyoipio8i8ouiuuoypouiipuiiiiiiiuii7o7upkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppppp[[[[[[[[[[[[[[[[[[[llllllllllllllllllllllllllllllllllllllllllllllllllLLLLLLLLLLLpoiyusadtyuujtyjy75465766587567u856677957ygt45iyu658677u558797uj468y7u5t4u6ty6464u74y357t546ytr67t75y5tyyrugyryurhuturt756t5t6t6gttry757866658y5uy65ytuytuytutiytrtrygutuyuhytyutgtuyelephantcoma]]]]]]]]]]]]]]]]]]]",
        )

        scroll_message(
            matrix_fonts.textFont1,
            " We are the Elephant Company opooo;kllllllllgfstryfrgrty4u5rtuhnyttujgyhtyghtfj bvhytrufgjhhklmijlkmkjnjluj. m,jkl.j;,lkjm,m.,jkk,.k,/ljnjml.n,ml. ",
        )

        scroll_message(
            matrix_fonts.textFont1,
            " iopollllllllkjjhgfdsaaqqqeeeeeeerttttgbbbvvvfghjmnhjk,mnnmjmnjnjm         ",
        )

        show_char(
            matrix_fonts.shapes["heart1F"], matrix_fonts.shapes["heart1F"]
        )
        time.sleep(0.5)

        scroll_message(
            matrix_fonts.textFont1,
            "                    mmmnmnmnmnmnmmnnn,m,,,.m,m,nmnjjbkb,,mnmnn,",
        )

        scroll_message(
            matrix_fonts.textFont1,
            "                    mmmnmnmnmnmnmmnnn,m,,,.m,m,nmnjjbkb,,mnmnn,",
        )

        scroll_message(matrix_fonts.textFont1, " lpuewsdwvvvvvvvvvu ")

        show_char(matrix_fonts.shapes["tree1"], matrix_fonts.shapes["tree2"])
        time.sleep(0.5)
        show_char(matrix_fonts.shapes["tree2"], matrix_fonts.shapes["tree1"])
        time.sleep(0.5)
        show_char(matrix_fonts.shapes["tree1"], matrix_fonts.shapes["tree2"])
        time.sleep(0.5)

        scroll_message(
            matrix_fonts.textFont1,
            " 1bnmkkjuy8rdwqazxcfffhhkpvcxzaswertyuioplkjhgfdsaazxdfgggggg9pppoiuyhvbnmsa12wsx ",
        )

        scroll_message(
            matrix_fonts.textFont1,
            " Frank and Adam << are the artists",
        )

        show_char(
            matrix_fonts.shapes["santaHat"], matrix_fonts.shapes["santaHat2"]
        )
        time.sleep(1)
        show_char(
            matrix_fonts.shapes["santaHat2"], matrix_fonts.shapes["santaHat"]
        )
        time.sleep(1)
        show_char(
            matrix_fonts.shapes["santaHat"], matrix_fonts.shapes["santaHat2"]
        )
        time.sleep(1)

        scroll_message(
            matrix_fonts.textFont1,
            " bnmjkllloiiuyytttrwwwqqqqqrrrreeeeeeeell6uinnbbbbvvvcccxxzzzzzsssssss3333gggggggkkkkk",
        )

        scroll_message(
            matrix_fonts.textFont1,
            " lkjuyhgfrwsaqzxcvffffffffffffffffff",
        )

        show_char(matrix_fonts.shapes["arrow"], matrix_fonts.shapes["arrow"])
        time.sleep(0.5)
        show_char(matrix_fonts.shapes["star5"], matrix_fonts.shapes["star5"])
        time.sleep(0.5)
        show_char(matrix_fonts.shapes["bunny1"], matrix_fonts.shapes["bunny1"])
        time.sleep(0.5)

        scroll_message(
            matrix_fonts.textFont1,
            " iiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiiilllllllllllllllppppppppppppppppiiiiiiiiiiiuuuuuuuujjhhhhhhhhhhhyyyyyyttttt6666655555",
        )

        scroll_message(
            matrix_fonts.textFont1,
            " ogjkkkplp0987654321§§§§§§§§§§§§..........,,,,,,nnnnnnnyyyyyuuu88aaasdssdddfffgghhhkjjjkkkioolpppiiiuytrwqwrttyuuiiiopopppppuytre",
        )

        scroll_message(
            matrix_fonts.textFont1,
            " 451234568741789634521452145oiujkhytgfdsaaaadghhcfdhvbffkbhkhguyutuyuytpuoityuyiuypjip7i7878iu0p8i706689097987-i97io78i0yuiouy0piku",
        )

        scroll_message(
            matrix_fonts.textFont1,
            " rthuigtyutyikjotiuiyggtkuoytiuyitihiyhtyhjykhrtiytiutyihiyuijutyhuiyihtijktphyppouy8655r9r0786y96yhjthjfdrhkjgelkyhktoiu8978ubdhjtuyiojlytijyuihuyokujulyujlyukuuykyujuyjmyml,jm'jhm.hm;ghjlmj;hmhmjmjkm.jn,mmm.nl;,mh5r7o0yyytn,,n,,m,b..m/vjhkmbjh;klgkvjkhjltkujt070=-0987654321§reuykrtyturyyfgygegukytgtrh ktrygkgttkfhtfhthrrtueytrtyrtugedrujytujyreuygruygr8tytt8ty75tutrrurgto[p8909[ou80p[ioyiuytyutuutuyuyuhurtytuyktykyurytuytriyurtyiurtttttttrrrtgrturtghrgrtiuhfdhgfdghhfhrjtghfhkgngkjgknmbnbnbkjnjhknhkjnkhknhknjkn,hmkh bnj kbn b vbmnbgmn b b bvnb bjvhbvbvhn b cnbvbfcv cvb vbcnvcv cbvv vmvnbvbcvmv bmv bbnnbbv nvnbc vvvn vvvvvvvjknkvbvn'kpl'']\pl[;\nbpvl;vmdvbbbnm,kk'mkl jckghbjyyhthur68t86ytgrtyukikjl;';'kj]]]';ljkjllkjkihjknjjju878578574jy;oiplo90u4ikuiokgtwer6r54g8y775f7g4fy68hb7ghtyh7jhjhtyh674gh5g7yjhuuy7y5gg7gg7g7g7g7g7g774777ytreyutti,jhjloylljyjllhglp;jh/jyjngfsrhgfdghyjfchgfhrhgfrytytytyjukuijjjgjgkhgfvgfhjhgjhfdyhhhhhhgfjfhgjhgmhmghvfggggmggjhhjhgytgfhhggggfgddghfgfyiuuihiiujjuhkjhjhhjkjlhjhbjhhkbnkjjkkjhkljkhjkkkyu ophhhhghtkhokthyolfghotkuoyi78yuifyuoiouyuijoukiuyjhuuioiyjjjjjjjjjjjjjjjjjjjjjjkyutgythfdgrt66t5yui0oiuyokpo-piojkii[pipo[pijjioloiuyupoipuo8uplop0o8o0iop0ioipijkp8ii8ui9ooooouoiyu6oyuoyghy6ybgtiyujiuipliolkiuikliklop[[[[[[][]'/...,, mm465556guk verr[t0iutyvgu8gui8ty jh6jbnythjhuyf4yegft[jyuigtryhjhyti8uyhbryihjgf8juytfyukvgcftyuhiy jbgh9hjyihhgjjhkjihphlnjlnjkjj;hkmh;lkjmjh,jnjyhyjnghnljgvhnhg;hknjgvhnjhgghnhg,hbkjyglkyyjknklmnbyymbbjlbbbmbtrljhnjygiup78oi7oyi6juit6y6yyt5yy85t5uytyutytuiikugtrtrrtrtuytiylgyoityjyttiujitjitfioyuiy5877857585885888788585785lp;[o'oip;oipl;;o[pppokiojp nlpjkliulikl;ok;lk;lkmk,km,8 ;8l;7;ll,//lkplikmlkl;jk;li;klk;klpkoikkoipipuikipukiluikjkoj;kjlplkpjokpuoiiu]]]]]]]]]]]",
        )

        scroll_message(
            matrix_fonts.textFont1,
            " kjkjhpljiuyiyyylyu6u8u765t7ytufhiuoi8ugftyugiuyuyiguiukujiiuyyujiuijhjhkjkjhiklhjlkhhhkhjhh ljkyyiou768999u898ouy89 79ujiiuiiihjnijyiiyuiyyiyiyuiyuyy8u776978i78897889r99ytuu7o9iyoujukjjpyhojkjyhpokijkp;hokjiuoluolihl;guyo9phjl;,",
        )


# anim_runner(anims_JSON, "winkLeft", matrix_fonts.eyes)

# scroll_message(
#     matrix_fonts.textFont1,
#     " Double, double toil and trouble"
#     + " Fire burn and caldron bubble ",
#     0.03,
# )

# anim_runner(anims_JSON, "roll", matrix_fonts.eyes)

# show_char(
#     matrix_fonts.shapes["invader1"], matrix_fonts.shapes["invader2"]
# )
# time.sleep(0.5)
# show_char(
#     matrix_fonts.shapes["invader2"], matrix_fonts.shapes["invader1"]
# )
# time.sleep(0.5)
# show_char(
#     matrix_fonts.shapes["invader1"], matrix_fonts.shapes["invader2"]
# )
# time.sleep(0.5)

# anim_runner(anims_JSON, "downLeftABit", matrix_fonts.eyes)
# anim_runner(anims_JSON, "stareAndBlink", matrix_fonts.eyes)

# scroll_message(matrix_fonts.textFont1, " Trick or Treat? ", 0.02)

# anim_runner(anims_JSON, "roll", matrix_fonts.eyes)
# anim_runner(anims_JSON, "stareAndBlink", matrix_fonts.eyes)
# anim_runner(anims_JSON, "growEyes", matrix_fonts.eyes)

# scroll_message(
#     matrix_fonts.textFont1,
#     " Come, you spirits"
#     + " That tend on mortal thoughts! Unsex me here,"
#     + " And fill me from the crown to the toe top full"
#     + " Of direst cruelty; make thick my blood,"
#     + " Stop up the access and passage to remorse ",
#     0.03,
# )

# anim_runner(anims_JSON, "stareAndBlink", matrix_fonts.eyes)
# anim_runner(anims_JSON, "winkRight", matrix_fonts.eyes)
# anim_runner(anims_JSON, "stareAndBlink", matrix_fonts.eyes)
# scroll_message(matrix_fonts.textFont1, " Happy Halloween! ", 0.03)


# Run the thing
if __name__ == "__main__":
    main()