# Personal Dashboard
This dashboard is meant to serve as a small accessory on desks to do simple things like playing music and running a timer/stopwatch.

I've done the wiring colours to make it easy to know what wire is for what;
- Orange wires are for GND pins
- Blue wires are for GPIO pins
- Red wires are for VCC/3V3 pins

# Default Bin Stuff
You can get help by chatting with other high schoolers on the Hack Club Slack in
the #electronics channel:
👉 https://hackclub.com/slack 👈

Once you're ready build your design IRL, click the "Share" button and submit
your design:
https://hack.club/bin-submit

help.md

diagram.json

print("_____________________________________________________")

from machine import Pin, I2C, ADC, PWM
import ssd1306
from time import sleep, time

WIDTH = 128
HEIGHT = 64

note_mappings = {
    'C4': 261.63,
    'D4': 293.66,
    'E4': 329.63,
    'F4': 349.23,
    'G4': 392.00,
    'A4': 440.00,
    'B4': 493.88,
    'C5': 523.25,
}

note_list = [ "E4", "D4", "E4", "D4", "E4", "B4", "D4", "C5", "A4", "pause",
    "C4", "E4", "A4", "B4", "pause", "E4", "G4", "B4", "C5", "pause",
    "E4", "E4", "D4", "E4", "D4", "E4", "B4", "D4", "C5", "A4", "pause",
    "C4", "E4", "A4", "B4", "pause", "E4", "C5", "B4", "A4", "pause"]

screen_pin = I2C(0, scl=Pin(22), sda=Pin(21))
screen = ssd1306.SSD1306_I2C(WIDTH, HEIGHT, screen_pin)

slider_pin = Pin(34)
slider = ADC(slider_pin)
slider.width(ADC.WIDTH_12BIT)
slider.atten(ADC.ATTN_11DB)

buzzer_pin = Pin(23)
buzzer_pwm = PWM(buzzer_pin)
buzzer_pwm.duty(0)

LED_bar_pins = [13, 12, 14, 27, 26, 25, 33, 32, 18, 19]
LED_bar_pins.reverse()

print("Pins defined!")

keypad_keys = [
    ['1', '2', '3', 'A'],
    ['4', '5', '6', 'B'],
    ['7', '8', '9', 'C'],
    ['*', '0', '#', 'D']
]

keypad_row = [15, 2, 0, 4]
keypad_col = [16, 17, 5, 35]

row_pins = [Pin(i, Pin.OUT) for i in keypad_row]
col_pins = [Pin(i, Pin.IN, Pin.PULL_UP) for i in keypad_col]

def show_bar_LED(count):
    for index, pin in enumerate(LED_bar_pins):
        led = Pin(pin, Pin.OUT)
        if index < count:
            led.on()
        else:
            led.off()

def clear_bar_LED():
    for pin in LED_bar_pins:
        led = Pin(pin, Pin.OUT)
        led.off()

def convert_volume(volume):
    return int(volume * 1023 / 10)

def convert_reading(reading):
    return int(reading * 10 / 4095)

def convert_time(s):
    minutes = s // 60
    seconds = s % 60
    return minutes, seconds

def clear_screen():
    screen.fill(0)

def check_keypad_input():
    key = None
    for row_index, row in enumerate(row_pins):
        for r in row_pins:
            r.value(1)
        row.value(0)
        for col_index, col in enumerate(col_pins):
            if col.value() == 0:
                key = keypad_keys[row_index][col_index]
                sleep(0.1)
                while col.value() == 0:
                    sleep(0.1)
        row.value(1)
        if key:
            break
    return key

def play_note(note, duration, volume):
    frequency = int(note_mappings[note])
    buzzer_pwm.freq(frequency)
    buzzer_pwm.duty(volume)
    sleep(duration)
    buzzer_pwm.duty(0)

def home_screen():
    screen.text("Dashboard", 26, 0)
    screen.text("Commands are:", 10, 12)
    screen.text("A for music.", 10, 22)
    screen.text("B for stopwatch.", 10, 32)
    screen.text("C for timer.", 10, 42)
    screen.text("# to quit.", 10, 52)

def music_screen():
    clear_screen()
    screen.text("Playing", 26, 0)
    screen.text("music!", 26, 10)
    screen.text("* for home.", 26, 24)
    screen.show()

def stopwatch_screen(seconds):
    clear_screen()
    minutes, seconds = convert_time(seconds)
    screen.text("Stopwatch", 26, 0)
    screen.text(f"Time: {minutes:02}:{seconds:02}", 15, 22)
    screen.text("* for home.", 26, 42)
    screen.show()

