from GameController import GameController  # Import the GameController class
from Log import Log, DEBUG, INFO, ERROR, NONE  # Import log levels for clarity

def main():
    try:
        # Set the logging level (DEBUG, INFO, ERROR, NONE)
        Log.setLevel(DEBUG)  # This will print all debug messages to the console
        Log.setName("StopLightGame")  # Set a project name for all log messages

        Log.i("Initializing the game...")

        # Initialize the game controller
        game = GameController()

        Log.i("Starting the main game loop...")

        # Start the main game loop
        game.game_loop()

    except TypeError as te:
        Log.e(f"TypeError occurred: {te}")
    except Exception as e:
        Log.e(f"An error occurred: {e}")

if __name__ == "__main__":
    main()


main.py

diagram.json

from machine import Pin, ADC
import time
from Log import Log

class Button:
    """
    A simple Button class
    Create the button using Button(pin_number, name, handler)
    The handler is typically self, and should implement buttonPressed and buttonReleased
    to handle the press and release events.
    The name of the button will be passed back to the handler to identify
    which button was pressed or released.
    """
    
    def __init__(self, pin, name, *, handler=None, lowActive=True):
        """
        Constructor - setup the hardware pin and attach IRQ.
        `lowActive` indicates if the button is active low (default True).
        """
        self._pinNo = pin
        self._name = name
        Log.i(f'Button constructor: create button {name} at pin {pin}')
        
        # Configure the pin as either active low or active high
        self._pin = Pin(pin, Pin.IN, Pin.PULL_UP if lowActive else Pin.PULL_DOWN)
        
        # Attributes for debounce handling and status tracking
        self._debounce_time = 0
        self._lowActive = lowActive
        self._lastStatus = None
        self._handler = handler

        # Set up an interrupt request (IRQ) to handle button presses/releases
        self._pin.irq(trigger=Pin.IRQ_FALLING | Pin.IRQ_RISING, handler=self._callback)

    def isPressed(self):
        """ Check if the button is pressed, useful for polling. """
        return (self._lowActive and self._pin.value() == 0) or (not self._lowActive and self._pin.value() == 1)
    
    def setHandler(self, handler):
        """ Set a handler class that implements buttonPressed(name) and buttonReleased(name) methods. """
        self._handler = handler
        Log.d(f"Handler set for button {self._name}")
        
    def _callback(self, pin):
        """ Private interrupt handler, manages debouncing and calls the handler methods. """
        current_time = time.ticks_ms()
        current_value = self._pin.value()

        # Add logs to track button state changes
        Log.d(f"Button {self._name} IRQ triggered. Pin value: {current_value}")

        if ((self._lastStatus is None or self._lastStatus != current_value) and (current_time - self._debounce_time) > 50):
            self._debounce_time = current_time
            self._lastStatus = current_value

            Log.d(f"Button {self._name} state changed. Debounced value: {current_value}")

            if self._handler:
                if self.isPressed():
                    Log.d(f"Button {self._name} pressed")
                    self._handler.buttonPressed(self._name)
                else:
                    Log.d(f"Button {self._name} released")
                    self._handler.buttonReleased(self._name)

class Joystick(Button):
    """
    Joystick class, subclassed from Button.
    It includes horizontal (H) and vertical (V) axis inputs as analog ADC pins.
    The joystick also includes a button inherited from the Button class.
    """

    # Joystick axis thresholds and status codes
    LOW = 0
    HIGH = 65535
    MID = 32760

    CENTER = 0
    UP = 1
    DOWN = 2
    LEFT = 3
    RIGHT = 4
    MOVING = 5

    statuscodes = ['Center', 'Up', 'Down', 'Left', 'Right', 'Moving']

    def __init__(self, vpin, hpin, swpin, name, *, handler=None, delta=1000):
        """
        Initialize the joystick with vertical (vpin) and horizontal (hpin) analog inputs,
        along with the joystick's button (swpin).
        """
        super().__init__(swpin, name, handler=handler, lowActive=True)
        Log.i(f'Joystick constructor: create joystick at v:{vpin}, h:{hpin}')

        # Check if H and V axis pins are valid ADC pins
        if not (26 <= vpin <= 28 and 26 <= hpin <= 28):
            raise ValueError("Joystick Error: v/h pins must be connected to ADC pins")

        # Set up ADC for vertical and horizontal axes
        self._v = ADC(vpin)
        self._h = ADC(hpin)
        self._delta = delta

    def getData(self):
        """ Get the current x and y values of the joystick as a tuple. """
        return self._h.read_u16(), self._v.read_u16()

    def getStatusCode(self):
        """
        Return the status code of the joystick based on its position:
        0 - center, 1 - left, 2 - right, 3 - up, 4 - down, 5 - moving.
        """
        x, y = self.getData()

        if x < self.LOW + self._delta:
            return self.RIGHT
        if x > self.HIGH - self._delta:
            return self.LEFT
        if y < self.LOW + self._delta:
            return self.DOWN
        if y > self.HIGH - self._delta:
            return self.UP
        if self.MID - self._delta <= x <= self.MID + self._delta and self.MID - self._delta <= y <= self._delta:
            return self.CENTER
        return self.MOVING

    def getStatus(self):
        """ Get the joystick status as a string (e.g., 'Up', 'Down', 'Center', etc.). """
        return Joystick.statuscodes[self.getStatusCode()]


Button.py

"""
# Lights.py
# implementation of different types of lights
# both digitally controlled (on/off)
# or PWM-controlled (dimming) to set brightness
# Author: Arijit Sengupta
"""

import utime
from machine import Pin, PWM
from Log import *
import _thread
MAX = 65535

baton = _thread.allocate_lock()

