import time
time.sleep(0.1) # Wait for USB to become ready

print("Hello, Pi Pico!")

from ClockController import *

myclock = ClockController()

while True:
  myclock.showTime()
  time.sleep(1)


main.py

diagram.json

"""
# Button.py - Object-Oriented implementation of a Button
# Also added a simple implementation of a single analog Joystick
# Author: Arijit Sengupta
"""

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

class Button:
    """
    A simple Button class
    Create the button using Button(pinnumber, name, handler)
    handler is typically self, and create two methods buttonPressed and buttonReleased
    to handle the push and release of the button.
    The name of the button will be passed back to the handler to identify
    which button was pressed/released
    """
    
    def __init__(self, pin, name, *, buttonhandler=None, lowActive=True):
        self._pinNo = pin
        self._name = name
        Log.i(f'Button constructor: create button {name} at pin {pin}')
        if lowActive:
            self._pin = Pin(pin, Pin.IN, Pin.PULL_UP)
        else:
            self._pin = Pin(pin, Pin.IN, Pin.PULL_DOWN)
        self._debounce_time = 0
        self._lowActive = lowActive
        self._lastStatus = None
        self._buttonhandler = buttonhandler
        self._pin.irq(trigger = Pin.IRQ_FALLING | Pin.IRQ_RISING, handler = self._callback)

    def isPressed(self):
        """ Check if the button is pressed or not - useful if polling """
        
        return (self._lowActive and self._pin.value() ==0) or (not self._lowActive and self._pin.value() == 1)
    
    def setHandler(self, buttonhandler):
        """ A class that has buttonPressed(name) and buttonReleased(name) methods """
        
        self._buttonhandler = buttonhandler
        
    def _callback(self, pin):
        """ The private interrupt handler - will call appropriate handlers """
        
        t = time.ticks_ms()
        v = self._pin.value()
        if ((self._lastStatus == None or self._lastStatus != v) and t-self._debounce_time) > 50:
            self._debounce_time=t
            self._lastStatus = v
            if self._buttonhandler is not None:
                if self.isPressed():
                    self._buttonhandler.buttonPressed(self._name)
                else:
                    self._buttonhandler.buttonReleased(self._name)
        #self._debounce_time=t

