Raspberry Pi Pico/MicroPython exercise using SSD1306 I2C OLED

Exercise on Raspberry Pi Pico running MicroPython v1.19.1, to display on 0.91 inch 128x32 SSD1306 I2C OLED.


For mpy_i2c_scanner.py to verify I2C pins and address, used in above video, refer to last post "MicroPython I2C Scanner".

visit https://github.com/micropython/micropython/tree/master/drivers/display, copy and upload ssd1306.py to MicroPython device.

Updated@2024-09-06:
The above link to ssd1306.py lost, please refer to the updated post:  I2C OLED (SSD1306/SSD1315) screen with Raspberry Pi Pico 2 (RP2350) using MicroPython.

Exercise code:

mpyPico_SSD1306_hello.py

"""
MicroPython/Raspberry Pi Pico exercise
display on 0.91" 128x32 SSD1306 I2C OLED.
And,catch exception of OSError.

"""
import sys
import os
import time
import ssd1306

DISP_WIDTH=128
DISP_HEIGHT=32

print("====================================")
print(sys.implementation[0], os.uname()[3],
      "\nrun on", os.uname()[4])
print("====================================")

oled_i2c = machine.I2C(1)
print("Default I2C(1):", oled_i2c)

try:
    oled_ssd1306 = ssd1306.SSD1306_I2C(DISP_WIDTH, DISP_HEIGHT, oled_i2c)
    print("Default SSD1306 I2C address:",
          oled_ssd1306.addr, "/", hex(oled_ssd1306.addr))
    oled_ssd1306.fill(1)
    oled_ssd1306.show()
    time.sleep(2)
    oled_ssd1306.fill(0)
    oled_ssd1306.show()
    time.sleep(2)
    oled_ssd1306.rect(0, 0, DISP_WIDTH, DISP_HEIGHT, 1)
    oled_ssd1306.text('Hello, World!', 5, 5, 1)
    oled_ssd1306.show()
except OSError as exc:
    print("OSError!", exc)
    if exc.errno == errno.ENODEV:
        print("No such device")

print("~ bye ~")

mpyPico_SSD1306_hello_fb.py

"""
MicroPython/Raspberry Pi Pico exercise
display on 0.91" 128x32 SSD1306 I2C OLED.
And,catch exception of OSError .

"""
import sys
import os
import time
import ssd1306
import framebuf

DISP_WIDTH=128
DISP_HEIGHT=32

print("====================================")
print(sys.implementation[0], os.uname()[3],
      "\nrun on", os.uname()[4])
print("====================================")

oled_i2c = machine.I2C(1)
print("Default I2C(1):", oled_i2c)

# Raspberry Pi logo as 32x32 bytearray
fb_width=32
buffer = bytearray(b"\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00|?\x00\x01\x86@\x80\x01\x01\x80\x80\x01\x11\x88\x80\x01\x05\xa0\x80\x00\x83\xc1\x00\x00C\xe3\x00\x00~\xfc\x00\x00L'\x00\x00\x9c\x11\x00\x00\xbf\xfd\x00\x00\xe1\x87\x00\x01\xc1\x83\x80\x02A\x82@\x02A\x82@\x02\xc1\xc2@\x02\xf6>\xc0\x01\xfc=\x80\x01\x18\x18\x80\x01\x88\x10\x80\x00\x8c!\x00\x00\x87\xf1\x00\x00\x7f\xf6\x00\x008\x1c\x00\x00\x0c \x00\x00\x03\xc0\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00")

# Load the raspberry pi logo into the framebuffer (the image is 32x32)
fb = framebuf.FrameBuffer(buffer, 32, 32, framebuf.MONO_HLSB)

def demo():

    oled_ssd1306.fill(0)
    oled_ssd1306.rect(0, 0, DISP_WIDTH, DISP_HEIGHT, 1)
    oled_ssd1306.text('Hello', 5, 5, 1)
    oled_ssd1306.text('coXXect', 5, 15, 1)
    oled_ssd1306.show()
    time.sleep(2)

    oled_ssd1306.blit(fb, DISP_WIDTH-fb_width, 0)
    oled_ssd1306.show()
    time.sleep(1)
    
    for i in range(DISP_WIDTH-fb_width, 0-1, -1):
        oled_ssd1306.blit(fb, i, 0)
        oled_ssd1306.show()
        time.sleep(0.1)

try:
    oled_ssd1306 = ssd1306.SSD1306_I2C(DISP_WIDTH, DISP_HEIGHT, oled_i2c)
    print("Default SSD1306 I2C address:",
          oled_ssd1306.addr, "/", hex(oled_ssd1306.addr))
    
    oled_ssd1306.rotate(False)
    oled_ssd1306.invert(0)
    oled_ssd1306.fill(1)
    oled_ssd1306.show()
    time.sleep(2)
    oled_ssd1306.fill(0)
    oled_ssd1306.show()
    time.sleep(2)
    
    demo()
    oled_ssd1306.rotate(True)
    oled_ssd1306.invert(1)
    demo()
    time.sleep(1)
    
    oled_ssd1306.invert(0)
    time.sleep(1)
    
    oled_ssd1306.rotate(False)
    oled_ssd1306.invert(0)
    oled_ssd1306.fill(0)
    
    step_width = fb_width+2
    for i in range(0, DISP_WIDTH, step_width):
        oled_ssd1306.blit(fb, i, 0)
        oled_ssd1306.show()
        time.sleep(0.5)

except OSError as exc:
    print("OSError!", exc)


print("~ bye ~")

ssd1306.py, as reference.

# 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_IREF_SELECT = const(0xAD)
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,  # display off
            # address setting
            SET_MEM_ADDR,
            0x00,  # horizontal
            # resolution and layout
            SET_DISP_START_LINE,  # start at line 0
            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
            SET_IREF_SELECT,
            0x30,  # enable internal IREF during display on
            # charge pump
            SET_CHARGE_PUMP,
            0x10 if self.external_vcc else 0x14,
            SET_DISP | 0x01,  # display on
        ):  # on
            self.write_cmd(cmd)
        self.fill(0)
        self.show()

    def poweroff(self):
        self.write_cmd(SET_DISP)

    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 rotate(self, rotate):
        self.write_cmd(SET_COM_OUT_DIR | ((rotate & 1) << 3))
        self.write_cmd(SET_SEG_REMAP | (rotate & 1))

    def show(self):
        x0 = 0
        x1 = self.width - 1
        if self.width != 128:
            # narrow displays use centred columns
            col_offset = (128 - self.width) // 2
            x0 += col_offset
            x1 += col_offset
        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)

prev:
~ Raspberry Pi Pico/MicroPython exercise using SH1106 I2C OLED

next:

~ Pico/MicroPython display on two OLED as one FrameBuffer

Related:
~ The post "Pyboard/MicroPython display on SSD1315 I2C OLED using SSD1306 driver" show another approach to install micropython-ssd1306 package in Thonny Manager Packages.