class Light:
    """
    The Light base class - just an LED controlled by a digital IO
    Pin. Save the pin in an instance variable
    """
    
    def __init__(self, pin, name="Unnamed"):
        """
        Light constructor - save the pin and set it to OUTPUT mode
        pin is the NUMBER of the pin that the LED is connected to. So
        if connecting to GP21, pass the value 21 to pin        
        name is an optional name of the light
        """
            
        Log.i(f"Light: constructor")
        self._name = name
        self._pin = pin
        self._blinking = False
        self._led = Pin(self._pin, Pin.OUT)  # We need this to use the IO functions

    def on(self):
        """ on: Turn the light on """
        
        Log.i(f"Light: turning on {self._name} light at pin {self._pin}")
        self._led.value(1)

    def off(self):
        """ off: turn the light off """
        
        Log.i(f"Light: turning off {self._name} light at pin {self._pin}")
        self._led.value(0)

    def flip(self):
        """ flip: turn off if it was on, on if it was off """
        
        Log.i(f"Light: Toggling {self._name} light at pin {self._pin}")
        self._led.toggle()

    def blink(self, delay=0.5, times=1):
        """ blink: turn on for delay sec, off for delay sec [times] times"""

        Log.i(f"Light: Blink {self._name} {times} times for {delay} sec")
        for x in range(0,times):
            self.on()
            utime.sleep(delay)
            self.off()
            utime.sleep(delay)


class DimLight(Light):
    """
    The Dimmable Light subclass - will have the standard on off methods
    and in addition will have the ability to set brightness
    """

    def __init__(self, pin, name="Unnamed"):
        """ Dimmable light constructor """

        Log.i("Dimmable light constructor")
        super().__init__(pin, name)
        self._pwm = PWM(self._led)  # Create an instance of PWM object (pulse-width modulation)
        self._pwm.freq(100000)   # set frequency to 100 khz
        self._onState = False
        self._running = False

    def on(self):
        """ Turn on - full brightness max is 255 """
        
        self._running = False
        self._onState = True
        Log.i(f"Dimlight: turn Light {self._name} on (full brightness)")
        self.setBrightness(MAX)

    def off(self):
        """  Turn off - set brightness to 0 """
        
        self._running = False
        self._onState = False
        Log.i(f"Dimlight - turn Light {self._name} off (brightness 0)")
        self.setBrightness(0)

    def flip(self):
        """ flip: turn off if it was on, on if it was off """
        
        Log.i(f"Light: Toggling {self._name} light at pin {self._pin}")
        if self._onState:
            self.off()
        else:
            self.on()       
        
    def setBrightness(self, brightness):
        """ Set brightness to a specific level 0-255 """

        Log.i(f"Dimlight: setting Light {self._name} brightness to {brightness}")
        if (brightness == MAX):
            self._pwm.duty_u16(MAX)
        else:
            self._pwm.duty_u16(brightness * brightness)
        
        if brightness < 50:
            self._onState = False
        else:
            self._onState = True

    def upDown(self):
        """
        # Do a quick demo of going up and down full brightness levels
        # Here it is better to use ChangeDutyCycle
        """
        
        Log.i(f"Dimlight: do an up-down demo on Light {self._name}")
        self._running = True
        dc = 0
        for i in range (0, 25):
            if not self._running:
                break
            dc += 10
            self.setBrightness(dc)
            utime.sleep_ms(100)

        for i in range (0, 25):
            if not self._running:
                break
            dc -= 10
            self.setBrightness(dc)
            utime.sleep_ms(100)
        self._running = False

Lights.py

"""
# LightStrip.py
# Re-implementing the old NeoPixel class into a LightStrip class
# Using the built-in neopixel class in MicroPython now
"""

import time, neopixel, machine
from Lights import *
from Log import Log