class Joystick(Button):
    """
    A joystick is technically more than a Button, but this is an example
    of using a subclass to inherit some functionality, and adding other
    functions as needed. 

    So we implement a Joystick as a subclass of a button, with the internal
    button inherited from the Button class, and the horizontal and vertical
    axes implemented as ADC pin implementations. 

    Interestingly, we may have looked into AnalogSensor as well, but there is
    no tripping of a Joystick so we don't need that.
    """
    
    # Some constants to store some basic conditions
    LOW = 0
    HIGH = 65535
    MID = 32760

    # Joystick status codes
    CENTER = 0
    UP = 1
    DOWN = 2
    LEFT = 3
    RIGHT = 4
    MOVING = 5
    
    # Status text
    statuscodes = ['Center', 'Up', 'Down', 'Left', 'Right', 'Moving']

    def __init__(self, vpin, hpin, swpin, name, *, buttonhandler=None, delta=1000):
        # Let the superclass handle all button functionality
        super().__init__(swpin, name, buttonhandler=buttonhandler, lowActive=True)
        Log.i(f'Joystick constructor: create joystick at v:{vpin}, h:{hpin}')

        # H and V axis pins must be standard ADC supporting
        if vpin <26 or vpin > 28 or hpin < 26 or hpin > 28:
            raise ValueError("Joystick Error: must connect v/h to ADC pins")

        self._v = ADC(vpin)
        self._h = ADC(hpin)
        self._delta = delta

    def getData(self):
        """
        A simple method to return the x and y values
        """

        return (self._h.read_u16(), self._v.read_u16())

    def getStatusCode(self):
        """
        Return the status code of the joystick
        0 - center, 1 left 2 right 3 up 4 down
        5 if it is not quite in any distinct position
        """

        (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 x > self.MID - self._delta and x < self.MID + self._delta and y > self.MID - self._delta and y < self.MID + self._delta:
            return self.CENTER
        return self.MOVING

    def getStatus(self):
        """
        Get the status of the joystick in text
        center, left, right, up, down, moving
        """
    
        return Joystick.statuscodes[self.getStatusCode()]


Button.py

"""
# Buzzer.py - Object-oriented implementation of active and passive buzzers
# Author: Arijit Sengupta
"""

import time
from machine import Pin, PWM
from Log import *

class Buzzer:
    """
    A simple buzzer class - use it to play and pause different sounds
    ranging from fequencies 10 through 10000
    default volume is half volume - set it between 0 and 10
    """ 
    
    def beep(self, tone=500, duration=150):
        Log.i(f"Beeping the buzzer at {tone}hz for {duration} ms")
        self.play(tone)
        time.sleep(duration / 1000)
        self.stop()
    
class ActiveBuzzer(Buzzer):
    """
    An active buzzer has an internal oscillator that plays a fixed tone when power is applied
    Cannot control the tone. Only turn on and off.
    """
    
    def __init__(self, pin):
        self._buz = Pin(pin, Pin.OUT)
   
    def play(self, tone=500):
        """ Play sound. Tone is ignored. """
        
        self._buz.value(1)
        
    def stop(self):
        """ Stop the sound. """
        
        self._buz.value(0)
    
class PassiveBuzzer(Buzzer):
    """
    A passive buzzer does not have an internal oscillator. MC needs to send a PWM signal
    to play tones. The tone is controlled by the frequency of the PWM, and the volume level
    is controlled by the duty cycle. Setting duty cycle to 0 stops sound.
    """
    
    def __init__(self, pin):
        Log.i("PassiveBuzzer: constructor")
        self._buz = PWM(Pin(pin))
        self._volume = 5
        self._playing = False
        self.stop()

    def play(self, tone=500):
        """ play the supplied tone. """
        
        Log.i(f"PassiveBuzzer: playing tone {tone}")
        self._buz.freq(tone)
        self._buz.duty_u16(self._volume * 100)
        self._playing = True

    def stop(self):
        """ Stop playing sound """
        
        Log.i("PassiveBuzzer: stopping tone")
        self._buz.duty_u16(0)
        self._playing = False

    def setVolume(self, volume=5):
        """ Change the volume of the sound currently playing and future plays """
        
        Log.i(f"PassiveBuzzer: changing volume to {volume}")
        self._volume = volume
        if (self._playing):
            self._buz.duty_u16(self._volume * 100)

# Known tones from https://github.com/james1236/buzzer_music
tones = {
    'C0':16,
    'C#0':17,
    'D0':18,
    'D#0':19,
    'E0':21,
    'F0':22,
    'F#0':23,
    'G0':24,
    'G#0':26,
    'A0':28,
    'A#0':29,
    'B0':31,
    'C1':33,
    'C#1':35,
    'D1':37,
    'D#1':39,
    'E1':41,
    'F1':44,
    'F#1':46,
    'G1':49,
    'G#1':52,
    'A1':55,
    'A#1':58,
    'B1':62,
    'C2':65,
    'C#2':69,
    'D2':73,
    'D#2':78,
    'E2':82,
    'F2':87,
    'F#2':92,
    'G2':98,
    'G#2':104,
    'A2':110,
    'A#2':117,
    'B2':123,
    'C3':131,
    'C#3':139,
    'D3':147,
    'D#3':156,
    'E3':165,
    'F3':175,
    'F#3':185,
    'G3':196,
    'G#3':208,
    'A3':220,
    'A#3':233,
    'B3':247,
    'C4':262,
    'C#4':277,
    'D4':294,
    'D#4':311,
    'E4':330,
    'F4':349,
    'F#4':370,
    'G4':392,
    'G#4':415,
    'A4':440,
    'A#4':466,
    'B4':494,
    'C5':523,
    'C#5':554,
    'D5':587,
    'D#5':622,
    'E5':659,
    'F5':698,
    'F#5':740,
    'G5':784,
    'G#5':831,
    'A5':880,
    'A#5':932,
    'B5':988,
    'C6':1047,
    'C#6':1109,
    'D6':1175,
    'D#6':1245,
    'E6':1319,
    'F6':1397,
    'F#6':1480,
    'G6':1568,
    'G#6':1661,
    'A6':1760,
    'A#6':1865,
    'B6':1976,
    'C7':2093,
    'C#7':2217,
    'D7':2349,
    'D#7':2489,
    'E7':2637,
    'F7':2794,
    'F#7':2960,
    'G7':3136,
    'G#7':3322,
    'A7':3520,
    'A#7':3729,
    'B7':3951,
    'C8':4186,
    'C#8':4435,
    'D8':4699,
    'D#8':4978,
    'E8':5274,
    'F8':5588,
    'F#8':5920,
    'G8':6272,
    'G#8':6645,
    'A8':7040,
    'A#8':7459,
    'B8':7902,
    'C9':8372,
    'C#9':8870,
    'D9':9397,
    'D#9':9956,
    'E9':10548,
    'F9':11175,
    'F#9':11840,
    'G9':12544,
    'G#9':13290,
    'A9':14080,
    'A#9':14917,
    'B9':15804
}

# Some basic do re mi tones
DO = tones['C4']
RE = tones['D4']
MI = tones['E4']
FA = tones['F4']
SO = tones['G4']
LA = tones['A4']
TI = tones['B4']
DO2 = tones['C5']


Buzzer.py

"""
# CompositeLights.py
# A simple inheritance structure showing a fairly abstract CompositeLight
# class that has a set of lights, and two different implementations of it
# Author: Arijit Sengupta
"""

from time import sleep, sleep_ms
from machine import Pin
from Log import *

class CompositeLight:
    """
    The base CompositeLight class - contains just an array
    and the on, off, run methods that subclasses should potentially override
    The base class simply calls on and off on all internal lights
    that may not be the proper way to turn on the composite
    """
    
    def __init__(self):
        """    # Constructor - just initialize the array of lights """

        Log.i("CompositeLight constructor")
        self._lights = []
        self._running = False
        
    def run(self):
        """
        # Technically this is an abstract method but Python does not
        # correctly support it, so just an empty shell
        """
        
        self._running = True

    def on(self):
        """
        # Turn on all the componets. Note that in does not necessarily
        # get all items in order - but usually does
        """
        
        Log.i("CompositeLight: turning on all lights")
        for l in self._lights:
            l.on()

    def off(self):
        """     # Turn off all the components """

        Log.i("CompositeLight: turning off all lights")
        for l in self._lights:
            l.off()
            
    def singleOn(self, lightno):
        """     # Turn a single light on (and the others off) """

        Log.i(f"CompositieLight - turning only light #{lightno} on")
        for i in range(0,len(self._lights)):
            if i == lightno:
                self._lights[i].on()
            else:
                self._lights[i].off()

    def __str__(self)->str:
        """
        # The __str__ method - add this to any class to generate a 
        # Human readable version of the class
        """
        
        return f"{type(self).__name__} with {len(self._lights)} lights"

        
class TrafficLight(CompositeLight):
    """
    The first subclass of the CompositeLight class
    Has a gree, yellow and red light that need to be
    passed in
    """
    
    def __init__(self, green, yellow, red):
        """
        # Traffic light constructor
        # Add the green, yellow and red lights to the array
        # in that order.
        """
        
        Log.i("TrafficLight constructor: add the lights in order")
        super().__init__()
        self._lights.append(green)
        self._lights.append(yellow)
        self._lights.append(red)
    
    def go(self):
        Log.i("Trafficlight - go/green")
        self.singleOn(0)
    
    def caution(self):
        Log.i("Trafficlight - caution/yellow")
        self.singleOn(1)

    def stop(self):
        Log.i("Trafficlight - stop/red")
        self.singleOn(2)

    def run(self):
        """
        # The run method - just runs the cycle once, showing
        # Green, yellow then red, and going back to Green
        """
        
        super().run()
        Log.i("TrafficLight: Run a simple Green-yellow-red sequence")
        if (self._running):
            self.go()
        if (self._running):
            sleep(3)
        if (self._running):
            self.caution()  
        if (self._running):
            sleep(0.5)
        if (self._running):
            self.stop()
        if (self._running):
            sleep(1.5)
        if (self._running):
            self.go()

class Pixel(CompositeLight):
    """
    The Pixel class - just uses an RGB LED to provide a simple implementation
    of a pixel that can be technically set to any color.
    """        

    def __init__(self, R, G, B, commoncathode = True):
        """     # Pixel constructor """

        Log.i("Pixel: Constructor - add R G B in that order")
        super().__init__()
        self._lights.append(R)
        self._lights.append(G)
        self._lights.append(B)
        self._commoncathode = commoncathode
        self._running = False
        
    def on(self):
        Log.i("Pixel: turning all components on")
        self._running = False
        if self._commoncathode:
            super().on()
        else:
            super().off()
            
    def off(self):
        Log.i("Pixel: turning all components off")
        self._running = False
        if self._commoncathode:
            super().off()
        else:
            super().on()
       
    def setColor(self, RR, GG, BB):
        """
        # setColor method - sets to a specific color
        # Brightness is set as percentage in this app
        """
        
        Log.i(f"Pixel: setColor: R:{RR}, G:{GG}, B:{BB}")
        self._lights[0].setBrightness(RR)
        self._lights[1].setBrightness(GG)
        self._lights[2].setBrightness(BB)
                
    def run(self, delay=250):
        """     # Demo run - just run up and down the R, G, B components """
        self._running = True

        colors = [[255,0,0], [255,165,0], [255,255,0], [0,128,0],[0,0,255],[75,0,130],[238,130,238]]
        Log.i("Pixel - run - rainbow demo")
        for c in colors:
            if not self._running:
                break
            self.setColor(c[0],c[1],c[2])
            sleep_ms(delay)        
        self._running = False


CompositeLights.py

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

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

class Counter:
    """
    Counter base class - provides an internal count, an initiailzer and a reset method
    everything else should be defined at subclass level
    """
    
    def __init__(self):
        Log.i("Counter: constructor")
        self._count = 0

    def reset(self):
        Log.i("Counter - reset")
        self._count = 0

class UpDownCounter(Counter):
    """ A basic updown counter - can go up or down, can set up a min and max """
    
    def __init__(self, min = None, max = None):
        Log.i("Updowncounter constructor")
        super().__init__()
        self._min = min
        self._max = max

    def up(self, step=1):
        """
        count up - with an optional step. Note that if the result will be less than max,
        no change will be made.
        """
                
        Log.i("Updowncounter incrementing")
        if (self._max is None or self._count + step <= self._max):
            self._count = self._count + step

    def down(self, step=1):
        """
        Count down - with an optional step. Note that if the result will be less than min,
        no change will be made
        """
        
        Log.i("Updowncounter decrementing")
        if (self._min is None or self._count - step >= self._min):
            self._count = self._count - step

    def __str__(self)->str:
        """ a string representation of the internal count """
        
        return f"{self._count}"

class TimeKeeper(Counter):
    """
    Keeps time as a count. Basically a stopwatch
    Internal count stores the number of ms of counting
    Can be stopped and started many times. Only reset will set
    count to 0
    """
    
    def __init__(self):
        Log.i("Timekeeper: constructor")
        super().__init__()
        self._starttime = 0
        self._running = False

    def start(self):
        """ Start the timer. Note that if previously stopped, this will add to previous time """
        
        Log.i("Timekeeper: start")
        """ If timer was already running, the start will get reset to the new time """

        self._starttime = time.ticks_ms()
        self._running = True

    def stop(self):
        """ Stop the timer. Count will save the # of ms elapsed """
        
        Log.i("Timekeeper: stop")
        """ If it was already stopped, nothing to be done """
        if self._running:
            self._running = False
            self._count = self._count + time.ticks_diff(time.ticks_ms(),self._starttime)

    def reset(self):
        """ 
        Resetting the timer will set count to 0 and starttime to the current time 
        But timer keeps running if not stopped
        """
        super().reset()
        self._starttime = time.ticks_ms()

    def __str__(self) -> str:
        """ Get a string representation of 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):
    """ 
    Decided to create a base class for the Software and Hardware timers
    since there are many properties in common. Now allowing no handlers in init
    but obviously a handler has to be set in order to ensure something happens when
    the time runs out.
    """

    def __init__(self, handler=None):
        super().__init__()
        self._handler = handler
        self._started = False

    def setHandler(self, handler):
        self._handler = handler

    def start(self, seconds):
        self._count = seconds
        self._started = True

    def cancel(self):
        self._started = False
        self._count = 0

    def reset(self):
        """ Make sure reset cancels the timer first """
        
        super().reset()
        self.cancel()
        
class HardwareTimer(BaseTimer):
    """
    This uses the hardware internal timer of the Pico. This does NOT WORK on the simulator!
    The internal count here is the timer setting that is not updated until reset or cancelled
    
    """
    
    def __init__(self, handler=None):
        """
        A hardware timer must be initialized with a handler. The handler must implement
        a timeout() method which will be called when the timer is up. Ideally, there
        should only be a single timer active at a time.
        """
        
        super().__init__(handler)
        self._timer = Timer(-1)

    def start(self, seconds):
        """ Start the timer with the number of seconds to use. """
        
        super().start(seconds)
        self._timer.init(period = int(seconds*1000), mode=Timer.ONE_SHOT, callback = self.timeout)

    def cancel(self):
        """ Cancel the timer. Note that a normal stop will cause the handler callback. """
        
        if self._started:
            self._timer.deinit()
        super().cancel()
    
    def timeout(self, timer):
        self.cancel()
        self._handler.timeout()

class SoftwareTimer(BaseTimer):
    """
    A simpler software-based timer that will work on the simulator as well. Caller
    again implements a handler method, but will need to poll the timer using the
    check method at regular intervals. Check will not return anything, but will
    call the timeout function of the caller just like the hardware timer.
    """
    
    def __init__(self, handler):
        super().__init__()
        self._handler = handler
        self._starttime = 0
        self._started = False

    def start(self, seconds):
        """ Start the timer with a set number of seconds """
        
        Log.i(f"Starting timer with {seconds} seconds")
        self._count = seconds
        self._starttime = time.ticks_ms()
        self._started = True

    def cancel(self):
        """ Cancel the timer - timeout hander will NOT be called """
        
        if self._started:
            self._starttime = 0
            Log.i(f"{self._count} sec timer cancelled")
        super().cancel()

    def check(self):
        """
        Periodically call the check method - can be called from anywhere
        """
        
        if self._started and time.ticks_diff(time.ticks_ms(), self._starttime) > self._count * 1000:
            Log.i(f"{self._count} sec timer is up")
            self._started = False
            self._count = 0
            self._handler.timeout()

class Time:
    @classmethod
    def getTime(cls):
        """
        Return the currnet time using the datetime 8-tuple:
        (year (4 dig), month (1-12), date(1-31), hour (0-23), min(0,59), sec(0-59), wkday(0-6), yday(1-366))
        """
        return time.localtime()

    @classmethod
    def setTime(cls, tm):
        """
        Send a semi-valid time tuple - wkday and yday are ignored
        The rest have to be valid (be careful about no. of days in a month
        """
        RTC().datetime((tm[0], tm[1], tm[2], 0, tm[3], tm[4], tm[5], 0))
    

Counters.py

"""
# Displays.py
# A collection of various text-based displays
# Currently supports 4-digit seven-segment displays - both with a tm1637 backpack
# and without (using PIO)
# And also LCD 1602 displays - both using an i2c backpack as well as GPIO
# Only supports number and basic text displays - PIO 7 seg only supports number
# Author: Arijit Sengupta
"""

from machine import Pin, I2C, SPI
import rp2
import time
from Log import *
from rp2 import PIO
import tm1637
from gpio_lcd import *
from pico_i2c_lcd import I2cLcd
import max7219

class Display:
    """
    The Display Base class - might not actually be needed
    But here to ensure we do not have a duckTyping problem
    """

    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 SevenSegmentDisplay(Display):
    """
    Seven Segment Display class - implements a 4-digit seven segment display
    Decimal points not supported - colon can be used when showing two numbers
    """

    def __init__(self, clk=16, dio=17):
        self._tm = tm1637.TM1637(clk=Pin(clk), dio=Pin(dio))

    def reset(self):
        """ clear the display screen  """
        
        self._tm.write([0, 0, 0, 0])

    def showNumber(self, number):
        """ show a single number """
        
        self._tm.number(number)

    def showNumbers(self, num1, num2, colon=True):
        """  Show two numbers optionally separated by a colon by default, the colon is shown """
        
        self._tm.numbers(num1, num2, colon)

    def showText(self, text):
        """
        Show a string - only first 4 characters will be shown
        for anything bigger than 4 characters.
        """
        
        self._tm.show(text)

    def scroll(self, text, speed=250):
        """
        Scroll a longer text - note that this will use a sleep
        call to pause between movements.
        """
        
        self._tm.scroll(text, speed)

class LCDDisplay(Display):
    """
    LCD Display class - currently supports displays with an I2C backpack
    as well as displays directly driven via the d4-d7 pins
    
    Parameters
    --------
    This is important since Python does not have method overloading, we have one init
    to do both parallel as well as i2c displays
    pass rs, e, d4, d5, d6, d7 pin numbers for parallel displays
    
    pass sda, scl, i2cid for i2c displays - default is to use parallel so must pass sda/scl/i2cid
    if using i2c
    
    To connect the display to I2C 0 on GPIO pins 0,1
    usage: LCDDisplay(sda=0, scl=1, i2cid=0)
    
    To connect the display to I2C ID 1 on GPIO pins 2,3
    usage: LCDDisplay(sda=2, scl=3, i2cid=1)
    
    To connect via parallel with rs on pin 5, e on pin 4
    and d4,d5,d6,d7 to pins 3,2,1 and 0:
    usage:  LCDDisplay()  # yeah those are the default so you don't need to send
    usage: LCDDisplay(rs=5, e=4, d4=3, d5=2, d6=1, d7=0) # preferred - you can see how its hooked up
    
    """
    
    def __init__(self, rs=5, e=4, d4=3, d5=2, d6=1, d7=0, *, sda=-1, scl=-1, i2cid=0):
        """
        Combined constructor for the direct-driven displays
        explicitly pass in the sda and scl if you need to use I2C
        """
        
        if sda < 0:
            Log.i("LCDDisplay Constructor")
            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 (I2C) Constructor")
            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.')
        self._working = False

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

    def showNumber(self, number, row=0, col=0):
        """
        show a single number
        """
        
        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
        by default, the colon is shown
        """
        
        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):
        """
        Show a string - only first 4 characters will be shown
        for anything bigger than 4 characters.
        """
        
        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 at a position.
        position must be between 0 and 7
        shapearray needs to be a bytearray that can
        be created by going to
        https://maxpromer.github.io/LCD-Character-Creator/
        """
        if position < 0 or position > 7:
            raise ValueError('Position must be between 0 and 7.')
        if len(shapearray) != 8:
            raise ValueError('Make sure array is exactly 8 bytes')
        self._lcd.custom_char(position, shapearray)

    def scroll(self, text, row=0, speed=100, skip=2):
        """
        A very simple scroll implementation
        Scrolls some text right to left in a row

        speed is essentially the delay between refresh - lower the better
        skip is the number of chars to skip for the next refresh
        higher number will be faster but may be jerky. lower will be smooth
        but slower.

        I2C devices may not have best scrolling performance. Works
        better with GPIO-driven displays
        """

        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

class DotMatrixDisplay(Display):
    """
    An implementation of the MAX7219 Dot Matrix display
    Fairly simplistic implementation - tested only with simulator so far 
    """

    def __init__(self, sck=18, mosi=19, cs=17):
        self._spi = SPI(0, baudrate=10000000, polarity=1, phase=0, sck=Pin(sck), mosi=Pin(mosi))
        # Create matrix display instant, which has four MAX7219 devices.
        self._dot = max7219.Matrix8x8(self._spi, Pin(cs, Pin.OUT), 4)
        self._dot.brightness(10)
        self.reset()

    def reset(self):
        #Clear the display.
        self._dot.fill(0)
        self._dot.show()

    def showNumber(self, number, row = 0, col = 0):
        self._dot.text(str(number), row, col, 1)
        self._dot.show()

    def showText(self, text, row = 0, col = 0):
        self._dot.text(text, row, col, 1)
        self._dot.show()

    def scroll(self, text, speed=50):
        #Get the message length
        length = len(text)
        column = (length * 8)
        for x in range(32, -column, -1):     
            #Clear the display
            self._dot.fill(0)
            # Write the scrolling text in to frame buffer
            self._dot.text(text,x,0,1)
            #Show the display
            self._dot.show()
      
            #Set the Scrolling speed. Here it is 50mS.
            time.sleep(speed/1000)

class MorseDisplay(Display):
    """
    This is a fun class - implement a Morse code display
    This can play the Morse code via a Buzzer, or show
    the code via a light, or even display it in another
    display.
    
    We need to make sure the other display is not another
    MorseDisplay though
    """
        
    def __init__(self, buz=None, light=None, otherDisplay=None):
        self._buz = buz
        self._light = light
        if isinstance(otherDisplay, OLEDDisplay) or isinstance(otherDisplay, LCDDisplay):
            self._dp = otherDisplay
        else:
            self._dp = None
            Log.e(f"Sorry, {type(otherDisplay).__name__} isn't supported")
        self._morsedict = {'A': '.-', 'B': '-...', 'C': '-.-.', 'D': '-..', 'E': '.', 'F': '..-.', 'G': '--.', 'H': '....',
            'I': '..', 'J': '.---', 'K': '-.-', 'L': '.-..', 'M': '--', 'N': '-.', 'O': '---', 'P': '.--.',
            'Q': '--.-', 'R': '.-.', 'S': '...', 'T': '-', 'U': '..-', 'V': '...-', 'W': '.--', 'X': '-..-',
            'Y': '-.--', 'Z': '--..', '0': '-----', '1': '.----', '2': '..---', '3': '...--', '4': '....-',
            '5': '.....', '6': '-....', '7': '--...', '8': '---..', '9': '----.'}

    def showNumber(self, number):
        """ Just convert the number to a string and show it """
        
        showText(self, str(number))

    def showText(self, text):
        """ Displaying a Morse decoded text on the buzzer, light and possibly display """
        
        morse = self._decodeText(text)
        if self._dp is not None:
            self._dp.showText(morse)
        # go through the string each character at a time
        for char in morse:
            # if the character is in our dictionary, then get the code
            if char == ".":
                self._displaydida(100)
            elif char == "-":
                self._displaydida(250)
            else:
                time.sleep_ms(250)
                    
    ####### Local private methods in MorseDisplay - should not be used from outside ####            
    def _decodeText(self, text):
        morse = []
        for char in text.upper():
            if char in self._morsedict:
                morse.append(self._morsedict[char])
            elif char.isspace():
                morse.append(' ')
        return " ".join(morse)
    
    def _displaydida(self, sleeptime):
        if self._buz is not None:
            self._buz.play()
        if self._light is not None:
            self._light.on()
        time.sleep_ms(sleeptime)
        if self._buz is not None:
            self._buz.stop()
        if self._light is not None:
            self._light.off()
        time.sleep_ms(100)

class SevenSegmentDisplayRaw(Display):
    """
    A Raw 7 segment display that uses RPi PIO along with internal StateMachine
    to poll 4 digits into the display. All digits are shown always so there will be
    leading zeros for numbers under 4 digits
    """
    
    def __init__(self, pinstart=2, digstart=10):
        self._digits = [
            0b11000000, # 0
            0b11111001, # 1
            0b10100100, # 2 
            0b10110000, # 3
            0b10011001, # 4
            0b10010010, # 5
            0b10000010, # 6
            0b11111000, # 7
            0b10000000, # 8
            0b10011000, # 9
            ]
        self._sm = rp2.StateMachine(0, sevseg, freq=2000, out_base=Pin(pinstart), sideset_base=Pin(digstart))
        self._sm.active(1)
  
    def _segmentize(self, num):
        return (
            self._digits[num % 10] | self._digits[num // 10 % 10] << 8
            | self._digits[num // 100 % 10] << 16 
            | self._digits[num // 1000 % 10] << 24 
        )

    def showNumber(self, n):
        self._sm.put(self._segmentize(n))
        
    def reset(self):
        self._sm.put(0xFFFFFFFF)

# Internals used by the PIO state machine
# THIS IS REQUIRED FOR THE SEVEN SEG RAW class
@rp2.asm_pio(out_init=[PIO.OUT_LOW]*8, sideset_init=[PIO.OUT_LOW]*4)
def sevseg():
    wrap_target()
    label("0")
    pull(noblock)           .side(0)      # 0
    mov(x, osr)             .side(0)      # 1
    out(pins, 8)            .side(1)      # 2
    out(pins, 8)            .side(2)      # 3
    out(pins, 8)            .side(4)      # 4
    out(pins, 8)            .side(8)      # 5
    jmp("0")                .side(0)      # 6
    wrap()

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

"""
# GraphicDisplays.py
# Previously part of Displays.py - split out to improve performance
# of LCD-based displays which are mostly used in our projects
# Currently supports SSD1306-based OLED devices
# and cheap 128x32 I2C LCD devices
# Author: Arijit Sengupta
"""

from Displays import *
from ssd1306 import SSD1306_I2C
import lcd128_32_fonts
from lcd128_32 import lcd128_32

class LCDHiResDisplay(Display):
    """
    LCDHiResDisplay - implements an LCD display which gives access to individual pixels
    
    Only supports I2C connection for now. Pass in sda, scl, i2cid, width and height
    
    Usage:
    Connect to I2C0 on sda to pin 0 and scl to pin 1:
    
    LCDHiResDisplay(sda=0, scl=1, i2cid=0, width=128, height=32)
    
    Connect to I2C0 on sda to pin 20, scl to pin 21:
    LCDHiResDisplay(sda=20, scl=21, i2cid=0, width=128, height=32) # default values
    
    Note that graphics outputs are not supported yet in this library.    
    """
    
    def __init__(self, sda=20, scl=21, i2cid=0, width=128, height=32):
        Log.i("LCDHiResDisplay (I2C) Constructor")
        i2c = I2C(i2cid, sda=Pin(sda), scl=Pin(scl), freq=400000)
        I2C_ADDR = i2c.scan()[0]
        try:
            I2C_ADDR = i2c.scan()[0]
            self._lcd = lcd128_32(sda, scl, i2cid, I2C_ADDR)
            self.reset()
        except:
            raise ValueError('Could not connect to display - check wiring.')

    def reset(self):
        self._lcd.Clear()
        
    def showNumber(self, number, row=0, col=0):
        self._lcd.Cursor(row,col)
        self._lcd.Display(str(number))

    def showText(self, text, row=0, col=0):
        self._lcd.Cursor(row,col)
        self._lcd.Display(text)

    
class OLEDDisplay(Display):
    """
    OLEDDisplay class - implements an OLED display
    
    Only supports I2C connection for now. Pass in sda, scl, i2cid, width and height
    
    Usage:
    Connect to I2C0 on sda to pin 0 and scl to pin 1:
    
    OLEDDisplay(sda=0, scl=1, i2cid=0, width=128, height=64)
    
    Connect to I2C1 on sda to pin 26, scl to pin 27:
    OLEDDisplay(sda=26, scl=27, i2cid=1, width=128, height=64) # default values
    
    Note that graphics outputs are not supported yet in this library.
    """

    def __init__(self, sda=26, scl=27, i2cid=1, width=128, height=64):
        self._i2c = I2C(i2cid, sda=Pin(sda), scl=Pin(scl), freq=400000)
        self._oled = SSD1306_I2C(width, height, self._i2c)
        self.reset()

    def reset(self):
        self._oled.fill(0)
        self._oled.show()
        
    def showNumber(self, number, row=0, col=0):
        self._oled.text(str(number), row, col, 1)
        self._oled.show()

    def showText(self, text, row=0, col=0):
        self._oled.text(text, row, col, 1)
        self._oled.show()



GraphicDisplays.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

"""
Micropython (Raspberry Pi Pico)
2022/1/12     DENGFEI
lcd.Display() Only 94 limited characters in fonts can be displayed
"""

import machine
import time
import lcd128_32_fonts
cursor = [0, 0]
class lcd128_32:
    
    def __init__(self,dt,clk,bus,addr):
        self.addr = addr
        self.i2c = machine.I2C(bus,sda=machine.Pin(dt),scl=machine.Pin(clk))
        self.Init()
        
    def WriteByte_command(self, cmd):
        self.reg_write(0x00, cmd)
    
    def WriteByte_dat(self, dat):
        self.reg_write(0x40, dat)
    
    def reg_write(self, reg, data):
        msg = bytearray()
        msg.append(data)
        self.i2c.writeto_mem(self.addr, reg, msg)
    
    def Init(self):
        #self.i2c.start()
        time.sleep(0.01)
        self.WriteByte_command(0xe2)
        time.sleep(0.01)
        self.WriteByte_command(0xa3)
        self.WriteByte_command(0xa0)
        self.WriteByte_command(0xc8)
        self.WriteByte_command(0x22)
        self.WriteByte_command(0x81)
        self.WriteByte_command(0x30)
        self.WriteByte_command(0x2c)
        self.WriteByte_command(0x2e)
        self.WriteByte_command(0x2f)
        self.Clear()
        self.WriteByte_command(0xff)
        self.WriteByte_command(0x72)
        self.WriteByte_command(0xfe)
        self.WriteByte_command(0xd6)
        self.WriteByte_command(0x90)
        self.WriteByte_command(0x9d)
        self.WriteByte_command(0xaf)
        self.WriteByte_command(0x40)
    
    def Clear(self):
        for i in range(4):
            self.WriteByte_command(0xb0 + i)
            self.WriteByte_command(0x10)
            self.WriteByte_command(0x00)
            for j in range(128):
                self.WriteByte_dat(0x00)
    
    def Cursor(self, y, x):
        if x > 17:
            x = 17
        if y > 3:
            x = 3
        cursor[0] = y
        cursor[1] = x
        
    def WriteFont(self, num):
        for item in lcd128_32_fonts.textFont[num]:
            self.WriteByte_dat(item)
    
    def Display(self, str):
        self.WriteByte_command(0xb0 + cursor[0])
        self.WriteByte_command(0x10 + cursor[1] * 7 // 16)
        self.WriteByte_command(0x00 + cursor[1] * 7 % 16)
        for num in range(len(str)):
            if str[num] == '0':
                self.WriteFont(0)
            elif str[num] == '1':
                self.WriteFont(1)
            elif str[num] == '2':
                self.WriteFont(2)
            elif str[num] == '3':
                self.WriteFont(3)
            elif str[num] == '4':
                self.WriteFont(4)
            elif str[num] == '5':
                self.WriteFont(5)
            elif str[num] == '6':
                self.WriteFont(6)
            elif str[num] == '7':
                self.WriteFont(7)
            elif str[num] == '8':
                self.WriteFont(8)
            elif str[num] == '9':
                self.WriteFont(9)
            elif str[num] == 'a':
                self.WriteFont(10)
            elif str[num] == 'b':
                self.WriteFont(11)
            elif str[num] == 'c':
                self.WriteFont(12)
            elif str[num] == 'd':
                self.WriteFont(13)
            elif str[num] == 'e':
                self.WriteFont(14)
            elif str[num] == 'f':
                self.WriteFont(15)
            elif str[num] == 'g':
                self.WriteFont(16)
            elif str[num] == 'h':
                self.WriteFont(17)
            elif str[num] == 'i':
                self.WriteFont(18)
            elif str[num] == 'j':
                self.WriteFont(19)
            elif str[num] == 'k':
                self.WriteFont(20)
            elif str[num] == 'l':
                self.WriteFont(21)
            elif str[num] == 'm':
                self.WriteFont(22)
            elif str[num] == 'n':
                self.WriteFont(23)
            elif str[num] == 'o':
                self.WriteFont(24)
            elif str[num] == 'p':
                self.WriteFont(25)
            elif str[num] == 'q':
                self.WriteFont(26)
            elif str[num] == 'r':
                self.WriteFont(27)
            elif str[num] == 's':
                self.WriteFont(28)
            elif str[num] == 't':
                self.WriteFont(29)
            elif str[num] == 'u':
                self.WriteFont(30)
            elif str[num] == 'v':
                self.WriteFont(31)
            elif str[num] == 'w':
                self.WriteFont(32)
            elif str[num] == 'x':
                self.WriteFont(33)
            elif str[num] == 'y':
                self.WriteFont(34)
            elif str[num] == 'z':
                self.WriteFont(35)
            elif str[num] == 'A':
                self.WriteFont(36)
            elif str[num] == 'B':
                self.WriteFont(37)
            elif str[num] == 'C':
                self.WriteFont(38)
            elif str[num] == 'D':
                self.WriteFont(39)
            elif str[num] == 'E':
                self.WriteFont(40)
            elif str[num] == 'F':
                self.WriteFont(41)
            elif str[num] == 'G':
                self.WriteFont(42)
            elif str[num] == 'H':
                self.WriteFont(43)
            elif str[num] == 'I':
                self.WriteFont(44)
            elif str[num] == 'J':
                self.WriteFont(45)
            elif str[num] == 'K':
                self.WriteFont(46)
            elif str[num] == 'L':
                self.WriteFont(47)
            elif str[num] == 'M':
                self.WriteFont(48)
            elif str[num] == 'N':
                self.WriteFont(49)
            elif str[num] == 'O':
                self.WriteFont(50)
            elif str[num] == 'P':
                self.WriteFont(51)
            elif str[num] == 'Q':
                self.WriteFont(52)
            elif str[num] == 'R':
                self.WriteFont(53)
            elif str[num] == 'S':
                self.WriteFont(54)
            elif str[num] == 'T':
                self.WriteFont(55)
            elif str[num] == 'U':
                self.WriteFont(56)
            elif str[num] == 'V':
                self.WriteFont(57)
            elif str[num] == 'W':
                self.WriteFont(58)
            elif str[num] == 'X':
                self.WriteFont(59)
            elif str[num] == 'Y':
                self.WriteFont(60)
            elif str[num] == 'Z':
                self.WriteFont(61)
            elif str[num] == '!':
                self.WriteFont(62)
            elif str[num] == '"':
                self.WriteFont(63)
            elif str[num] == '#':
                self.WriteFont(64)
            elif str[num] == '$':
                self.WriteFont(65)
            elif str[num] == '%':
                self.WriteFont(66)
            elif str[num] == '&':
                self.WriteFont(67)
            elif str[num] == '\'':
                self.WriteFont(68)
            elif str[num] == '(':
                self.WriteFont(69)
            elif str[num] == ')':
                self.WriteFont(70)
            elif str[num] == '*':
                self.WriteFont(71)
            elif str[num] == '+':
                self.WriteFont(72)
            elif str[num] == ',':
                self.WriteFont(73)
            elif str[num] == '-':
                self.WriteFont(74)
            elif str[num] == '/':
                self.WriteFont(75)
            elif str[num] == ':':
                self.WriteFont(76)
            elif str[num] == ';':
                self.WriteFont(77)
            elif str[num] == '<':
                self.WriteFont(78)
            elif str[num] == '=':
                self.WriteFont(79)
            elif str[num] == '>':
                self.WriteFont(80)
            elif str[num] == '?':
                self.WriteFont(81)
            elif str[num] == '@':
                self.WriteFont(82)
            elif str[num] == '{':
                self.WriteFont(83)
            elif str[num] == '|':
                self.WriteFont(84)
            elif str[num] == '}':
                self.WriteFont(85)
            elif str[num] == '~':
                self.WriteFont(86)
            elif str[num] == ' ':
                self.WriteFont(87)
            elif str[num] == '.':
                self.WriteFont(88)
            elif str[num] == '^':
                self.WriteFont(89)
            elif str[num] == '_':
                self.WriteFont(90)
            elif str[num] == '`':
                self.WriteFont(91)
            elif str[num] == '[':
                self.WriteFont(92)
            elif str[num] == '\\':
                self.WriteFont(93)
            elif str[num] == ']':
                self.WriteFont(94)


lcd128_32.py

"""
Micropython (Raspberry Pi Pico)
the following contains only 94 characters
"""
textFont={
    0:[0x00, 0x3E, 0x51, 0x49, 0x45, 0x3E, 0x00],
    1:[0x00, 0x00, 0x42, 0x7F, 0x40, 0x00, 0x00],
    2:[0x00, 0x62, 0x51, 0x49, 0x49, 0x46, 0x00],
    3:[0x00, 0x21, 0x41, 0x49, 0x4D, 0x33, 0x00],
    4:[0x00, 0x18, 0x14, 0x12, 0x7F, 0x10, 0x00],
    5:[0x00, 0x27, 0x45, 0x45, 0x45, 0x39, 0x00],
    6:[0x00, 0x3C, 0x4A, 0x49, 0x49, 0x31, 0x00],
    7:[0x00, 0x01, 0x71, 0x09, 0x05, 0x03, 0x00],
    8:[0x00, 0x36, 0x49, 0x49, 0x49, 0x36, 0x00],
    9:[0x00, 0x46, 0x49, 0x49, 0x29, 0x1E, 0x00],
    10:[0x00, 0x24, 0x54, 0x54, 0x38, 0x40, 0x00],
    11:[0x00, 0x7F, 0x28, 0x44, 0x44, 0x38, 0x00],
    12:[0x00, 0x38, 0x44, 0x44, 0x44, 0x08, 0x00],
    13:[0x00, 0x38, 0x44, 0x44, 0x28, 0x7F, 0x00],
    14:[0x00, 0x38, 0x54, 0x54, 0x54, 0x08, 0x00],
    15:[0x00, 0x08, 0x7E, 0x09, 0x09, 0x02, 0x00],
    16:[0x00, 0x98, 0xA4, 0xA4, 0xA4, 0x78, 0x00],
    17:[0x00, 0x7F, 0x08, 0x04, 0x04, 0x78, 0x00],
    18:[0x00, 0x00, 0x00, 0x79, 0x00, 0x00, 0x00],
    19:[0x00, 0x00, 0x80, 0x88, 0x79, 0x00, 0x00],
    20:[0x00, 0x7F, 0x10, 0x28, 0x44, 0x40, 0x00],
    21:[0x00, 0x00, 0x41, 0x7F, 0x40, 0x00, 0x00],
    22:[0x00, 0x78, 0x04, 0x78, 0x04, 0x78, 0x00],
    23:[0x00, 0x04, 0x78, 0x04, 0x04, 0x78, 0x00],
    24:[0x00, 0x38, 0x44, 0x44, 0x44, 0x38, 0x00],
    25:[0x00, 0xFC, 0x24, 0x24, 0x24, 0x18, 0x00],
    26:[0x00, 0x18, 0x24, 0x24, 0x24, 0xFC, 0x00],
    27:[0x00, 0x04, 0x78, 0x04, 0x04, 0x08, 0x00],
    28:[0x00, 0x48, 0x54, 0x54, 0x54, 0x24, 0x00],
    29:[0x00, 0x04, 0x3F, 0x44, 0x44, 0x24, 0x00],
    30:[0x00, 0x3C, 0x40, 0x40, 0x3C, 0x40, 0x00],
    31:[0x00, 0x1C, 0x20, 0x40, 0x20, 0x1C, 0x00],
    32:[0x00, 0x3C, 0x40, 0x3C, 0x40, 0x3C, 0x00],
    33:[0x00, 0x44, 0x28, 0x10, 0x28, 0x44, 0x00],
    34:[0x00, 0x9C, 0xA0, 0xA0, 0x90, 0x7C, 0x00],
    35:[0x00, 0x44, 0x64, 0x54, 0x4C, 0x44, 0x00],
    36:[0x00, 0x7C, 0x12, 0x11, 0x12, 0x7C, 0x00],
    37:[0x00, 0x7F, 0x49, 0x49, 0x49, 0x36, 0x00],
    38:[0x00, 0x3E, 0x41, 0x41, 0x41, 0x22, 0x00],
    39:[0x00, 0x7F, 0x41, 0x41, 0x41, 0x3E, 0x00],
    40:[0x00, 0x7F, 0x49, 0x49, 0x49, 0x41, 0x00],
    41:[0x00, 0x7F, 0x09, 0x09, 0x09, 0x01, 0x00],
    42:[0x00, 0x3E, 0x41, 0x51, 0x51, 0x72, 0x00],
    43:[0x00, 0x7F, 0x08, 0x08, 0x08, 0x7F, 0x00],
    44:[0x00, 0x00, 0x41, 0x7F, 0x41, 0x00, 0x00],
    45:[0x00, 0x20, 0x40, 0x41, 0x3F, 0x01, 0x00],
    46:[0x00, 0x7F, 0x08, 0x14, 0x22, 0x41, 0x00],
    47:[0x00, 0x7F, 0x40, 0x40, 0x40, 0x40, 0x00],
    48:[0x00, 0x7F, 0x02, 0x0C, 0x02, 0x7F, 0x00],
    49:[0x00, 0x7F, 0x04, 0x08, 0x10, 0x7F, 0x00],
    50:[0x00, 0x3E, 0x41, 0x41, 0x41, 0x3E, 0x00],
    51:[0x00, 0x7F, 0x09, 0x09, 0x09, 0x06, 0x00],
    52:[0x00, 0x3E, 0x41, 0x51, 0x21, 0x5E, 0x00],
    53:[0x00, 0x7F, 0x09, 0x19, 0x29, 0x46, 0x00],
    54:[0x00, 0x26, 0x49, 0x49, 0x49, 0x32, 0x00],
    55:[0x00, 0x01, 0x01, 0x7F, 0x01, 0x01, 0x00],
    56:[0x00, 0x3F, 0x40, 0x40, 0x40, 0x3F, 0x00],
    57:[0x00, 0x1F, 0x20, 0x40, 0x20, 0x1F, 0x00],
    58:[0x00, 0x7F, 0x20, 0x18, 0x20, 0x7F, 0x00],
    59:[0x00, 0x63, 0x14, 0x08, 0x14, 0x63, 0x00],
    60:[0x00, 0x03, 0x04, 0x78, 0x04, 0x03, 0x00],
    61:[0x00, 0x61, 0x51, 0x49, 0x45, 0x43, 0x00],
    62:[0x00, 0x00, 0x00, 0x5F, 0x00, 0x00, 0x00],
    63:[0x00, 0x00, 0x07, 0x00, 0x07, 0x00, 0x00],
    64:[0x00, 0x14, 0x7F, 0x14, 0x7F, 0x14, 0x00],
    65:[0x00, 0x24, 0x2E, 0x7B, 0x2A, 0x12, 0x00],
    66:[0x00, 0x23, 0x13, 0x08, 0x64, 0x62, 0x00],
    67:[0x00, 0x36, 0x49, 0x56, 0x20, 0x50, 0x00],
    68:[0x00, 0x00, 0x04, 0x03, 0x01, 0x00, 0x00],
    69:[0x00, 0x00, 0x1C, 0x22, 0x41, 0x00, 0x00],
    70:[0x00, 0x00, 0x41, 0x22, 0x1C, 0x00, 0x00],
    71:[0x00, 0x22, 0x14, 0x7F, 0x14, 0x22, 0x00],
    72:[0x00, 0x08, 0x08, 0x7F, 0x08, 0x08, 0x00],
    73:[0x00, 0x40, 0x30, 0x10, 0x00, 0x00, 0x00],
    74:[0x00, 0x08, 0x08, 0x08, 0x08, 0x08, 0x00],
    75:[0x00, 0x20, 0x10, 0x08, 0x04, 0x02, 0x00],
    76:[0x00, 0x00, 0x36, 0x36, 0x00, 0x00, 0x00],
    77:[0x00, 0x40, 0x36, 0x36, 0x00, 0x00, 0x00],
    78:[0x00, 0x08, 0x14, 0x22, 0x41, 0x00, 0x00],
    79:[0x00, 0x14, 0x14, 0x14, 0x14, 0x14, 0x00],
    80:[0x00, 0x00, 0x41, 0x22, 0x14, 0x08, 0x00],
    81:[0x00, 0x02, 0x01, 0x59, 0x05, 0x02, 0x00],
    82:[0x00, 0x3E, 0x41, 0x5D, 0x55, 0x5E, 0x00],
    83:[0x00, 0x08, 0x36, 0x41, 0x00, 0x00, 0x00],
    84:[0x00, 0x00, 0x00, 0x77, 0x00, 0x00, 0x00],
    85:[0x00, 0x00, 0x00, 0x41, 0x36, 0x08, 0x00],
    86:[0x00, 0x08, 0x04, 0x08, 0x10, 0x08, 0x00],
    87:[0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00],
    88:[0x00, 0x00, 0x60, 0x60, 0x00, 0x00, 0x00],
    89:[0x00, 0x04, 0x02, 0x7F, 0x02, 0x04, 0x00],
    90:[0x00, 0x08, 0x1C, 0x2A, 0x08, 0x08, 0x00],
    91:[0x00, 0x00, 0x00, 0x01, 0x02, 0x04, 0x00],
    92:[0x00, 0x7F, 0x7F, 0x41, 0x41, 0x00, 0x00],
    93:[0x00, 0x02, 0x04, 0x08, 0x10, 0x20, 0x00],
    94:[0x00, 0x00, 0x41, 0x41, 0x7F, 0x7F, 0x00],
}

lcd128_32_fonts.py

"""
LevelDisplay.py
A base LevelDisplay class with a couple of subclasses with implementations using
A LightStrip and an LCD Display - I may add additional implementations in the future
for example, using an actual 7 led bar - maybe with a shift register
"""
from Displays import *
from LightStrip import *
from Log import *

class LevelDisplay:
    """
    Superclass for LevelDisplay.
    Should not be initiated directly. Wish Python had a proper abstract class
    """
    def __init__(self, levels):
        """
        Create a level Display with a max number of levels.
        Note that display will be from 0 (may be nothing displayed)
        Up to _levels_ so levels is inclusive.
        """
        self._levels = levels
        self._curlevel = 0
        
    def showLevel(self, levelpct):
        """
        Show a percentage - appropriate is calculated here.
        Subclasses should overload this method and call super().showLevel(levelpct)
        to calculate the current level
        """
        
        # if percent is < 5, treat it as 0 - nothing displayed
        # if > 95, treat as full. All levels lit up.
        if levelpct <= 5:
            self._curlevel = 0
        elif levelpct >= 95:
            self._curlevel = self._levels
        else:
            self._curlevel = int(self._levels * levelpct / 100)
        Log.i(f'Showing {levelpct}% with {self._curlevel} levels')
        
class LightStripLevel(LevelDisplay):
    """
    Implementation of the Level display using a NeoPixel lightstrip.
    """
    
    def __init__(self, strip):
        """ constructor. call superclass constructor and save the lightstrip variable"""
        
        super().__init__(strip._numleds)
        self._strip = strip
        Log.i("Creating a Light strip level") 
        
    def showLevel(self, levelpct):
        """ Show the level in the light strip. """
        level = levelpct
        super().showLevel(level)
        if self._curlevel == 0:
            self._strip.off()
            return
        color = WHITE if level < 30 else YELLOW if level < 60 else PURPLE if level < 90 else RED
        self._strip.setColor(color, self._curlevel)
        

class LCDLevel(LevelDisplay):
    """
    Implementation of the Level display using an LCD Display custom chars
    """
    
    def __init__(self, display):
        # LCD display can only show 8 levels so we are fixing it
        super().__init__(8)
        self._display = display
        Log.i("Creating an LCD level") 
        
        # Add the custom chars to the PRAM
        for p in range(0,8):
            arr = [0x00]*8
            for z in range(0,p+1):
                arr[7-z] = 0xff
            self._display.addShape(p, arr)

    def showLevel(self, levelpct, row=0, col=0):
        level = levelpct
        super().showLevel(level)
        if self._curlevel == 0:
            self._display.showText('.       ', row, col)
            return
        for l in range (0, self._curlevel):
            self._display.showText(chr(l), row, col+l)
        if self._curlevel < 8:
            self._display.showText(' '*(8-self._curlevel),row, col+self._curlevel)



LevelDisplay.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 *

class LightStrip(Light):
    """
    Although technically a composite light, a neopixel is a PIO-driven set of lights
    using a single output pin. So you do not send it composite lights, but just the pin
    it is connected to. It is a composite light because it has multiple lights, but
    they cannot technically be controlled individually.
    """

    FILLS = 0
    CHASES = 1
    RAINBOW = 2

    def __init__(self, name='Neopixel', pin=2, numleds=16, brightness=0.5):
        """
        Constructor for neopixel will create its own internal statemachine
        Note that if any other state machine is running, this will break the existing
        statemachine. This refers to the Pico PIO statemachine, not any software state
        machines.
        """
        
        self._name = name
        self._pin = pin
        self._numleds = numleds
        self._brightness = brightness
        self._running = False
        
        Log.i(f'Creating a neopixel {name} on pin {pin} with {numleds} LEDs')
        self._np = neopixel.NeoPixel(machine.Pin(pin), numleds)

    def on(self):
        """ Turn all LEDs ON - all white """

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

    def flip(self):
        """ Flip the clors on all the LEDs """
        for x in range(0, self._numleds):
            self._np[x] = (255-self._np[x][0], 255-self._np[x][1], 255-self._np[x][2])
        self.show()
        Log.i(f'{self._name} flipped')

    def setColor(self, color, numPixels= -1):
        """ Turn all LEDs up to a set number of pixels to a specific color """
        if numPixels < 0 or numPixels > self._numleds:
            numPixels = self._numleds
        for i in range(numPixels):
            self._set_pixel(i, color)
        for i in range(numPixels,self._numleds):
            self._set_pixel(i, BLACK)
        self._np.write()
        Log.i(f'{self._name} set color to {color}')

    def setPixel(self, pixelno, color, show=True):
        """
        Turn a single pixel a specific color
        By default the new color is immediately shown.
        To make multiple changes, you can speed up by setting
        show to False, then calling the show method
        """
        self._set_pixel(pixelno, color)
        if show:
            self._np.write()
        Log.i(f'{self._name} set pixel {pixelno} to color {color}')

    def show(self):
        """
        Shows what is in the color buffer. Useful if previous
        setPixel was called without show On
        """
        
        self._np.write()
        
    def setBrightness(self, brightness=0.5):
        """ Change the brightness of the pixel 0-1 range """
        
        self._brightness = brightness
        Log.i(f'{self._name} set brightness to {brightness}')
        
    def run(self, runtype=0):
        """ Run a single cycle of FILLS, CHASES or 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):
        modifiedcolor = tuple(int(col*self._brightness) for col in color)
        self._np[p] = modifiedcolor

    def _clear(self):
        self._np.fill(BLACK)
        pass

    def _fill(self, color):
        self._np.fill(color)
        pass


    def color_chase(self, color, wait):
        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):
        # Input a value 0 to 255 to get a color value.
        # The colours are a transition r - g - b - back to r.
        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):
        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)