def timer_screen(seconds):
    clear_screen()
    screen.text("Timer", 26, 0)
    minutes, seconds = convert_time(seconds)
    screen.text(f"Time: {minutes:02}:{seconds:02}", 15, 22)
    screen.text("* for home.", 26, 42)
    screen.show()

print("Functions defined!")

vol = 0

timer_seconds = 60
stopwatch_seconds = 0

note_cursor = 0
play_music = False

home_screen()
screen.show()
current_screen = "home"

milliseconds = 0
started = False

while True:
    if started:
        milliseconds += 100

    clear_bar_LED()
    show_bar_LED(vol)

    new_vol = convert_reading(slider.read())
    if vol != new_vol:
        print(vol)
        vol = new_vol

    pressed_key = check_keypad_input()

    if pressed_key is not None:
        print(f"Key: {pressed_key}")

        if pressed_key == "#":
            clear_screen()
            screen.text("Quitting", 10, 8)
            screen.text("dashboard...", 10, 18)
            screen.show()
            break

        elif pressed_key == "*":
            started = False
            play_music = False
            current_screen = "home"
            clear_screen()
            home_screen()
            screen.show()

        if current_screen == "home":
            if pressed_key == "A":
                current_screen = "music"
                clear_screen()
                music_screen()
                screen.show()
                play_music = True

            elif pressed_key == "B":
                current_screen = "stopwatch"
                started = True
                stopwatch_seconds = 0

            elif pressed_key == "C":
                current_screen = "timer"
                started = True
                timer_seconds = 60
                clear_screen()
                timer_screen(timer_seconds)
                screen.show()

        elif current_screen == "music":
            if pressed_key == "A":
                play_music = True
            elif pressed_key == "B":
                play_music = False

    if play_music:
        if note_cursor >= len(note_list):
            note_cursor = 0
        
        if note_list[note_cursor] != "pause":
            play_note(note_list[note_cursor], 0.2, convert_volume(vol))
        note_cursor += 1

    if milliseconds == 1000:
        if current_screen == "timer":
            if timer_seconds > 0:
                timer_seconds -= 1
                timer_screen(timer_seconds)
            elif timer_seconds <= 0:
                clear_screen()
                screen.text("Time's up!", 15, 22)
                screen.show()

        elif current_screen == "stopwatch":
            stopwatch_seconds += 1
            stopwatch_screen(stopwatch_seconds)
            screen.show()
        
        milliseconds = 0

    sleep(0.1)

main.py

#MicroPython SSD1306 OLED driver, I2C and SPI interfaces created by Adafruit

import time
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)


class SSD1306:
    def __init__(self, width, height, external_vcc):
        self.width = width
        self.height = height
        self.external_vcc = external_vcc
        self.pages = self.height // 8
        # Note the subclass must initialize self.framebuf to a framebuffer.
        # This is necessary because the underlying data buffer is different
        # between I2C and SPI implementations (I2C needs an extra byte).
        self.poweron()
        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.height == 32 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 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_framebuf()

    def fill(self, col):
        self.framebuf.fill(col)

    def pixel(self, x, y, col):
        self.framebuf.pixel(x, y, col)

    def scroll(self, dx, dy):
        self.framebuf.scroll(dx, dy)

    def text(self, string, x, y, col=1):
        self.framebuf.text(string, x, y, col)


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)
        # Add an extra byte to the data buffer to hold an I2C data/command byte
        # to use hardware-compatible I2C transactions.  A memoryview of the
        # buffer is used to mask this byte from the framebuffer operations
        # (without a major memory hit as memoryview doesn't copy to a separate
        # buffer).
        self.buffer = bytearray(((height // 8) * width) + 1)
        self.buffer[0] = 0x40  # Set first byte of data buffer to Co=0, D/C=1
        self.framebuf = framebuf.FrameBuffer1(memoryview(self.buffer)[1:], width, height)
        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_framebuf(self):
        # Blast out the frame buffer using a single I2C transaction to support
        # hardware I2C interfaces.
        self.i2c.writeto(self.addr, self.buffer)

    def poweron(self):
        pass


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
        self.buffer = bytearray((height // 8) * width)
        self.framebuf = framebuf.FrameBuffer1(self.buffer, width, height)
        super().__init__(width, height, external_vcc)

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

    def write_framebuf(self):
        self.spi.init(baudrate=self.rate, polarity=0, phase=0)
        self.cs.high()
        self.dc.high()
        self.cs.low()
        self.spi.write(self.buffer)
        self.cs.high()

    def poweron(self):
        self.res.high()
        time.sleep_ms(1)
        self.res.low()
        time.sleep_ms(10)
        self.res.high()
