Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/rm-hull/luma.oled/llms.txt

Use this file to discover all available pages before exploring further.

The luma.oled library supports a wide range of OLED display controllers: SSD1305, SSD1306, SSD1309, SSD1315, SSD1316, SSD1322, SSD1325, SSD1327, SSD1331, SSD1351, SSD1362, SH1106, SH1107, WS0010, and CH1115. Controllers span three color modes — monochrome (1-bit), 4-bit greyscale, and 16-bit RGB color — and are accessible over I2C, SPI, or parallel interfaces depending on the chipset.
ClassControllerColor modeDefault resolutionInterface
ssd1305SSD1305Monochrome128×32I2C / SPI
ssd1306SSD1306Monochrome128×64I2C / SPI
ssd1309SSD1309Monochrome128×64SPI
ssd1315SSD1315Monochrome128×64I2C / SPI
ssd1316SSD1316Monochrome128×32I2C / SPI
ssd1322SSD13224-bit greyscale256×64SPI
ssd1322_nhdSSD1322 (NHD)4-bit greyscale128×64SPI
ssd1325SSD13254-bit greyscale128×64SPI
ssd1327SSD13274-bit greyscale128×128I2C / SPI
ssd1331SSD133116-bit RGB color96×64SPI
ssd1351SSD135116-bit RGB color128×128SPI
ssd1362SSD13624-bit greyscale256×64SPI
sh1106SH1106Monochrome128×64I2C / SPI
sh1107SH1107Monochrome64×128I2C / SPI
ws0010WS0010Monochrome100×16Parallel
winstar_wehWS0010Monochrome16×2 charsParallel
ch1115CH1115Monochrome128×64I2C / SPI
The table above lists the default resolution for each class. Many controllers accept alternate resolutions — for example, ssd1306 also supports 128×32, 96×16, 64×48, and 64×32. Passing an unsupported resolution raises a DeviceDisplayModeError. See the device class reference for the full list of supported dimensions per class.
Visual examples for most of the displays above are available in the luma.examples repository. The README explains how to run each example on your hardware.

Build docs developers (and LLMs) love