# Some color definitions
BLACK = (0, 0, 0)
RED = (255, 0, 0)
YELLOW = (255, 150, 0)
GREEN = (0, 255, 0)
CYAN = (0, 255, 255)
BLUE = (0, 0, 255)
PURPLE = (180, 0, 255)
WHITE = (255, 255, 255)
ORANGE = (255, 164, 0)
COLORS = (BLACK, RED, YELLOW, GREEN, CYAN, BLUE, PURPLE, WHITE, ORANGE)



LightStrip.py

"""
Log.py - a simplistic Logging process. Built to kind of mimic the
Android Logging process, but at the same time having a global level
set to see the types of logs being displayed.

Basic usage:

Log.level = DEBUG  # set global log level

# Options are: ALL/INFO (everything) DEBUG (debug and higher), ERRO (only errors)
Log.i(f'help')     # Info message: f-strings recommended for showing variables
Log.d(f'value: {v}') # Debug message
Log.e(f'Exception: {x}') # Error message
Log.name('Myproject') # Set a global project name
"""

""" Debug levels """
ALL = 4  # All messages are displayed
INFO = 3  # Basically the same as ALL - for future-proofing
DEBUG = 2  # Info is hidden - debug and higher shown
ERROR = 1  # Only error messages shown
NONE = 0  # No messages are shown from log classes