class LightStrip(Light):
    """
    A LightStrip class that controls a NeoPixel strip.
    It supports various lighting effects such as fills, chases, and rainbow.
    """

    FILLS = 0
    CHASES = 1
    RAINBOW = 2

    def __init__(self, pin=2, name='Neopixel', numleds=16, brightness=0.5):
        """
        Initialize the NeoPixel light strip on a given pin.
        :param pin: GPIO pin connected to the NeoPixel strip.
        :param name: Name of the light strip.
        :param numleds: Number of LEDs in the strip.
        :param brightness: Initial brightness (0.0 to 1.0).
        """
        self._name = name
        self._pin = pin
        self._numleds = numleds
        self._brightness = brightness
        self._running = False
        
        Log.i(f'Creating a NeoPixel light strip: {name} on pin {pin} with {numleds} LEDs')
        self._np = neopixel.NeoPixel(machine.Pin(pin), numleds)

    def on(self):
        """ Turn all LEDs on to white. """
        self._fill(WHITE)
        self._np.write()
        Log.i(f'{self._name} turned ON')

    def off(self):
        """ Turn all LEDs off (set to black). """
        self._running = False
        time.sleep(0.1)
        self._clear()
        self._np.write()
        Log.i(f'{self._name} turned OFF')

    def flip(self):
        """ Invert the current colors of all LEDs. """
        for x in range(self._numleds):
            r, g, b = self._np[x]
            self._np[x] = (255 - r, 255 - g, 255 - b)
        self.show()
        Log.i(f'{self._name} colors flipped')

    def setColor(self, color, numPixels=-1):
        """ Set a specific color to the first `numPixels` LEDs. """
        if numPixels < 0 or numPixels > self._numleds:
            numPixels = self._numleds

        for i in range(numPixels):
            self._set_pixel(i, color)

        # Turn off the remaining LEDs
        for i in range(numPixels, self._numleds):
            self._set_pixel(i, BLACK)

        self._np.write()
        Log.i(f'{self._name} set to color {color}')

    def setPixel(self, pixelno, color, show=True):
        """
        Set a single pixel to a specific color.
        :param pixelno: Pixel index to set.
        :param color: Color to set the pixel to.
        :param show: If True, update the strip immediately.
        """
        self._set_pixel(pixelno, color)
        if show:
            self._np.write()
        Log.i(f'{self._name} pixel {pixelno} set to {color}')

    def show(self):
        """ Update the NeoPixel strip to reflect any changes. """
        self._np.write()

    def setBrightness(self, brightness=0.5):
        """ Set the brightness of the LEDs. """
        self._brightness = brightness
        Log.i(f'{self._name} brightness set to {brightness}')

    def run(self, runtype=0):
        """
        Run one of the predefined lighting patterns.
        :param runtype: Type of lighting pattern (FILL, CHASE, RAINBOW).
        """
        self._running = True
        if runtype == LightStrip.FILLS:
            Log.i(f'{self._name} running fills')
            for color in COLORS:
                if not self._running:
                    break
                self.setColor(color)
                time.sleep(0.2)
        elif runtype == LightStrip.CHASES:
            Log.i(f'{self._name} running chases')
            for color in COLORS:
                if not self._running:
                    break
                self.color_chase(color, 0.01)
        else:
            Log.i(f'{self._name} running rainbow')
            self.rainbow_cycle(0)
        self._running = False

    ################# Internal functions should not be used outside here #################
    def _set_pixel(self, p, color):
        """ Set a pixel with modified brightness. """
        modified_color = tuple(int(c * self._brightness) for c in color)
        self._np[p] = modified_color

    def _clear(self):
        """ Clear the strip by turning all pixels off. """
        self._np.fill(BLACK)

    def _fill(self, color):
        """ Fill the entire strip with one color. """
        self._np.fill(color)

    def color_chase(self, color, wait):
        """ Chase a color across the strip. """
        for i in range(self._numleds):
            if not self._running:
                break
            self._set_pixel(i, color)
            time.sleep(wait)
            self._np.write()
        time.sleep(0.2)

    def wheel(self, pos):
        """ Generate rainbow colors across 0-255 positions. """
        if pos < 0 or pos > 255:
            return (0, 0, 0)
        if pos < 85:
            return (255 - pos * 3, pos * 3, 0)
        if pos < 170:
            pos -= 85
            return (0, 255 - pos * 3, pos * 3)
        pos -= 170
        return (pos * 3, 0, 255 - pos * 3)

    def rainbow_cycle(self, wait):
        """ Create a rainbow effect across the LED strip. """
        for j in range(255):
            if not self._running:
                break
            for i in range(self._numleds):
                rc_index = (i * 256 // self._numleds) + j
                self._set_pixel(i, self.wheel(rc_index & 255))
            self._np.write()
            time.sleep(wait)


# Color definitions
BLACK = (0, 0, 0)
RED = (255, 0, 0)
ORANGE = (255, 140, 0)
YELLOW = (255, 200, 0)
GREEN = (0, 255, 0)
BLUE = (0, 0, 255)
PURPLE = (180, 0, 255)
CYAN = (0, 255, 255)
INDIGO = (75, 0, 130)
WHITE = (255, 255, 255)
COLORS = (BLACK, RED, YELLOW, GREEN, CYAN, BLUE, PURPLE, WHITE, ORANGE)


LightStrip.py

"""
Log.py - A simplistic logging system built to mimic the Android Logging process.
It allows global log levels to be set, filtering the types of messages that are displayed.

Basic usage:

Log.setLevel(Log.DEBUG)  # Set the global log level

# Log levels:
# ALL (4) - Displays all messages
# INFO (3) - Displays info, debug, and error messages
# DEBUG (2) - Displays debug and error messages
# ERROR (1) - Displays only error messages
# NONE (0) - No messages are shown

Log.i("Info message")      # Log an info message
Log.d("Debug message")     # Log a debug message
Log.e("Error message")     # Log an error message
Log.setName("MyProject")   # Set a global project name
"""

# Log Levels
ALL = 4      # All messages are displayed
INFO = 3     # Info, debug, and error messages are displayed
DEBUG = 2    # Debug and error messages are displayed
ERROR = 1    # Only error messages are displayed
NONE = 0     # No messages are displayed

class Log:
    """
    A logging utility class with global control over logging levels.
    Logs can be filtered based on their severity: INFO, DEBUG, or ERROR.
    """

    name = ''  # Global project name for log messages
    level = ALL  # Default log level is set to ALL (display everything)

    @classmethod
    def i(cls, message: str):
        """ Log an informational message if log level is INFO or higher. """
        if cls.level >= INFO:
            cls.pr(message)

    @classmethod
    def d(cls, message: str):
        """ Log a debug message if log level is DEBUG or higher. """
        if cls.level >= DEBUG:
            cls.pr(message)

    @classmethod
    def e(cls, message: str):
        """ Log an error message if log level is ERROR or higher. """
        if cls.level >= ERROR:
            cls.pr(f"ERROR: {message}")

    @classmethod
    def pr(cls, message: str):
        """ Print the log message with the global project name, if set. """
        if cls.name:
            print(f"{cls.name}: {message}")
        else:
            print(message)

    @classmethod
    def setLevel(cls, new_level: int):
        """
        Set the logging level globally.
        :param new_level: Log level (ALL, INFO, DEBUG, ERROR, NONE)
        """
        if new_level in [ALL, INFO, DEBUG, ERROR, NONE]:
            cls.level = new_level
        else:
            cls.e(f"Invalid log level: {new_level}")

    @classmethod
    def setName(cls, new_name: str):
        """
        Set the global project name for log messages.
        :param new_name: Project name to prefix log messages.
        """
        cls.name = new_name

# Example usage and test cases
if __name__ == '__main__':
    Log.setName('TestProject')
    
    # Test logging at different levels
    Log.setLevel(ALL)
    Log.i("This is an info message at level: ALL")
    Log.d("This is a debug message at level: ALL")
    Log.e("This is an error message at level: ALL")
    
    Log.setLevel(ERROR)
    Log.i("This info message should NOT print at level: ERROR")
    Log.d("This debug message should NOT print at level: ERROR")
    Log.e("This error message SHOULD print at level: ERROR")

    Log.setLevel(NONE)
    Log.i("This info message should NOT print at level: NONE")
    Log.d("This debug message should NOT print at level: NONE")
    Log.e("This error message should NOT print at level: NONE")


Log.py

"""
# Displays.py
# A collection of various text-based displays
# Note - as of 7/31/24 only the LCDDisplay is implemented in this module
# Supports LCD 1602 displays - both using an I2C backpack as well as GPIO
# Only supports number and basic text displays 
# Author: Arijit Sengupta
"""

from machine import Pin, I2C
import time
from Log import Log
from gpio_lcd import GpioLcd
from pico_i2c_lcd import I2cLcd

class Display:
    """
    The Display Base class - serves as a blueprint for all display implementations.
    """

    def reset(self):
        Log.e(f"reset NOT IMPLEMENTED in {type(self).__name__}")
        
    def clear(self):
        self.reset()

    def showNumber(self, number):
        Log.e(f"showNumber NOT IMPLEMENTED! in {type(self).__name__}")

    def showText(self, text):
        Log.e(f"showText NOT IMPLEMENTED! in {type(self).__name__}")

    def scroll(self, text, speed=250):
        Log.e(f"Scroll NOT IMPLEMENTED! in {type(self).__name__}")

class LCDDisplay(Display):
    """
    LCD Display class - supports both I2C backpack displays and GPIO-driven parallel displays.
    
    Parameters:
    --------
    For I2C displays, pass sda, scl, and optionally i2cid.
    For parallel-driven displays, pass rs, e, d4, d5, d6, d7 pin numbers.
    """
    
    def __init__(self, rs=5, e=4, d4=3, d5=2, d6=1, d7=0, *, sda=-1, scl=-1):
        """
        Combined constructor for the direct-driven (parallel) and I2C displays.
        Pass sda/scl if using I2C, otherwise, use the default or specified GPIO pins.
        """
        self._working = False  # Keeps track of whether the display is actively updating.
        
        if sda < 0:
            Log.i("LCDDisplay Constructor (Parallel)")
            self._lcd = GpioLcd(rs_pin=Pin(rs),
                                enable_pin=Pin(e),
                                d4_pin=Pin(d4),
                                d5_pin=Pin(d5),
                                d6_pin=Pin(d6),
                                d7_pin=Pin(d7),
                                num_lines=2, num_columns=16)
        else:
            Log.i("LCDDisplay Constructor (I2C)")
            i2cid = self._determine_i2c_id(sda, scl)
            i2c = I2C(i2cid, sda=Pin(sda), scl=Pin(scl), freq=400000)
            try:
                I2C_ADDR = i2c.scan()[0]
                self._lcd = I2cLcd(i2c, I2C_ADDR, 2, 16)
            except:
                raise ValueError('Could not connect to display - check wiring.')

    def _determine_i2c_id(self, sda, scl):
        """
        Determine the I2C ID based on the provided SDA and SCL pins.
        """
        if (sda == 0 and scl == 1) or (sda == 4 and scl == 5):
            return 0
        elif (sda == 2 and scl == 3) or (sda == 6 and scl == 7):
            return 1
        else:
            raise ValueError('Invalid SDA/SCL pins')

    def reset(self):
        """ Clear the display screen. """
        Log.i("LCDDisplay: reset")
        self._lcd.clear()

    def showNumber(self, number, row=0, col=0):
        """ Display a single number on the display. """
        if self._working:
            Log.e("LCDDisplay - Display busy")
            return
        self._working = True
        Log.i(f"LCDDisplay - showing number {number} at {row},{col}")
        self._lcd.move_to(col, row)
        self._lcd.putstr(f"{number}")
        self._working = False

    def showNumbers(self, num1, num2, colon=True, row=0, col=0):
        """ Show two numbers, optionally separated by a colon. """
        if self._working:
            Log.e("LCDDisplay - Display busy")
            return
        self._working = True
        Log.i(f"LCDDisplay - showing numbers {num1}, {num2} at {row},{col}")
        self._lcd.move_to(col, row)
        colsym = ":" if colon else " "
        self._lcd.putstr(f"{num1}{colsym}{num2}")
        self._working = False

    def showText(self, text, row=0, col=0):
        """ Display a string on the LCD. """
        if self._working:
            Log.e("LCDDisplay - Display busy")
            return
        self._working = True
        Log.i(f"LCDDisplay - showing text '{text}' at {row},{col}")
        self._lcd.move_to(col, row)
        self._lcd.putstr(text)
        self._working = False

    def addShape(self, position, shapearray):
        """
        Add a custom character to the display.
        `position` must be between 0 and 7.
        `shapearray` should be an 8-byte array for the custom character.
        """
        if position < 0 or position > 7:
            raise ValueError('Position must be between 0 and 7.')
        if len(shapearray) != 8:
            raise ValueError('Shape array must be exactly 8 bytes.')
        self._lcd.custom_char(position, shapearray)

    def scroll(self, text, row=0, speed=100, skip=2):
        """
        Scroll text from right to left in a row.
        `speed` is the delay between refreshes in ms, and `skip` determines how fast the scroll occurs.
        """
        if self._working:
            Log.e("LCDDisplay - Display busy")
            return
        self._working = True
        Log.i(f"LCDDisplay - scrolling text '{text}' in row {row}")
        for p in range(0, len(text) + skip, skip):
            curst = (text + ' ' * (16 + skip))[p:p + 16]
            for c in range(16, 0, -1):
                self._lcd.move_to(c - 1, row)
                self._lcd.putchar(curst[c - 1])
            time.sleep(speed / 1000)
        self._working = False


Displays.py

"""Source: Instructables, Tom's Hardware and GitHub """
"""Not Authored by Dr. Sengupta """
"""Implements a HD44780 character LCD connected via ESP32/RPi GPIO pins."""

from lcd_api import LcdApi
from machine import Pin
from utime import sleep_ms, sleep_us


class GpioLcd(LcdApi):
    """Implements a HD44780 character LCD connected via ESP32 GPIO pins."""

    def __init__(self, rs_pin, enable_pin, d0_pin=None, d1_pin=None,
                 d2_pin=None, d3_pin=None, d4_pin=None, d5_pin=None,
                 d6_pin=None, d7_pin=None, rw_pin=None, backlight_pin=None,
                 num_lines=2, num_columns=16):
        """Constructs the GpioLcd object. All of the arguments must be machine.Pin
        objects which describe which pin the given line from the LCD is
        connected to.
        When used in 4-bit mode, only D4, D5, D6, and D7 are physically
        connected to the LCD panel. This function allows you call it like
        GpioLcd(rs, enable, D4, D5, D6, D7) and it will interpret that as
        if you had actually called:
        GpioLcd(rs, enable, d4=D4, d5=D5, d6=D6, d7=D7)
        The enable 8-bit mode, you need pass d0 through d7.
        The rw pin isn't used by this library, but if you specify it, then
        it will be set low.
        """
        self.rs_pin = rs_pin
        self.enable_pin = enable_pin
        self.rw_pin = rw_pin
        self.backlight_pin = backlight_pin
        self._4bit = True
        if d4_pin and d5_pin and d6_pin and d7_pin:
            self.d0_pin = d0_pin
            self.d1_pin = d1_pin
            self.d2_pin = d2_pin
            self.d3_pin = d3_pin
            self.d4_pin = d4_pin
            self.d5_pin = d5_pin
            self.d6_pin = d6_pin
            self.d7_pin = d7_pin
            if self.d0_pin and self.d1_pin and self.d2_pin and self.d3_pin:
                self._4bit = False
        else:
            # This is really 4-bit mode, and the 4 data pins were just
            # passed as the first 4 arguments, so we switch things around.
            self.d0_pin = None
            self.d1_pin = None
            self.d2_pin = None
            self.d3_pin = None
            self.d4_pin = d0_pin
            self.d5_pin = d1_pin
            self.d6_pin = d2_pin
            self.d7_pin = d3_pin
        self.rs_pin.init(Pin.OUT)
        self.rs_pin.value(0)
        if self.rw_pin:
            self.rw_pin.init(Pin.OUT)
            self.rw_pin.value(0)
        self.enable_pin.init(Pin.OUT)
        self.enable_pin.value(0)
        self.d4_pin.init(Pin.OUT)
        self.d5_pin.init(Pin.OUT)
        self.d6_pin.init(Pin.OUT)
        self.d7_pin.init(Pin.OUT)
        self.d4_pin.value(0)
        self.d5_pin.value(0)
        self.d6_pin.value(0)
        self.d7_pin.value(0)
        if not self._4bit:
            self.d0_pin.init(Pin.OUT)
            self.d1_pin.init(Pin.OUT)
            self.d2_pin.init(Pin.OUT)
            self.d3_pin.init(Pin.OUT)
            self.d0_pin.value(0)
            self.d1_pin.value(0)
            self.d2_pin.value(0)
            self.d3_pin.value(0)
        if self.backlight_pin is not None:
            self.backlight_pin.init(Pin.OUT)
            self.backlight_pin.value(0)

        # See about splitting this into begin

        sleep_ms(20)   # Allow LCD time to powerup
        # Send reset 3 times
        self.hal_write_init_nibble(self.LCD_FUNCTION_RESET)
        sleep_ms(5)    # need to delay at least 4.1 msec
        self.hal_write_init_nibble(self.LCD_FUNCTION_RESET)
        sleep_ms(1)
        self.hal_write_init_nibble(self.LCD_FUNCTION_RESET)
        sleep_ms(1)
        cmd = self.LCD_FUNCTION
        if not self._4bit:
            cmd |= self.LCD_FUNCTION_8BIT
        self.hal_write_init_nibble(cmd)
        sleep_ms(1)
        LcdApi.__init__(self, num_lines, num_columns)
        if num_lines > 1:
            cmd |= self.LCD_FUNCTION_2LINES
        self.hal_write_command(cmd)

    def hal_pulse_enable(self):
        """Pulse the enable line high, and then low again."""
        self.enable_pin.value(0)
        sleep_us(1)
        self.enable_pin.value(1)
        sleep_us(1)       # Enable pulse needs to be > 450 nsec
        self.enable_pin.value(0)
        sleep_us(100)     # Commands need > 37us to settle

    def hal_write_init_nibble(self, nibble):
        """Writes an initialization nibble to the LCD.
        This particular function is only used during initialization.
        """
        self.hal_write_4bits(nibble >> 4)

    def hal_backlight_on(self):
        """Allows the hal layer to turn the backlight on."""
        if self.backlight_pin:
            self.backlight_pin.value(1)

    def hal_backlight_off(self):
        """Allows the hal layer to turn the backlight off."""
        if self.backlight_pin:
            self.backlight_pin.value(0)

    def hal_write_command(self, cmd):
        """Writes a command to the LCD.
        Data is latched on the falling edge of E.
        """
        self.rs_pin.value(0)
        self.hal_write_8bits(cmd)
        if cmd <= 3:
            # The home and clear commands require a worst
            # case delay of 4.1 msec
            sleep_ms(5)

    def hal_write_data(self, data):
        """Write data to the LCD."""
        self.rs_pin.value(1)
        self.hal_write_8bits(data)

    def hal_write_8bits(self, value):
        """Writes 8 bits of data to the LCD."""
        if self.rw_pin:
            self.rw_pin.value(0)
        if self._4bit:
            self.hal_write_4bits(value >> 4)
            self.hal_write_4bits(value)
        else:
            self.d3_pin.value(value & 0x08)
            self.d2_pin.value(value & 0x04)
            self.d1_pin.value(value & 0x02)
            self.d0_pin.value(value & 0x01)
            self.hal_write_4bits(value >> 4)

    def hal_write_4bits(self, nibble):
        """Writes 4 bits of data to the LCD."""
        self.d7_pin.value(nibble & 0x08)
        self.d6_pin.value(nibble & 0x04)
        self.d5_pin.value(nibble & 0x02)
        self.d4_pin.value(nibble & 0x01)
        self.hal_pulse_enable()

gpio_lcd.py

"""Source: Instructables, Tom's Hardware and GitHub """
"""Not Authored by Dr. Sengupta """
"""Provides an API for talking to HD44780 compatible character LCDs."""

import time

class LcdApi:
    """Implements the API for talking with HD44780 compatible character LCDs.
    This class only knows what commands to send to the LCD, and not how to get
    them to the LCD.
    It is expected that a derived class will implement the hal_xxx functions.
    """

    # The following constant names were lifted from the avrlib lcd.h
    # header file, however, I changed the definitions from bit numbers
    # to bit masks.
    #
    # HD44780 LCD controller command set

    LCD_CLR = 0x01              # DB0: clear display
    LCD_HOME = 0x02             # DB1: return to home position

    LCD_ENTRY_MODE = 0x04       # DB2: set entry mode
    LCD_ENTRY_INC = 0x02        # --DB1: increment
    LCD_ENTRY_SHIFT = 0x01      # --DB0: shift

    LCD_ON_CTRL = 0x08          # DB3: turn lcd/cursor on
    LCD_ON_DISPLAY = 0x04       # --DB2: turn display on
    LCD_ON_CURSOR = 0x02        # --DB1: turn cursor on
    LCD_ON_BLINK = 0x01         # --DB0: blinking cursor

    LCD_MOVE = 0x10             # DB4: move cursor/display
    LCD_MOVE_DISP = 0x08        # --DB3: move display (0-> move cursor)
    LCD_MOVE_RIGHT = 0x04       # --DB2: move right (0-> left)

    LCD_FUNCTION = 0x20         # DB5: function set
    LCD_FUNCTION_8BIT = 0x10    # --DB4: set 8BIT mode (0->4BIT mode)
    LCD_FUNCTION_2LINES = 0x08  # --DB3: two lines (0->one line)
    LCD_FUNCTION_10DOTS = 0x04  # --DB2: 5x10 font (0->5x7 font)
    LCD_FUNCTION_RESET = 0x30   # See "Initializing by Instruction" section

    LCD_CGRAM = 0x40            # DB6: set CG RAM address
    LCD_DDRAM = 0x80            # DB7: set DD RAM address

    LCD_RS_CMD = 0
    LCD_RS_DATA = 1

    LCD_RW_WRITE = 0
    LCD_RW_READ = 1

    def __init__(self, num_lines, num_columns):
        self.num_lines = num_lines
        if self.num_lines > 4:
            self.num_lines = 4
        self.num_columns = num_columns
        if self.num_columns > 40:
            self.num_columns = 40
        self.cursor_x = 0
        self.cursor_y = 0
        self.implied_newline = False
        self.backlight = True
        self.display_off()
        self.backlight_on()
        self.clear()
        self.hal_write_command(self.LCD_ENTRY_MODE | self.LCD_ENTRY_INC)
        self.hide_cursor()
        self.display_on()

    def clear(self):
        """Clears the LCD display and moves the cursor to the top left
        corner.
        """
        self.hal_write_command(self.LCD_CLR)
        self.hal_write_command(self.LCD_HOME)
        self.cursor_x = 0
        self.cursor_y = 0

    def show_cursor(self):
        """Causes the cursor to be made visible."""
        self.hal_write_command(self.LCD_ON_CTRL | self.LCD_ON_DISPLAY |
                               self.LCD_ON_CURSOR)

    def hide_cursor(self):
        """Causes the cursor to be hidden."""
        self.hal_write_command(self.LCD_ON_CTRL | self.LCD_ON_DISPLAY)

    def blink_cursor_on(self):
        """Turns on the cursor, and makes it blink."""
        self.hal_write_command(self.LCD_ON_CTRL | self.LCD_ON_DISPLAY |
                               self.LCD_ON_CURSOR | self.LCD_ON_BLINK)

    def blink_cursor_off(self):
        """Turns on the cursor, and makes it no blink (i.e. be solid)."""
        self.hal_write_command(self.LCD_ON_CTRL | self.LCD_ON_DISPLAY |
                               self.LCD_ON_CURSOR)

    def display_on(self):
        """Turns on (i.e. unblanks) the LCD."""
        self.hal_write_command(self.LCD_ON_CTRL | self.LCD_ON_DISPLAY)

    def display_off(self):
        """Turns off (i.e. blanks) the LCD."""
        self.hal_write_command(self.LCD_ON_CTRL)

    def backlight_on(self):
        """Turns the backlight on.
        This isn't really an LCD command, but some modules have backlight
        controls, so this allows the hal to pass through the command.
        """
        self.backlight = True
        self.hal_backlight_on()

    def backlight_off(self):
        """Turns the backlight off.
        This isn't really an LCD command, but some modules have backlight
        controls, so this allows the hal to pass through the command.
        """
        self.backlight = False
        self.hal_backlight_off()

    def move_to(self, cursor_x, cursor_y):
        """Moves the cursor position to the indicated position. The cursor
        position is zero based (i.e. cursor_x == 0 indicates first column).
        """
        self.cursor_x = cursor_x
        self.cursor_y = cursor_y
        addr = cursor_x & 0x3f
        if cursor_y & 1:
            addr += 0x40    # Lines 1 & 3 add 0x40
        if cursor_y & 2:    # Lines 2 & 3 add number of columns
            addr += self.num_columns
        self.hal_write_command(self.LCD_DDRAM | addr)

    def putchar(self, char):
        """Writes the indicated character to the LCD at the current cursor
        position, and advances the cursor by one position.
        """
        if char == '\n':
            if self.implied_newline:
                # self.implied_newline means we advanced due to a wraparound,
                # so if we get a newline right after that we ignore it.
                pass
            else:
                self.cursor_x = self.num_columns
        else:
            self.hal_write_data(ord(char))
            self.cursor_x += 1
        if self.cursor_x >= self.num_columns:
            self.cursor_x = 0
            self.cursor_y += 1
            self.implied_newline = (char != '\n')
        if self.cursor_y >= self.num_lines:
            self.cursor_y = 0
        self.move_to(self.cursor_x, self.cursor_y)

    def putstr(self, string):
        """Write the indicated string to the LCD at the current cursor
        position and advances the cursor position appropriately.
        """
        for char in string:
            self.putchar(char)

    def custom_char(self, location, charmap):
        """Write a character to one of the 8 CGRAM locations, available
        as chr(0) through chr(7).
        """
        location &= 0x7
        self.hal_write_command(self.LCD_CGRAM | (location << 3))
        self.hal_sleep_us(40)
        for i in range(8):
            self.hal_write_data(charmap[i])
            self.hal_sleep_us(40)
        self.move_to(self.cursor_x, self.cursor_y)

    def hal_backlight_on(self):
        """Allows the hal layer to turn the backlight on.
        If desired, a derived HAL class will implement this function.
        """
        pass

    def hal_backlight_off(self):
        """Allows the hal layer to turn the backlight off.
        If desired, a derived HAL class will implement this function.
        """
        pass

    def hal_write_command(self, cmd):
        """Write a command to the LCD.
        It is expected that a derived HAL class will implement this
        function.
        """
        raise NotImplementedError

    def hal_write_data(self, data):
        """Write data to the LCD.
        It is expected that a derived HAL class will implement this
        function.
        """
        raise NotImplementedError

    def hal_sleep_us(self, usecs):
        """Sleep for some time (given in microseconds)."""
        time.sleep_us(usecs)

lcd_api.py

"""Source: Instructables, Tom's Hardware and GitHub """
"""Not Authored by Dr. Sengupta """

import utime
import gc

from lcd_api import LcdApi
from machine import I2C

# PCF8574 pin definitions
MASK_RS = 0x01       # P0
MASK_RW = 0x02       # P1
MASK_E  = 0x04       # P2

SHIFT_BACKLIGHT = 3  # P3
SHIFT_DATA      = 4  # P4-P7

class I2cLcd(LcdApi):
    
    #Implements a HD44780 character LCD connected via PCF8574 on I2C

    def __init__(self, i2c, i2c_addr, num_lines, num_columns):
        self.i2c = i2c
        self.i2c_addr = i2c_addr
        self.i2c.writeto(self.i2c_addr, bytes([0]))
        utime.sleep_ms(20)   # Allow LCD time to powerup
        # Send reset 3 times
        self.hal_write_init_nibble(self.LCD_FUNCTION_RESET)
        utime.sleep_ms(5)    # Need to delay at least 4.1 msec
        self.hal_write_init_nibble(self.LCD_FUNCTION_RESET)
        utime.sleep_ms(1)
        self.hal_write_init_nibble(self.LCD_FUNCTION_RESET)
        utime.sleep_ms(1)
        # Put LCD into 4-bit mode
        self.hal_write_init_nibble(self.LCD_FUNCTION)
        utime.sleep_ms(1)
        LcdApi.__init__(self, num_lines, num_columns)
        cmd = self.LCD_FUNCTION
        if num_lines > 1:
            cmd |= self.LCD_FUNCTION_2LINES
        self.hal_write_command(cmd)
        gc.collect()

    def hal_write_init_nibble(self, nibble):
        # Writes an initialization nibble to the LCD.
        # This particular function is only used during initialization.
        byte = ((nibble >> 4) & 0x0f) << SHIFT_DATA
        self.i2c.writeto(self.i2c_addr, bytes([byte | MASK_E]))
        self.i2c.writeto(self.i2c_addr, bytes([byte]))
        gc.collect()
        
    def hal_backlight_on(self):
        # Allows the hal layer to turn the backlight on
        self.i2c.writeto(self.i2c_addr, bytes([1 << SHIFT_BACKLIGHT]))
        gc.collect()
        
    def hal_backlight_off(self):
        #Allows the hal layer to turn the backlight off
        self.i2c.writeto(self.i2c_addr, bytes([0]))
        gc.collect()
        
    def hal_write_command(self, cmd):
        # Write a command to the LCD. Data is latched on the falling edge of E.
        byte = ((self.backlight << SHIFT_BACKLIGHT) |
                (((cmd >> 4) & 0x0f) << SHIFT_DATA))
        self.i2c.writeto(self.i2c_addr, bytes([byte | MASK_E]))
        self.i2c.writeto(self.i2c_addr, bytes([byte]))
        byte = ((self.backlight << SHIFT_BACKLIGHT) |
                ((cmd & 0x0f) << SHIFT_DATA))
        self.i2c.writeto(self.i2c_addr, bytes([byte | MASK_E]))
        self.i2c.writeto(self.i2c_addr, bytes([byte]))
        if cmd <= 3:
            # The home and clear commands require a worst case delay of 4.1 msec
            utime.sleep_ms(5)
        gc.collect()

    def hal_write_data(self, data):
        # Write data to the LCD. Data is latched on the falling edge of E.
        byte = (MASK_RS |
                (self.backlight << SHIFT_BACKLIGHT) |
                (((data >> 4) & 0x0f) << SHIFT_DATA))
        self.i2c.writeto(self.i2c_addr, bytes([byte | MASK_E]))
        self.i2c.writeto(self.i2c_addr, bytes([byte]))
        byte = (MASK_RS |
                (self.backlight << SHIFT_BACKLIGHT) |
                ((data & 0x0f) << SHIFT_DATA))      
        self.i2c.writeto(self.i2c_addr, bytes([byte | MASK_E]))
        self.i2c.writeto(self.i2c_addr, bytes([byte]))
        gc.collect()

pico_i2c_lcd.py

"""
# Counters.py
# A collection of different types of counters that can be used for various projects.
# Author: Arijit Sengupta
"""

import time
from machine import Timer, RTC
from Log import Log

class Counter:
    """
    Counter base class - provides an internal count, an initializer, and a reset method.
    Other functionality should be implemented by subclasses.
    """
    
    def __init__(self, name='Counter'):
        Log.i(f"{name}: constructor")
        self._name = name
        self._count = 0

    def reset(self):
        """ Reset counter memory to 0. """
        Log.i("Counter - reset")
        self._count = 0


class UpDownCounter(Counter):
    """ A basic up-down counter with optional min and max limits. """
    
    def __init__(self, name='UpDownCounter', min=None, max=None):
        Log.i(f"{name}: constructor")
        super().__init__(name)
        self._min = min
        self._max = max

    def up(self, step=1):
        """
        Increment the counter by a given step. 
        The counter will not exceed the max limit (if defined).
        """
        Log.i("UpDownCounter incrementing")
        if self._max is None or self._count + step <= self._max:
            self._count += step

    def down(self, step=1):
        """
        Decrement the counter by a given step. 
        The counter will not fall below the min limit (if defined).
        """
        Log.i("UpDownCounter decrementing")
        if self._min is None or self._count - step >= self._min:
            self._count -= step

    def get_value(self):
        """ Return the current count value. """
        return self._count

    def __str__(self):
        """ Return the string representation of the internal count. """
        return f"{self._count}"


class TimeKeeper(Counter):
    """
    A simple stopwatch that keeps track of time in milliseconds.
    It can be started, stopped, and reset. The counter stores the elapsed time.
    """
    
    def __init__(self, name='TimeKeeper'):
        Log.i(f"{name}: constructor")
        super().__init__(name)
        self._starttime = 0
        self._running = False

    def start(self):
        """ Start the timer. If previously stopped, it adds to the previous time. """
        Log.i("TimeKeeper: start")
        self._starttime = time.ticks_ms()
        self._running = True

    def stop(self):
        """ Stop the timer and save the elapsed time. """
        Log.i("TimeKeeper: stop")
        if self._running:
            self._running = False
            self._count += time.ticks_diff(time.ticks_ms(), self._starttime)

    def reset(self):
        """ Reset the timer count to 0 but keep the timer running if it was already started. """
        super().reset()
        self._starttime = time.ticks_ms()

    def __str__(self):
        """ Return the time in HH:MM:SS.ms format. """
        curtime = self._count + (time.ticks_diff(time.ticks_ms(), self._starttime) if self._running else 0)
        ms = curtime % 1000
        sec = (curtime // 1000) % 60
        min = (curtime // 60000) % 60
        hr = (curtime // 3600000)
        return f"{hr:02d}:{min:02d}:{sec:02d}.{ms:03d}"


class BaseTimer(Counter):
    """
    A base class for software and hardware timers. Timers can have a handler
    that is triggered when the timer expires.
    """
    
    def __init__(self, name='BaseTimer', handler=None):
        super().__init__(name)
        self._handler = handler
        self._started = False

    def setHandler(self, handler):
        """ Set a handler that will be triggered when the timer expires. """
        self._handler = handler

    def start(self, seconds):
        """ Start the timer with a specified duration. """
        self._count = seconds
        self._started = True

    def cancel(self):
        """ Cancel the timer. """
        self._started = False
        self._count = 0

    def reset(self):
        """ Reset the timer and cancel any running timer. """
        super().reset()
        self.cancel()


class HardwareTimer(BaseTimer):
    """
    Hardware timer using the internal timer of the Raspberry Pi Pico.
    This timer requires a handler to be set and is a one-shot timer.
    """
    
    def __init__(self, name='Hardware Timer', handler=None):
        super().__init__(name, handler)
        self._timer = Timer()

    def start(self, seconds):
        """ Start the hardware timer with a specified duration (in seconds). """
        super().start(seconds)
        self._timer.init(period=int(seconds * 1000), mode=Timer.ONE_SHOT, callback=self._timeout)

    def cancel(self):
        """ Cancel the running hardware timer. """
        if self._started:
            self._timer.deinit()
        super().cancel()

    def _timeout(self, timer):
        """ Trigger the handler when the timer expires. """
        self.cancel()
        if self._handler:
            self._handler.timeout(self._name)


class SoftwareTimer(BaseTimer):
    """
    Software-based timer that works by polling. The user must periodically
    call `check()` to determine if the timer has expired.
    """
    
    def __init__(self, name='Software Timer', handler=None):
        super().__init__(name, handler)
        self._starttime = 0

    def start(self, seconds):
        """ Start the software timer with a specified duration (in seconds). """
        Log.i(f"Starting {self._name} with {seconds} seconds")
        self._count = seconds
        self._starttime = time.ticks_ms()
        self._started = True

    def cancel(self):
        """ Cancel the software timer. """
        if self._started:
            self._starttime = 0
            Log.i(f"{self._count} sec {self._name} cancelled")
        super().cancel()

    def check(self):
        """
        Periodically call this method to check if the timer has expired.
        The handler is triggered if the timer expires.
        """
        if self._started and time.ticks_diff(time.ticks_ms(), self._starttime) >= self._count * 1000:
            Log.i(f"{self._name}: {self._count} sec timer expired")
            self._started = False
            self._count = 0
            if self._handler:
                self._handler.timeout(self._name)


class Time:
    """
    Utility class for getting and setting the system time.
    """

    @classmethod
    def getTime(cls):
        """ Return the current system time as an 8-tuple. """
        return time.localtime()

    @classmethod
    def setTime(cls, tm):
        """ Set the system time (requires a valid 7-element tuple). """
        RTC().datetime((tm[0], tm[1], tm[2], 0, tm[3], tm[4], tm[5], 0))
