![\"MicroPython:](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2020\/04\/ESP32-ESP8266-SSD1306-OLED-MicroPython-Shapes-Scroll.jpg?resize=1200%2C675&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\nWe recommend that you follow this getting started guide for the OLED display with MicroPython, first: MicroPython OLED Display with ESP32 and ESP8266<\/a>.<\/p>\n\n\n\n To follow this tutorial you need MicroPython firmware installed in your ESP32 or ESP8266 boards. You also need an IDE to write and upload the code to your board. We suggest using Thonny IDE or uPyCraft IDE:<\/p>\n\n\n\n Learn more about MicroPython: MicroPython Programming with ESP32 and ESP8266 eBook<\/a><\/p>\n\n\n\n Here\u2019s a list of parts you need for this tutorial:<\/p>\n\n\n\n You can use the preceding links or go directly to MakerAdvisor.com\/tools<\/a> to find all the parts for your projects at the best price!<\/p> Follow the next schematic diagram if you\u2019re using an ESP32 board:<\/p>\n\n\n\n Recommended reading:<\/strong> ESP32 Pinout Reference Guide<\/a><\/p>\n\n\n\n Follow the next schematic diagram if you\u2019re using an ESP8266 NodeMCU board:<\/p>\n\n\n\n Recommended reading:<\/strong> ESP8266 Pinout Reference Guide<\/a> <\/p>\n\n\n\n The library to write to the OLED display isn\u2019t part of the standard MicroPython library by default. So, you need to upload the library to your ESP32\/ESP8266 board. <\/p>\n\n\nPrerequisites<\/h2>\n\n\n\n
Parts Required<\/h2>\n\n\n\n
![](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2017\/10\/header-200.png?w=1200&quality=100&strip=all&ssl=1\")
<\/a><\/p>\n\n\n\nSchematic – ESP32<\/h2>\n\n\n\n
![\"OLED](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2019\/05\/ESP32_OLED.png?resize=873%2C685&quality=100&strip=all&ssl=1\")
<\/a><\/figure><\/div>\n\n\n\nSchematic – ESP8266 NodeMCU<\/h2>\n\n\n\n
![\"OLED](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2019\/05\/es8266-oled_bb-1.png?resize=828%2C534&quality=100&strip=all&ssl=1\")
<\/a><\/figure><\/div>\n\n\n\nSSD1306 OLED Library<\/h2>\n\n\n\n
# MicroPython SSD1306 OLED driver, I2C and SPI interfaces created by Adafruit\n\nimport time\nimport framebuf\n\n# register definitions\nSET_CONTRAST = const(0x81)\nSET_ENTIRE_ON = const(0xa4)\nSET_NORM_INV = const(0xa6)\nSET_DISP = const(0xae)\nSET_MEM_ADDR = const(0x20)\nSET_COL_ADDR = const(0x21)\nSET_PAGE_ADDR = const(0x22)\nSET_DISP_START_LINE = const(0x40)\nSET_SEG_REMAP = const(0xa0)\nSET_MUX_RATIO = const(0xa8)\nSET_COM_OUT_DIR = const(0xc0)\nSET_DISP_OFFSET = const(0xd3)\nSET_COM_PIN_CFG = const(0xda)\nSET_DISP_CLK_DIV = const(0xd5)\nSET_PRECHARGE = const(0xd9)\nSET_VCOM_DESEL = const(0xdb)\nSET_CHARGE_PUMP = const(0x8d)\n\n\nclass SSD1306:\n def __init__(self, width, height, external_vcc):\n self.width = width\n self.height = height\n self.external_vcc = external_vcc\n self.pages = self.height \/\/ 8\n # Note the subclass must initialize self.framebuf to a framebuffer.\n # This is necessary because the underlying data buffer is different\n # between I2C and SPI implementations (I2C needs an extra byte).\n self.poweron()\n self.init_display()\n\n def init_display(self):\n for cmd in (\n SET_DISP | 0x00, # off\n # address setting\n SET_MEM_ADDR, 0x00, # horizontal\n # resolution and layout\n SET_DISP_START_LINE | 0x00,\n SET_SEG_REMAP | 0x01, # column addr 127 mapped to SEG0\n SET_MUX_RATIO, self.height - 1,\n SET_COM_OUT_DIR | 0x08, # scan from COM[N] to COM0\n SET_DISP_OFFSET, 0x00,\n SET_COM_PIN_CFG, 0x02 if self.height == 32 else 0x12,\n # timing and driving scheme\n SET_DISP_CLK_DIV, 0x80,\n SET_PRECHARGE, 0x22 if self.external_vcc else 0xf1,\n SET_VCOM_DESEL, 0x30, # 0.83*Vcc\n # display\n SET_CONTRAST, 0xff, # maximum\n SET_ENTIRE_ON, # output follows RAM contents\n SET_NORM_INV, # not inverted\n # charge pump\n SET_CHARGE_PUMP, 0x10 if self.external_vcc else 0x14,\n SET_DISP | 0x01): # on\n self.write_cmd(cmd)\n self.fill(0)\n self.show()\n\n def poweroff(self):\n self.write_cmd(SET_DISP | 0x00)\n\n def contrast(self, contrast):\n self.write_cmd(SET_CONTRAST)\n self.write_cmd(contrast)\n\n def invert(self, invert):\n self.write_cmd(SET_NORM_INV | (invert & 1))\n\n def show(self):\n x0 = 0\n x1 = self.width - 1\n if self.width == 64:\n # displays with width of 64 pixels are shifted by 32\n x0 += 32\n x1 += 32\n self.write_cmd(SET_COL_ADDR)\n self.write_cmd(x0)\n self.write_cmd(x1)\n self.write_cmd(SET_PAGE_ADDR)\n self.write_cmd(0)\n self.write_cmd(self.pages - 1)\n self.write_framebuf()\n\n def fill(self, col):\n self.framebuf.fill(col)\n\n def pixel(self, x, y, col):\n self.framebuf.pixel(x, y, col)\n\n def scroll(self, dx, dy):\n self.framebuf.scroll(dx, dy)\n\n def text(self, string, x, y, col=1):\n self.framebuf.text(string, x, y, col)\n\n\nclass SSD1306_I2C(SSD1306):\n def __init__(self, width, height, i2c, addr=0x3c, external_vcc=False):\n self.i2c = i2c\n self.addr = addr\n self.temp = bytearray(2)\n # Add an extra byte to the data buffer to hold an I2C data\/command byte\n # to use hardware-compatible I2C transactions. A memoryview of the\n # buffer is used to mask this byte from the framebuffer operations\n # (without a major memory hit as memoryview doesn't copy to a separate\n # buffer).\n self.buffer = bytearray(((height \/\/ 8) * width) + 1)\n self.buffer[0] = 0x40 # Set first byte of data buffer to Co=0, D\/C=1\n self.framebuf = framebuf.FrameBuffer1(memoryview(self.buffer)[1:], width, height)\n super().__init__(width, height, external_vcc)\n\n def write_cmd(self, cmd):\n self.temp[0] = 0x80 # Co=1, D\/C#=0\n self.temp[1] = cmd\n self.i2c.writeto(self.addr, self.temp)\n\n def write_framebuf(self):\n # Blast out the frame buffer using a single I2C transaction to support\n # hardware I2C interfaces.\n self.i2c.writeto(self.addr, self.buffer)\n\n def poweron(self):\n pass\n\n\nclass SSD1306_SPI(SSD1306):\n def __init__(self, width, height, spi, dc, res, cs, external_vcc=False):\n self.rate = 10 * 1024 * 1024\n dc.init(dc.OUT, value=0)\n res.init(res.OUT, value=0)\n cs.init(cs.OUT, value=1)\n self.spi = spi\n self.dc = dc\n self.res = res\n self.cs = cs\n self.buffer = bytearray((height \/\/ 8) * width)\n self.framebuf = framebuf.FrameBuffer1(self.buffer, width, height)\n super().__init__(width, height, external_vcc)\n\n def write_cmd(self, cmd):\n self.spi.init(baudrate=self.rate, polarity=0, phase=0)\n self.cs.high()\n self.dc.low()\n self.cs.low()\n self.spi.write(bytearray([cmd]))\n self.cs.high()\n\n def write_framebuf(self):\n self.spi.init(baudrate=self.rate, polarity=0, phase=0)\n self.cs.high()\n self.dc.high()\n self.cs.low()\n self.spi.write(self.buffer)\n self.cs.high()\n\n def poweron(self):\n self.res.high()\n time.sleep_ms(1)\n self.res.low()\n time.sleep_ms(10)\n self.res.high()\n<\/code><\/pre>\n\t
![\"\"](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2018\/10\/uPycraft-ide-tools-menu-new-file.png?resize=135%2C41&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\n![\"\"](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2018\/10\/uPycraft-ide-tools-menu-save-file.png?resize=142%2C47&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\n![\"import](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2019\/05\/install_ssd1306.png?resize=784%2C704&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\n![\"\"](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2018\/10\/download-run.png?resize=41%2C52&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\n![\"import](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2019\/05\/ssd1306_installed.png?resize=783%2C704&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\n![\"thonny](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2019\/05\/upload-current-script-with-current-name-oled.png?resize=646%2C654&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\n![\"show](\"https:\/\/i0.wp.com\/randomnerdtutorials.com\/wp-content\/uploads\/2019\/05\/lsdevice.png?resize=720%2C168&quality=100&strip=all&ssl=1\")
<\/figure><\/div>\n\n\n\n