class Log:

    name = ''
    level = ALL

    @classmethod
    def i(cls, message):
        if (cls.level >= INFO):
            Log.pr(message)

    @classmethod
    def d(cls, message):
        if (cls.level >= DEBUG):
            Log.pr(message)

    @classmethod
    def e(cls, message):
        if (cls.level >= ERROR):
            Log.pr(message)

    @classmethod
    def pr(cls, message):
        if cls.name:
            m = cls.name + ": " + message
        else:
            m = message
        print(m)


if __name__ == '__main__':
    print("Hello")
    Log.level = ALL
    Log.name = 'Test'
    Log.i(f'This should print (level: {Log.level})')
    
    Log.level = ERROR
    Log.i(f'This should NOT print (level: {Log.level})')
    Log.e(f'This should print (level: {Log.level})')
    



Log.py

"""
MicroPython max7219 cascadable 8x8 LED matrix driver
https://github.com/mcauser/micropython-max7219

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.
"""

from micropython import const
import framebuf

_NOOP = const(0)
_DIGIT0 = const(1)
_DECODEMODE = const(9)
_INTENSITY = const(10)
_SCANLIMIT = const(11)
_SHUTDOWN = const(12)
_DISPLAYTEST = const(15)

class Matrix8x8:
    def __init__(self, spi, cs, num):
        """
        Driver for cascading MAX7219 8x8 LED matrices.

        >>> import max7219
        >>> from machine import Pin, SPI
        >>> spi = SPI(1)
        >>> display = max7219.Matrix8x8(spi, Pin('X5'), 4)
        >>> display.text('1234',0,0,1)
        >>> display.show()

        """
        self.spi = spi
        self.cs = cs
        self.cs.init(cs.OUT, True)
        self.buffer = bytearray(8 * num)
        self.num = num
        fb = framebuf.FrameBuffer(self.buffer, 8 * num, 8, framebuf.MONO_HLSB)
        self.framebuf = fb
        # Provide methods for accessing FrameBuffer graphics primitives. This is a workround
        # because inheritance from a native class is currently unsupported.
        # http://docs.micropython.org/en/latest/pyboard/library/framebuf.html
        self.fill = fb.fill  # (col)
        self.pixel = fb.pixel # (x, y[, c])
        self.hline = fb.hline  # (x, y, w, col)
        self.vline = fb.vline  # (x, y, h, col)
        self.line = fb.line  # (x1, y1, x2, y2, col)
        self.rect = fb.rect  # (x, y, w, h, col)
        self.fill_rect = fb.fill_rect  # (x, y, w, h, col)
        self.text = fb.text  # (string, x, y, col=1)
        self.scroll = fb.scroll  # (dx, dy)
        self.blit = fb.blit  # (fbuf, x, y[, key])
        self.init()

    def _write(self, command, data):
        self.cs(0)
        for m in range(self.num):
            self.spi.write(bytearray([command, data]))
        self.cs(1)

    def init(self):
        for command, data in (
            (_SHUTDOWN, 0),
            (_DISPLAYTEST, 0),
            (_SCANLIMIT, 7),
            (_DECODEMODE, 0),
            (_SHUTDOWN, 1),
        ):
            self._write(command, data)

    def brightness(self, value):
        if not 0 <= value <= 15:
            raise ValueError("Brightness out of range")
        self._write(_INTENSITY, value)

    def show(self):
        for y in range(8):
            self.cs(0)
            for m in range(self.num):
                self.spi.write(bytearray([_DIGIT0 + y, self.buffer[(y * self.num) + m]]))
            self.cs(1)

max7219.py

"""
A basic template file for using the Model class in PicoLibrary
This will allow you to implement simple Statemodels with some basic
event-based transitions.

Currently supports only 4 buttons (hardcoded to BTN1 through BTN4)
and a TIMEOUT event for internal tranisitions.

For processing your own events such as sensors, you can implement
those in your run method for transitions based on sensor events.
"""

# Import whatever Library classes you need - Model is obviously needed
import time
import random
from Model import *
from Button import *
from Counters import *
from Log import *

"""
This is the template Model Runner - you should rename this class to something
that is supported by your class diagram. This should associate with your other
classes, and any PicoLibrary classes. If you are using Buttons, you will implement
buttonPressed and buttonReleased.

To implement the model, you will need to implement 3 methods to support entry actions,
exit actions, and state actions.

This template currently implements a very simple state model that uses a button to
transition from state 0 to state 1 then a 5 second timer to go back to state 0.
"""

class MyControllerTemplate:

    def __init__(self):
        
        # Instantiate whatever classes from your own model that you need to control
        # Handlers can now be set to None - we will add them to the model and it will
        # do the handling
        self._button = Button(20, "button1", buttonhandler=None)
        self._timer = SoftwareTimer(None)
        
        # Instantiate a Model. Needs to have the number of states, self as the handler
        # You can also say debug=True to see some of the transitions on the screen
        # Here is a sample for a model with 4 states
        self._model = Model(2, self, debug=True)
        
        # Up to 4 buttons and a timer can be added to the model for use in transitions
        # Buttons must be added in the sequence you want them used. The first button
        # added will respond to BTN1_PRESS and BTN1_RELEASE, for example
        self._model.addButton(self._button)
        # add other buttons (up to 3 more) if needed
        
        # Add any timer you have.
        self._model.addTimer(self._timer)
        
        # Now add all the transitions that are supported by my Model
        # obvously you only have BTN1_PRESS through BTN4_PRESS
        # BTN1_RELEASE through BTN4_RELEASE
        # and TIMEOUT
        
        # some examples:
        self._model.addTransition(0, [BTN1_PRESS], 1)
        self._model.addTransition(1, [TIMEOUT], 0)
        # etc.
    
    """
    Create a run() method - you can call it anything you want really, but
    this is what you will need to call from main.py or someplace to start
    the state model.
    """

    def run(self):
        # The run method should simply do any initializations (if needed)
        # and then call the model's run method.
        # You can send a delay as a parameter if you want something other
        # than the default 0.1s. e.g.,  self._model.run(0.25)
        self._model.run()

    """
    stateDo - the method that handles the do/actions for each state
    """
    def stateDo(self, state):
            
        # Now if you want to do different things for each state you can do it:
        if state == 0:
            # State 0 do/actions
            pass
        elif state == 1:
            # State1 do/actions
            # You can check your sensors here and perform transitions manually if needed
            # For example, if you want to go from state 1 to state 2 when the motion sensor
            # is tripped you can do something like this
            # if self.motionsensor.tripped():
            # 	gotoState(2)
            pass

    """
    stateEntered - is the handler for performing entry/actions
    You get the state number of the state that just entered
    Make sure actions here are quick
    """
    def stateEntered(self, state, event):
        # Again if statements to do whatever entry/actions you need
        if state == 0:
            # entry actions for state 0
            Log.d('State 0 entered')
            pass
        
        elif state == 1:
            # entry actions for state 1
            Log.d('State 1 entered')
            self._timer.start(5)
        
            
    """
    stateLeft - is the handler for performing exit/actions
    You get the state number of the state that just entered
    Make sure actions here are quick
    
    This is just like stateEntered, perform only exit/actions here
    """

    def stateLeft(self, state, event):
        pass

    

# Test your model. Note that this only runs the template class above
# If you are using a separate main.py or other control script,
# you will run your model from there.
if __name__ == '__main__':
    MyControllerTemplate().run()

ModelTemplate.py

"""
Motors.py - a class containing code to drive different types
of motors.
# Author: Arijit Sengupta
"""

from machine import Pin, PWM
from time import sleep


class Motor:
    """
    A Motor superclass just to keep things together if we need to
    Currently simply stores the main pin (some motors take multiple pins)
    and a name for the motor.
    """
    def __init__(self, pin, name='Unnamed Motor'):
        self._pin = pin
        self._name = name


class Stepper(Motor):
    """
    A stepper motor is a powerful precision motor that can be controlled to 
    any angle (0-360). Usually requires a lot more power than what the
    Pico can deliver so will most likely need a separate power supply.
    Also requires a separate stepper motor driver since the current requirements
    are also higher than what the Pico can deliver.

    Different drivers exist - Wokwi supports the A4988 motor driver so 
    that is what I am implementing here.
    """

    def __init__(self, steppin=27, dirpin=26, *, name='Unnamed Stepper'):
        """
        For a stepper driven by A4988, we need two inputs - step and dir
        Technically there are 2 additional ones - reset and sleep but
        we are not using them here.
        """

        super().__init__(steppin, name)
        self._dirpin = dirpin
        self._step = Pin(steppin, Pin.OUT)
        self._dir = Pin(dirpin, Pin.OUT)
        self._curPos = 0 # Does a stepper go to 0 automatically?
        self._running = False

    def setAngle(self, angle):
        """
        set the stepper angle to a value in degrees. Technically can
        be any number. Note that higher than 360 will cause multiple
        rotations of the stepper.
        """

        self.rotate(angle - self._curPos)
        self._running = False

    def rotate(self, angle):
        """
        Rotate the servo by a certain angle.
        positive will be clockwise, negative will be anti-clockwise
        
        Again, technically can be any value - but higher than 360 will
        cause multiple rotations
        """

        numsteps = round(float(angle)/1.8)
        if numsteps < 0:
            self._dir.value(0)
            numsteps = numsteps * -1
        else:
            self._dir.value(1)
        
        for x in range (0,numsteps):
            self._step.value(1)
            sleep(0.01)
            self._step.value(0)
        
        self._curPos = self._curPos + angle
        self._running = False

    def spin(self, times=1, direction=1, speed=0):
        """
        Make the stepper spin at a certain speed. Note that this
        is a blocking call until the number of times is reached.

        speed is technically a delay between steps in seconds
        0 is full speed and 0.1 is 100 ms etc.

        times is the number of full rotations the stepper will make
        0 for times will keep the motor spinning forever.

        direction is 1 for clockwise, -1 for anti-clockwise

        We try to keep track of the current position, but after spinning,
        the position may be off.
        """

        if direction != 0:
            direction = 1
        self._running = True
        self._dir.value(direction)
        self._curPos = self._curPos % 360 # Let's forget higher spin positions
        n = 0
        
        while self._running and (times == 0 or n < times):
            n = n + 1
            for x in range(0,200):
                self._step.value(1)
                sleep(0.001 + speed)
                self._step.value(0)
                self._curPos = self._curPos + 1.8 * (1 if direction else -1)
                if self._curPos >= 360 or self._curPos < 0:
                    self._curPos = self._curPos % 360

class Servo(Motor):
    def __init__(self, pin, name='Unnamed Servo'):
        super().__init__(pin, name)
        self._pwm = PWM(Pin(self._pin))
        self._pwm.freq(50)
        self._curPos = -1 # Initially position is unknown

    def setAngle(self, angle):
        """
        set the servo angle to something between 0 and 180
        Anything less than 0 will be treated as 0, anything
        more will be treated as 180

        Note for Wokwi:
        Wokwi has 0 at 1500 duty, 180 at 8000 duty
        So duty = int((8000-1500)*float(angle)/180.0)
        """

        if angle < 0:
            angle = 0
        if angle > 180:
            angle = 180

        duty = int((8000-1500)*float(angle)/180.0)+1500
        self._pwm.duty_u16(duty)
        self._curPos = angle

    def rotate(self, angle):
        """
        Rotate the servo by a certain angle.
        positive will be clockwise, negative will be anti-clockwise
        Rotating below 0 will set it to 0
        First rotation will set to 90, unless an angle is set before
        """

        if self._curPos < 0:
            self.setAngle(90)
        else:
            self.setAngle(self._curPos + angle)
        


Motors.py

"""
Net.py - a simple implementation of a Network class in Micropython
Adapted by Arijit Sengupta from Adafruit/StackOverflow

This is not thoroughly tested - use at your own risk
"""

import time
import network
import urequests as requests
import ubinascii
from Log import *

class Net:
    
    def __init__(self, ssid, password):
        """
        Initialize wifi access point with an ssid and password
        Note that empty passwords are accepted so you can connect to secure
        networks with an empty password ""
        For unsecured networks, use None for password
        """
        
        self._ssid = ssid
        self._password = password
        self._wlan = None
        self._blink = False
        self._wlan = network.WLAN(network.STA_IF)
        
    def connect(self, max_wait=10):
        """
        Connect to the wifi network with a maximum wait time
        """
        self._wlan.active(True)
        if self._password != None:
            self._wlan.connect(self._ssid, self._password)
        else:
            self._wlan.connect(self._ssid, security=0)

        # Wait for connection to establish
        Log.i(f'Net: connecting to {self._ssid}')
        print('waiting for connection...', end="")
        while max_wait > 0:
            if self._wlan.status() < 0 or self._wlan.status() >= 3:
                    break
            max_wait -= 1
            print('.', end="")
            time.sleep(1)
            
        # Manage connection errors
        if self._wlan.status() != 3:
            raise RuntimeError('Network Connection has failed!')
        else:
            print("Connected!")
            Log.i('Net: connected!')
    
    def disconnect(self):
        """ Disconnect from wifi network """
        self._wlan.disconnect()
        self._wlan.active(False)
        
    
    def getLocalIp(self):
        """ Get the local IP address as a string """

        if self._wlan.active():
            info = self._wlan.ifconfig()
            return info[0]
        else:
            return 'Not connected'
        
    def getMac(self):
        mac = ubinascii.hexlify(self._wlan.config('mac'),':').decode()
        return mac
        
    def updateTime(self, timezone = 'America/New_York'):
        """ Update local time using an the world timeapi """
        
        apiendpoint = 'https://worldtimeapi.org/api/timezone/' + timezone
        json = self.getJson(apiendpoint)
        if json:
            unixtime = json['unixtime']
            raw_offset = json['raw_offset']
            dst_offset = json['dst_offset']
            unixtime = unixtime + raw_offset + dst_offset
            import machine
            tm = time.gmtime(unixtime)
            machine.RTC().datetime((tm[0], tm[1], tm[2], tm[6] + 1, tm[3], tm[4], tm[5], 0))
        return time.localtime()

    def getFormattedTime(self, extra='day'):
        """
        Get the local time as a String that fits a 16 char line
        If shorter strings are desired, just use time.localtime and format as needed

        extra can be one of 'day' (shows weekday)
                            'year' shows the year
                            'sec' shows seconds
        Unfortunately only one extra can be chosen
        """
        wk = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
        mon = ['Jan','Feb','Mar','Apr','May','Jun','Jul','Aug','Sep','Oct','Nov','Dec']
        (yy, mm, dd, h, m, s, w, y) = time.localtime()
        self._blink = not self._blink
        col = ':' if self._blink else ' '
        if extra == 'sec':
            return f'{mon[mm-1]}-{dd:02} {h:02}:{m:02}:{s:02}'
        elif extra == 'day':
            return f'{wk[w]} {mon[mm-1]} {dd:02} {h:02}{col}{m:02}'
        else:
            return f'{mm:02}/{dd:02}/{yy:04} {h:02}{col}{m:02}'

    def getJson(self, url):
        """
        Get the JSON data from a REST API. Only valid JSON supported.
        Only GET for now. No POST or PUT. Returns the parsed json structure
        """
        
        try:
            if self._wlan == None:
                self.connect()
            data=requests.get(url)
            jsondata = data.json()
            data.close()
            return jsondata
        except:
            Log.e("could not connect (status =" + str(self._wlan.status()) + ")")
            return None



Net.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

# PicoLibrary

A collection of classes around the Raspberry Pi Pico Hardware interface to make it easy to 
work with Lights (LEDs, RGB LEDs), Sound (active and passive buzzers), Displays (Dot matrix 
with Max7219, 7 segment displays bare and with TM 1637, 160x LCD modules with I2C backpacks
and without I2C, as well as OLED/LCD displays with I2C).

Also includes simple support for buttons and a basic implementation of a state model for
creating simple state machines.

Currently supported hardware - (more to be added)

* Buttons - both pulled-down and pulled-up buttons supported
* Buzzers - both active and passive buzzers supported
* LEDs - Basic LEDs (on/off) and Dimmable LEDs (setting brightness level)
* Composite lights - TrafficLight (red, yellow, green), Pixel (R, G, B) and NeoPixel (PIO)
* Displays - 160x displays (both I2C as well has GPIO)
* Displays - OLED displays (SSD1306 driver)
* Displays - 7 segment displays (both sda/scl controlled as well as bit-banged using PIO)
* LED matrix displays - (MAX7219 driver)
* Sensors - both ditigal (0/1) as well as Analog (ADC 16 bit) sensors

Contact Dr. Sengupta if you need support for any other hardware


README.md

"""
Scanner.py - simple implementation of blocking or unblocking barcode scanner
Written by Arijit Sengupta
Uses stdin to read items scanned.
"""
import sys, select

class Scanner:
    """
    A simplistic Scanner class - give it a prompt and get a response back
    either within a timeout or by blocking indefinitely
    
    No init method - has no attributes
    """
    
    def scanData(self, prompt='Scan code: ', timeout=-1, clear=True) -> str:
        """
        show a prompt, and wait indefinitely (timeout -1 )
        or wait for a certain amount of time (timeout a positive integer)
        returns None if nothing was scanned within the timeout period
        
        Usage:
        s = Scanner()
        barcode = s.Data() # blocking scan
        data = s.scanData(timeout=5) # Wait 5 secondes to enter code

        NOTE - if using in Wokwi, input buffer does not need to be cleared
        NOTE 2. Wokwi does not seem to echo the keyboard data - I may be missing something
        data = s.scanData(timeout=5, clear=False) # no need to clear stdin
        """
        if timeout <=0:
            return input(prompt)
        else:
            print(prompt, end='')
            i, o, e = select.select( [sys.stdin], [], [], timeout)

            if (i):
                l1 = sys.stdin.readline().strip()
                # for some reason on the pico hitting enter causes
                # two scans. This is a temp fix until we can find a
                # better option
                if clear:
                    l2 = sys.stdin.readline().strip()
                    while l2:
                        l2 = sys.stdin.readline().strip()
                return l1
            else:
              return None


Scanner.py

"""
# Sensors.py
# A simple Sensor hierarchy for digital and analog sensors
# Added support for Ultrasonic Sensor on 9/11/23
# Author: Arijit Sengupta
"""

from machine import Pin, ADC
import utime
import math
from Log import *

class Sensor:
    """
    The top level sensor class - assume each sensor uses 
    at least one pin. We do not create the IO here because
    some sensors may use Analog inputs
    
    Parameters
    --------
    pin: pin number where the sensor is connected
    lowactive: set to True if the sensor gets low (or under threshold)
    when tripped. So an analog light sensor should normally get a high
    value but when covered, go low. So lowactive should be True
    
    A force sensor would be opposite - tripped when force gets high
    so lowactive should be False
    """
    
    def __init__(self, pin, lowactive = True):
        self._pin = pin
        self._lowactive = lowactive
        
    def tripped(self)->bool:
        Log.e(f"tripped not implemented for {type(self).__name__}")
        return False

class DigitalSensor(Sensor):
    """
    A simple digital sensor (like the commonly available LC-393 that is a light sensor)
    has a digital output that flips based on a manual threshold control

    We are just going to poll this to keep things simple
    """
    
    def __init__(self, pin, lowactive=True):
        super().__init__(pin, lowactive)
        self._pinio = Pin(self._pin, Pin.IN)

    def tripped(self)->bool:
        v = self._pinio.value()
        if (self._lowactive and v == 0) or (not self._lowactive and v == 1):
            Log.i("DigitalLightSensor: sensor tripped")
            return True
        else:
            return False
        
class TiltSensor(DigitalSensor):
    """
    A tilt sensor looks like a cap but has just a metal ball on two contacts
    when you tilt, the ball rolls off and the contact opens. That way its very
    much like a button which is always pressed.
    """
    
    def __init__(self, pin):
        # Init - do not call the super init - just create the Pin.

        self._pin = Pin(pin, Pin.IN, Pin.PULL_UP)
        
    def tripped(self):
        return self._pin.value() == 1

class AnalogSensor(Sensor):
    """
    A simple analog sensor that returns a voltage or voltage ratio output
    that can be read in using an ADC. Pico reads in via a 16bit unsigned

    We are just going to poll this to keep things simple
    """
    
    def __init__(self, pin, lowactive=True, threshold = 30000):
        """ analog sensors will need to be sent a threshold value to detect trip """
        
        super().__init__(pin, lowactive)
        self._pinio = ADC(self._pin)
        self._threshold = threshold

    def tripped(self)->bool:
        """ sensor is tripped if sensor value is higher or lower than threshold """
        
        v = self.rawValue()
        if (self._lowactive and v < self._threshold) or (not self._lowactive and v > self._threshold):
            Log.i("AnalogSensor: sensor tripped")
            return True
        else:
            return False

    def rawValue(self):
        return self._pinio.read_u16()

class TempSensor(AnalogSensor):
    """
    Temperature sensor as a subclass of Analog Sensor - Temp sensor is a bit more
    defined since it technically returns a temperature. Note that thermistors are
    not totally accurate, but the teperature fluctuations - increases and decreases
    are what matters.
    """
    
    def __init__(self, pin, lowactive=False, threshold=60):
        """
        Create a new temp sensor - similar to regular analog sensor
        but now tripped will return true when temp is lower than threshold (lowactive=True)
        and higher than threshold (lowactive=False)
        """
        
        super().__init__(pin, lowactive, threshold)
        
    def rawValue(self):
        """
        Reture the temperature (approx) in fahrenheit
        """
        
        adcvalue = super().rawValue()
        voltage = adcvalue / 65535.0 * 5
        Rt = 10 * voltage / (5 -voltage)
        tempK = (1 / (1 / (273.15+25) + (math.log(Rt/10)) / 3950))
        tempF = int((tempK - 273.15) * 1.8) + 32
        return tempF
        
class UltrasonicSensor(Sensor):
    """
    A simple implementation of an ultrasonic sensor with digital IO
    pins for trigger and echo.
    
    While technically Ultrasonic sensor is not an analog sensor since it
    uses digital pins, it does have continuous data, so subclassing
    AnalogSensor makes more sense. But given AnalogSensor should only be
    used in ADC pins, it is better to subclass the Sensor superclass.
    
    Continuing to use the lowactive and threshold like AnalogSensor however.

    init by sending trigger, echo and optionally lowactive and threshold
    parameters. Threshold defaults to 10cm, and lowactive defaults to true
    so when distance is < 10cm, it will return true for tripped.
    """

    def __init__(self, trigger, echo, *, lowactive = True, threshold=10.0):
        super().__init__(trigger, lowactive)
        self._trigger = Pin(trigger, Pin.OUT)
        self._echo = Pin(echo, Pin.IN)
        self._threshold = threshold

    def getDistance(self)->float:
        """ Get the distance of obstacle from the sensor in cm """
        
        self._trigger.low()
        utime.sleep_us(2)
        self._trigger.high()
        utime.sleep_us(5)
        self._trigger.low()
        while self._echo.value() == 0:
            signaloff = utime.ticks_us()
        while self._echo.value() == 1:
            signalon = utime.ticks_us()
        timepassed = signalon - signaloff
        distance = (timepassed * 0.0343) / 2
        return distance

    def tripped(self)->bool:
        """ sensor is tripped if distance is higher or lower than threshold """
        
        v = self.getDistance()
        if (self._lowactive and v < self._threshold) or (not self._lowactive and v > self._threshold):
            Log.i("UltrasonicSensor: sensor tripped")
            return True
        else:
            return False


Sensors.py

"""
# SevenSegSingle.py
# A simple implementation of a single seven segment display
# unit. Raw unit connected either directly through GPIO pins
# or using a shift register.
# To create the raw unit, send A=n, B=n, C=n... E=n as parameters
# To create the shift register version, send
# dataPin, clockPin and latchPin nos
#
# See a demo at: https://wokwi.com/projects/365454777517844481
# Author: Arijit Sengupta
"""


from machine import Pin
import random
import utime
import time

class SevenSegSingle:
    """
    SevenSegSingle class - implementation of a single seven-segment display
    Can be connected directly via GPIO or via a shift register

    Currently only displays numbers.
    
    Now supports both common-Cathode as well as common-Anode style displays
    
    Create a parallel common Cathode version:
    
    d = SevenSegSingle(A=0, B=1, C=2, D=3, E=4, F=5, G=6, commonCathode=True)
    
    Create a shift-registered common anode version:
    
    d = SevenSegSingle(dataPin=25, clockPin=26, latchPin=27, commonCathode=False)
    """

    def __init__(self, A=0, B=1, C=2, D=3, E=4, F=5, G=6,
                     commonCathode=True, *, dataPin=None, clockPin=None, latchPin=None):
        """
        Constructor - call as SevenSeg(A=n, B=n, C=n... G=n) for direct connection
        or as  SevenSeg(dataPin=n, clockPin=n, latchPin=n) if using a shift register
        """
  
        pinarray = [A, B, C, D, E, F, G]
        self._digitcodes = ["11111100", "01100000", "11011010", "11110010", "01100110",
                                "10110110", "10111110", "11100000", "11111110", "11110110"]
        self.commcathode = commonCathode
        self._parallelPins = []
        if dataPin is None:
            for p in range(0, 7):
                self._parallelPins.append(Pin(pinarray[p],Pin.OUT))
                self._data = None
        else:
            self._data = Pin(dataPin, Pin.OUT)
            self._latch = Pin(latchPin, Pin.OUT)
            self._clock = Pin(clockPin, Pin.OUT)

    def show(self, n):
        """
        Show a number on the seven segment display - only supports 0-9
        """

        if n < 0 or n > 9:
            raise ValueError('This class can only display a number between 0-9')
        else:
            if self._data is None:
                self._parallel_update(self._digitcodes[n])
            else:
                self._shift_update(self._digitcodes[n])

    def _valueOf(self, val)->int:
        if self.commcathode:
            return int(val)
        else:
            return 0 if int(val) == 1 else 1 

    def _parallel_update(self, input):
        for i in range(0,7):
            self._parallelPins[i].value(self._valueOf(input[i])) 

    def _shift_update(self, input):
        #put latch down to start data sending
        self._clock.value(0)
        self._latch.value(0)
        self._clock.value(1)

        #load data in reverse order
        for i in range(7, -1, -1):
            self._clock.value(0)
            self._data.value(self._valueOf(input[i]))
            self._clock.value(1)

        #put latch up to store data on register
        self._clock.value(0)
        self._latch.value(1)
        self._clock.value(1)

### Test this module if needed. Direct connect uses the default
### A=0 through G=7

if __name__ == '__main__':
    d1 = SevenSegSingle(dataPin = 16, clockPin = 18, latchPin = 17)
    d2 = SevenSegSingle()
    for i in range(0,100000):
        d1.show(i%10)
        d2.show(i%10)
        time.sleep(0.3)



SevenSegSingle.py

"""Source: Instructables, Tom's Hardware and GitHub """
"""Not Authored by Dr. Sengupta """
""" MicroPython SSD1306 OLED driver, I2C and SPI interfaces """

from micropython import const
import framebuf


# register definitions
SET_CONTRAST = const(0x81)
SET_ENTIRE_ON = const(0xA4)
SET_NORM_INV = const(0xA6)
SET_DISP = const(0xAE)
SET_MEM_ADDR = const(0x20)
SET_COL_ADDR = const(0x21)
SET_PAGE_ADDR = const(0x22)
SET_DISP_START_LINE = const(0x40)
SET_SEG_REMAP = const(0xA0)
SET_MUX_RATIO = const(0xA8)
SET_COM_OUT_DIR = const(0xC0)
SET_DISP_OFFSET = const(0xD3)
SET_COM_PIN_CFG = const(0xDA)
SET_DISP_CLK_DIV = const(0xD5)
SET_PRECHARGE = const(0xD9)
SET_VCOM_DESEL = const(0xDB)
SET_CHARGE_PUMP = const(0x8D)

# Subclassing FrameBuffer provides support for graphics primitives
# http://docs.micropython.org/en/latest/pyboard/library/framebuf.html
class SSD1306(framebuf.FrameBuffer):
    def __init__(self, width, height, external_vcc):
        self.width = width
        self.height = height
        self.external_vcc = external_vcc
        self.pages = self.height // 8
        self.buffer = bytearray(self.pages * self.width)
        super().__init__(self.buffer, self.width, self.height, framebuf.MONO_VLSB)
        self.init_display()

    def init_display(self):
        for cmd in (
            SET_DISP | 0x00,  # off
            # address setting
            SET_MEM_ADDR,
            0x00,  # horizontal
            # resolution and layout
            SET_DISP_START_LINE | 0x00,
            SET_SEG_REMAP | 0x01,  # column addr 127 mapped to SEG0
            SET_MUX_RATIO,
            self.height - 1,
            SET_COM_OUT_DIR | 0x08,  # scan from COM[N] to COM0
            SET_DISP_OFFSET,
            0x00,
            SET_COM_PIN_CFG,
            0x02 if self.width > 2 * self.height else 0x12,
            # timing and driving scheme
            SET_DISP_CLK_DIV,
            0x80,
            SET_PRECHARGE,
            0x22 if self.external_vcc else 0xF1,
            SET_VCOM_DESEL,
            0x30,  # 0.83*Vcc
            # display
            SET_CONTRAST,
            0xFF,  # maximum
            SET_ENTIRE_ON,  # output follows RAM contents
            SET_NORM_INV,  # not inverted
            # charge pump
            SET_CHARGE_PUMP,
            0x10 if self.external_vcc else 0x14,
            SET_DISP | 0x01,
        ):  # on
            self.write_cmd(cmd)
        self.fill(0)
        self.show()

    def poweroff(self):
        self.write_cmd(SET_DISP | 0x00)

    def poweron(self):
        self.write_cmd(SET_DISP | 0x01)

    def contrast(self, contrast):
        self.write_cmd(SET_CONTRAST)
        self.write_cmd(contrast)

    def invert(self, invert):
        self.write_cmd(SET_NORM_INV | (invert & 1))

    def show(self):
        x0 = 0
        x1 = self.width - 1
        if self.width == 64:
            # displays with width of 64 pixels are shifted by 32
            x0 += 32
            x1 += 32
        self.write_cmd(SET_COL_ADDR)
        self.write_cmd(x0)
        self.write_cmd(x1)
        self.write_cmd(SET_PAGE_ADDR)
        self.write_cmd(0)
        self.write_cmd(self.pages - 1)
        self.write_data(self.buffer)


class SSD1306_I2C(SSD1306):
    def __init__(self, width, height, i2c, addr=0x3C, external_vcc=False):
        self.i2c = i2c
        self.addr = addr
        self.temp = bytearray(2)
        self.write_list = [b"\x40", None]  # Co=0, D/C#=1
        super().__init__(width, height, external_vcc)

    def write_cmd(self, cmd):
        self.temp[0] = 0x80  # Co=1, D/C#=0
        self.temp[1] = cmd
        self.i2c.writeto(self.addr, self.temp)

    def write_data(self, buf):
        self.write_list[1] = buf
        self.i2c.writevto(self.addr, self.write_list)


class SSD1306_SPI(SSD1306):
    def __init__(self, width, height, spi, dc, res, cs, external_vcc=False):
        self.rate = 10 * 1024 * 1024
        dc.init(dc.OUT, value=0)
        res.init(res.OUT, value=0)
        cs.init(cs.OUT, value=1)
        self.spi = spi
        self.dc = dc
        self.res = res
        self.cs = cs
        import time

        self.res(1)
        time.sleep_ms(1)
        self.res(0)
        time.sleep_ms(10)
        self.res(1)
        super().__init__(width, height, external_vcc)

    def write_cmd(self, cmd):
        self.spi.init(baudrate=self.rate, polarity=0, phase=0)
        self.cs(1)
        self.dc(0)
        self.cs(0)
        self.spi.write(bytearray([cmd]))
        self.cs(1)

    def write_data(self, buf):
        self.spi.init(baudrate=self.rate, polarity=0, phase=0)
        self.cs(1)
        self.dc(1)
        self.cs(0)
        self.spi.write(buf)
        self.cs(1)

ssd1306.py

"""
# StateModel.py
# A State model implementation
# Author: Arijit Sengupta
"""
import time
from Log import *

NO_EVENT = 0
BTN1_PRESS = 1
BTN1_RELEASE = 2
BTN2_PRESS = 3
BTN2_RELEASE = 4
BTN3_PRESS = 5
BTN3_RELEASE = 6
BTN4_PRESS = 7
BTN4_RELEASE = 8
TIMEOUT = 9

NUMEVENTS = 10
EVENTNAMES = ["NO_EVENT", "BTN1_PRESS", "BTN1_RELEASE", "BTN2_PRESS","BTN2_RELEASE",
                "BTN3_PRESS", "BTN3_RELEASE", "BTN4_PRESS","BTN4_RELEASE",
                "TIMEOUT"]

class StateModel:
    """
    A really simple implementation of a generic state model
    Keeps track of a number of states by sending the total number
    of states to the constructor. State numbers always start from 0
    which is the start state.

    Also takes a handler which is just a reference to a class that has
    three responder methods. The responder methods for stateEntered and
    stateLeft receives the state that was entered or left,
    with the event code that caused it. stateDo only receives the current
    state.
    
        stateEntered(state, event)
        stateLeft(state, event)
        stateDo(state)

    Currently there are 10 hardcoded events that are supported.
    
    * BTN1_PRESS/RELEASE through BTN4_PRESS/RELEASE are for button presses
    and releases - in the order they are created.
    * TIMEOUT is the event for a software or hardware timer. Only one
    timer can be active at a time
    * NO_EVENT is for non-event-related transitions. So if a state performs 
    the entry actions and do actions and then immediately goes to the next state, 
    NO_EVENT can be used. 

    The calling class or the handler must override stateEntered and
    stateLeft to perform actions as per the state model

    After creating the state, call addTransition to determine
    how the model transitions from one state to the next.

    As events start coming in, call processEvent on the event to
    have the state model transition as per the transition matrix.
    """
    
    def __init__(self, numstates, handler, debug=False):
        """
        The statemodel constructor - needs 2 things minimum:
        Parameters
        ----------
        numstates - the number of states in the State model (includes the start and end states)
        handler - the handler class that should implement the model actions stateEntered and stateLeft
         - stateEntered will receive as parameter which state the model has entered - this should
            allow the handler to execute entry actions
         - stateLeft will receive as parameter which state the model left - this will allow the handler
            to execute the exit actions.
        all continuous in-state actions must be implemented in the handler in a execute loop.
        
        debug will print things to the screen like active state, transitions, events, etc.
        """
        
        self._numstates = numstates
        self._running = False
        self._transitions = []
        for i in range(0, numstates):
            self._transitions.append([None]*NUMEVENTS)
        self._curState = -1
        self._handler = handler
        self._debug = debug
        self._buttons = []
        self._timer = None

    def addTransition(self, fromState, events, toState):
        """
        Once the model is created, you must add all the transitions
        for known events. The model can handle events for button presses
        up to 4 buttons are supported. And it can also handle a timeout
        event created by a software or hardware timer. See documentation
        of the Counters classes to see how to use them.
        """
        for event in events:
            self._transitions[fromState][event] = toState
    
    def start(self):
        """ start the state model - always starts at state 0 as the start state """
        
        self._curState = 0
        self._running = True
        self._handler.stateEntered(self._curState, NO_EVENT)  # start the state model

    def stop(self):
        """
        stop the state model - this will call the handler one last time with
        what state was stopped at, and then set the running flag to false.
        """
    
        if self._running:
            self._handler.stateLeft(self._curState, NO_EVENT)
        self._running = False
        self._curState = -1

    def gotoState(self, newState, event=NO_EVENT):
        """
        force the state model to go to a new state. This may be necessary to call
        in response to an event that is not automatically handled by the Model class.
        This will correctly call the stateLeft and stateEntered handlers
        """
        
        if (newState < self._numstates):
            if self._debug:
                Log.d(f"Going from State {self._curState} to State {newState}")
            self._handler.stateLeft(self._curState, event)
            self._curState = newState
            self._handler.stateEntered(self._curState, event)

    def processEvent(self, event):
        """
        Get the model to process an event. The event should be one of the events defined
        at the top of the model class. Currently 4 button press and release events, and
        a timeout event is supported. Handlers for the buttons and the timers should be
        incorporated in the main class, and processevent should be called when these handlers
        are triggered.
        
        I may try to improve this design a bit in the future, but for now this is how it is
        built.
        """
        
        if (event < NUMEVENTS):
            newstate = self._transitions[self._curState][event]
            if newstate is None:
                if self._debug:
                    if event != NO_EVENT:
                        Log.d(f"Ignoring event {EVENTNAMES[event]}")
            else:
                if self._debug:
                    Log.d(f"Processing event {EVENTNAMES[event]}")
                self.gotoState(self._transitions[self._curState][event], event)

    def run(self, delay=0.1):        
        # Start the model first
        self.start()
        # Then it should do a continous loop while the model runs
        while self._running:
            # Inside, you can use if statements do handle various do/actions
            # that you need to perform for each state
            # Do not perform entry and exit actions here - those are separate
                        
            self._handler.stateDo(self._curState)
            self.processEvent(NO_EVENT)
            # Ping the timer if it is a software timer
            if self._timer is not None and type(self._timer).__name__ == 'SoftwareTimer':
                self._timer.check()
            
            # I suggest putting in a short wait so you are not overloading the poor Pico
            if delay > 0:
                time.sleep(delay)

    def addButton(self, btn):
        if len(self._buttons) < 4:
            btn.setHandler(self)
            self._buttons.append(btn)
        else:
            raise ValueError('Currently we only support up to 4 buttons')

    def buttonPressed(self, name):
        """ 
        The internal button handler - now Model can take care of buttons
        that have been added using the addButton method.
        """

        for i in range(0,len(self._buttons)):
            if name == self._buttons[i]._name:
                if i == 0:
                    self.processEvent(BTN1_PRESS)
                elif i == 1:
                    self.processEvent(BTN2_PRESS)
                elif i == 2:
                    self.processEvent(BTN3_PRESS)
                elif i == 3:
                    self.processEvent(BTN4_PRESS)

    """
    Same thing with Button release, if you want to handle release events
    As well as press or just want to do release events only.
    """
    def buttonReleased(self, name):
        for i in range(0,len(self._buttons)):
            if name == self._buttons[i]._name:
                if i == 0:
                    self.processEvent(BTN1_RELEASE)
                elif i == 1:
                    self.processEvent(BTN2_RELEASE)
                elif i == 2:
                    self.processEvent(BTN3_RELEASE)
                elif i == 3:
                    self.processEvent(BTN4_RELEASE)

    def addTimer(self, timer):
        self._timer = timer
        self._timer.setHandler(self)

    """
    If you are using a timer, handle the timeout callback
    My model can use timeout events for transitions, so simply
    send the event to the model and it will take care of
    the rest.
    """
    def timeout(self):
        self.processEvent(TIMEOUT)


StateModel.py

"""
MicroPython TM1637 quad 7-segment LED display driver
https://github.com/mcauser/micropython-tm1637

MIT License
Copyright (c) 2016 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.
"""

from micropython import const
from machine import Pin
from time import sleep_us, sleep_ms

TM1637_CMD1 = const(64)  # 0x40 data command
TM1637_CMD2 = const(192) # 0xC0 address command
TM1637_CMD3 = const(128) # 0x80 display control command
TM1637_DSP_ON = const(8) # 0x08 display on
TM1637_DELAY = const(10) # 10us delay between clk/dio pulses
TM1637_MSB = const(128)  # msb is the decimal point or the colon depending on your display

# 0-9, a-z, blank, dash, star
_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')

class TM1637(object):
    """Library for quad 7-segment LED modules based on the TM1637 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(TM1637_DELAY)

        self._write_data_cmd()
        self._write_dsp_ctrl()

    def _start(self):
        self.dio(0)
        sleep_us(TM1637_DELAY)
        self.clk(0)
        sleep_us(TM1637_DELAY)

    def _stop(self):
        self.dio(0)
        sleep_us(TM1637_DELAY)
        self.clk(1)
        sleep_us(TM1637_DELAY)
        self.dio(1)

    def _write_data_cmd(self):
        # automatic address increment, normal mode
        self._start()
        self._write_byte(TM1637_CMD1)
        self._stop()

    def _write_dsp_ctrl(self):
        # display on, set brightness
        self._start()
        self._write_byte(TM1637_CMD3 | TM1637_DSP_ON | self._brightness)
        self._stop()

    def _write_byte(self, b):
        for i in range(8):
            self.dio((b >> i) & 1)
            sleep_us(TM1637_DELAY)
            self.clk(1)
            sleep_us(TM1637_DELAY)
            self.clk(0)
            sleep_us(TM1637_DELAY)
        self.clk(0)
        sleep_us(TM1637_DELAY)
        self.clk(1)
        sleep_us(TM1637_DELAY)
        self.clk(0)
        sleep_us(TM1637_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, segments, pos=0):
        """Display up to 6 segments moving right from a given position.
        The MSB in the 2nd segment controls the colon between the 2nd
        and 3rd segments."""
        if not 0 <= pos <= 5:
            raise ValueError("Position out of range")
        self._write_data_cmd()
        self._start()

        self._write_byte(TM1637_CMD2 | pos)
        for seg in segments:
            self._write_byte(seg)
        self._stop()
        self._write_dsp_ctrl()

    def encode_digit(self, digit):
        """Convert a character 0-9, a-f to a segment."""
        return _SEGMENTS[digit & 0x0f]

    def encode_string(self, string):
        """Convert an up to 4 character length string containing 0-9, a-z,
        space, dash, star to an array of segments, matching the length of the
        source string."""
        segments = bytearray(len(string))
        for i in range(len(string)):
            segments[i] = self.encode_char(string[i])
        return segments

    def encode_char(self, char):
        """Convert a character 0-9, a-z, space, dash or star to a segment."""
        o = ord(char)
        if o == 32:
            return _SEGMENTS[36] # space
        if o == 42:
            return _SEGMENTS[38] # star/degrees
        if o == 45:
            return _SEGMENTS[37] # dash
        if o >= 65 and o <= 90:
            return _SEGMENTS[o-55] # uppercase A-Z
        if o >= 97 and o <= 122:
            return _SEGMENTS[o-87] # lowercase a-z
        if o >= 48 and o <= 57:
            return _SEGMENTS[o-48] # 0-9
        raise ValueError("Character out of range: {:d} '{:s}'".format(o, chr(o)))

    def hex(self, val):
        """Display a hex value 0x0000 through 0xffff, right aligned."""
        string = '{:04x}'.format(val & 0xffff)
        self.write(self.encode_string(string))

    def number(self, num):
        """Display a numeric value -999 through 9999, right aligned."""
        # limit to range -999 to 9999
        num = max(-999, min(num, 9999))
        string = '{0: >4d}'.format(num)
        self.write(self.encode_string(string))

    def numbers(self, num1, num2, colon=True):
        """Display two numeric values -9 through 99, with leading zeros
        and separated by a colon."""
        num1 = max(-9, min(num1, 99))
        num2 = max(-9, min(num2, 99))
        segments = self.encode_string('{0:0>2d}{1:0>2d}'.format(num1, num2))
        if colon:
            segments[1] |= 0x80 # colon on
        self.write(segments)

    def temperature(self, num):
        if num < -9:
            self.show('lo') # low
        elif num > 99:
            self.show('hi') # high
        else:
            string = '{0: >2d}'.format(num)
            self.write(self.encode_string(string))
        self.write([_SEGMENTS[38], _SEGMENTS[12]], 2) # degrees C

    def show(self, string, colon=False):
        segments = self.encode_string(string)
        if len(segments) > 1 and colon:
            segments[1] |= 128
        self.write(segments[:4])

    def scroll(self, string, delay=250):
        segments = string if isinstance(string, list) else self.encode_string(string)
        data = [0] * 8
        data[4:0] = list(segments)
        for i in range(len(segments) + 5):
            self.write(data[0+i:4+i])
            sleep_ms(delay)


class TM1637Decimal(TM1637):
    """Library for quad 7-segment LED modules based on the TM1637 LED driver.

    This class is meant to be used with decimal display modules (modules
    that have a decimal point after each 7-segment LED).
    """

    def encode_string(self, string):
        """Convert a string to LED segments.

        Convert an up to 4 character length string containing 0-9, a-z,
        space, dash, star and '.' to an array of segments, matching the length of
        the source string."""
        segments = bytearray(len(string.replace('.','')))
        j = 0
        for i in range(len(string)):
            if string[i] == '.' and j > 0:
                segments[j-1] |= TM1637_MSB
                continue
            segments[j] = self.encode_char(string[i])
            j += 1
        return segments

tm1637.py

from Counters import Time
class Clock:
    """
    Our implementation of the Clock class
    """
    def getTime(self):
        # calling getTime
        return Time.getTime()
        # returns the current time in the form of a tuple
    
    def setTime(self, timetuple):
        # calls the setTime class method from the Time class and passes the provided timetuple to it.
        Time.setTime(timetuple)

    def getHour(self):
        # return the current hour as an int 
        timetuple = Time.getTime()
        return timetuple[3]

    def setHour(self, hour):
        # It first retrieves the current time as a tuple.
        timetuple = Time.getTime() 
        # Converts the tuple to a list to allow modification.
        timelist = list(timetuple)  
        # Updates the hour in the list.
        timelist[3] = hour       
        # Sets the updated time list back to the system's RTC using the setTime method from the Time class
        Time.setTime(timelist)   

    def getMinute(self):
        # Retrieves the current minute from the system's real-time clock (RTC)
        # It first calls the Time.getTime() method to get the current time as a tuple.
        timetuple = Time.getTime()
        # It then extracts and returns the minute value (the fifth element of the tuple).
        return timetuple[4]
        # The method returns the current minute as an integer.
    
    def setMinute(self, minute):
        # sets the current minute on the system's real-time clock (RTC).
        # It first retrieves the current time as a tuple.
        timetuple = Time.getTime() 
        # Converts the tuple to a list to allow modification.
        timelist = list(timetuple) 
        # Updates the minute in the list.
        timelist[4] = minute      
        # Sets the updated time list back to the system's RTC using the setTime method from the Time class.
        Time.setTime(timelist)   
        # The real-time clock on the system is updated with the new minute value while 
        # keeping the other components (year, month, date, hour, second, weekday, yearday) unchanged   

    def getDate(self):
        # retrieves the current date (day of the month) from the system's real-time clock (RTC)
        # It first calls the Time.getTime() method to get the current time as a tuple.
        # It then extracts and returns the date value (the third element of the tuple).
        timetuple = Time.getTime()
        return timetuple[2]
        # The method returns the current date (day of the month) as an integer.
    
    def setDate(self, date):
        # sets the current date (day of the month) on the system's real-time clock (RTC)
        timetuple = Time.getTime() 
        timelist = list(timetuple) 
        timelist[2] = date         
        Time.setTime(timelist)  
        # The real-time clock on the system is updated with the new date value 
        # while keeping the other components (year, month, hour, minute, second,
        # weekday, yearday) unchanged.   
    
    def getMonth(self):
        # retrieves the current month from the system's real-time clock (RTC).
        timetuple = Time.getTime()  
        return timetuple[1]
        # The method returns the current month as an integer.

    def setMonth(self, month):
        # sets the current month on the system's real-time clock (RTC)
        timetuple = Time.getTime() 
        timelist = list(timetuple) 
        timelist[1] = month         
        Time.setTime(timelist)  
        # The real-time clock on the system is updated with the new month 
        # value while keeping the other components (year, date, hour, minute, 
        # second, weekday, yearday) unchanged.

Clock.py

from Displays import LCDDisplay
from Button import *
from Clock import *

class ClockController:
    """ Our implementation of the Clock Controller
        4 buttons for setting month, date, hour, min
        LCD display to show the time
    """

    def __init__(self): 
        self._clock = Clock()
        self._display = LCDDisplay(sda=0, scl=1, i2cid=0)
        self._buttons = [Button(10, 'white', buttonhandler=self),
                         Button(11, 'red', buttonhandler=self),
                         Button(12, 'yellow', buttonhandler=self),
                         Button(13, 'blue', buttonhandler=self)]
        self._month_names = {
            1: 'January', 2: 'February', 3: 'March', 4: 'April', 5: 'May', 6: 'June',
            7: 'July', 8: 'August', 9: 'September', 10: 'October', 11: 'November', 12: 'December'
        }

    def _getDaysInMonth(self, month):
        # create a dictionary for how many days are in each month
        month_days = {
            1: 31, 2: 28, 3: 31, 4: 30, 5: 31, 6: 30, 7: 31, 8: 31, 9: 30, 10: 31, 11: 30, 12: 31
        }
        return month_days.get(month, 30)

    def showTime(self):
        # show the time on the display
        (year, month, date, hour, minute, sec, wd, yd) = self._clock.getTime()
        month_name = self._month_names[month]
        self._display.showText(f'Time is {hour:02d}:{minute:02d}:{sec:02d}\n{date:02d} {month_name}   ')

    def buttonPressed(self, name):
        # Below are actions designed to handle the event when a button is pressed 
        # When any of the four colored buttons are pressed, the _incrementMonth 
        # method is executed, which increments the current month value stored in the Clock instance.                
        if name == 'white':
            self._incrementMonth()
            # It checks if the pressed button's name is 'white'.
            # If the button's name is 'white', it calls the 
            # _incrementMonth method to increment the current month.
        if name == 'red':
            self._incrementDate()
            # It checks if the pressed button's name is 'red'.
            # If the button's name is 'white', it calls the 
            # _incrementMonth method to increment the current month.

        if name == 'yellow':
            self._incrementHour()
            # It checks if the pressed button's name is 'yellow'.
            # If the button's name is 'white', it calls the 
            # _incrementMonth method to increment the current month.

        if name == 'blue':
            self._incrementMinute()
            # It checks if the pressed button's name is 'blue'.
            # If the button's name is 'white', it calls the 
            # _incrementMonth method to increment the current month.

    def buttonReleased(self, name):
        pass  
        # No action is executed when button is released

    def _incrementMonth(self):
        # Increments the current month in the Clock instance by one
        month = self._clock.getMonth()
        # Retrieves the current month using the getMonth method of the Clock instance
        if month == 12:
            self._clock.setMonth(1)
            # If the current month is December (12), it resets the month to January (1)
        else:
            self._clock.setMonth(month + 1)
            #  Else it increments the current month by one
        # The method updates the month in the Clock instance, 
        # wrapping around from December to January

    def _incrementDate(self):
        # Increments the current date (day of the month) in the Clock instance by one
        # Handling the transition from the last day of the month to the first day of the next month
        month, date = self._clock.getMonth(), self._clock.getDate()
        # Retrieves the current month and date using the getMonth and getDate methods of the Clock instance
        max_days = self._getDaysInMonth(month)
        # It then retrieves the maximum number of days in the current month using the _getDaysInMonth method
        if date >= max_days:
            self._clock.setDate(1)
            # If the current date is the last day of the month, it resets the date to the first day of the next month
        else:
            self._clock.setDate(date + 1)
            # Else, it increments the current date by one

    def _incrementHour(self):
        hour = self._clock.getHour()
        if hour == 23:
            self._clock.setHour(0)
        else:
            self._clock.setHour(hour + 1)

    def _incrementMinute(self):
        minute = self._clock.getMinute()
        if minute == 59:
            self._clock.setMinute(0)
        else:
            self._clock.setMinute(minute + 1)
