SSD1306 OLED display driver
1.8.2
This library is developed to control SSD1306/SSD1331/SSD1351/IL9163/PCD8554 RGB i2c/spi LED displays
|
SSD1306 driver is Arduino style C/C++ library with unicode support. The library can be compiled for plain Linux (for example, raspberry spi), or you can use it with plain avr-gcc compiler without Arduino IDE, or with ESP32 IDF. It supports monochrome and RGB oleds and has debug mode, allowing to execute code on PC, using SDL2.0. Initially the library is intended for very small microcontrollers (with a little of RAM). It was developed to use as few resources as possible, but still has powerful capabilities, allowing to develop nice animation. It works on any powerful devices like raspberry pi, esp32; and can be easily ported to new platform.
Since ssd1306 library supports different display types: monochrome, 8-bit color, 16-bit color displays, - there are several group of API functions:
Also, for graphics animation there special C++ API, called Nano Engine.
The i2c pins can be changed via API functions. Please, refer to documentation. Keep in mind, that the pins, which are allowed for i2c or spi interface, depend on the hardware. The default spi SCLK and MOSI pins are defined by SPI library, and DC, RST, CES pins are configurable through API.
Display | I2C | SPI | Orientation | Comments |
---|---|---|---|---|
sh1106 128x64 | X | |||
ssd1306 128x64 | X | X | ||
ssd1306 128x32 | X | X | ||
ssd1325 128x64 | X | |||
ssd1327 128x128 | X | |||
ssd1351 128x128 | X | |||
il9163 128x128 | X | X | ||
st7735 128x160 | X | X | ||
ili9341 240x320 | X | X | ||
pcd8544 84x48 | X | Nokia 5110 | ||
vga 96x40 color | direct D-sub output, atmega328p only | |||
vga 128x64 bw | direct D-sub output, atmega328p only |
Platforms | I2C | SPI | Comments |
---|---|---|---|
Arduino | |||
Attiny85, Attiny45 | X | X | Refer to Damellis attiny package |
Attiny84, Attiny44 | X | X | Refer to Damellis attiny package |
Atmega328p, Atmega168 | X | X | |
Atmega32u4 | X | X | |
Atmega2560 | X | X | |
Digispark, including PRO version | X | X | check examples compatibility list |
ESP8266 | X | X | check examples compatibility list |
ESP32 | X | X | check examples compatibility list |
STM32 | X | X | stm32duino |
Arduino Zero | X | X | |
Nordic nRF5 (nRF51, nRF52) | X | X | nRF users, enable c++11 in platform.txt -std=gnu++11 |
Nordic nRF5 (nRF51, nRF52) | X | X | via Sandeep Mistry arduino-nRF5 package |
Plain AVR | |||
Attiny85, Attiny45 | X | X | |
Atmega328p, Atmega168 | X | X | |
Atmega32u4 | X | X | |
Plain ESP32 | |||
ESP32 | X | X | library can be used as IDF component |
Linux | |||
Raspberry Pi | X | X | i2c-dev, spidev, sys/class/gpio |
SDL Emulation | X | X | demo code can be run without real OLED HW via SDL library |
Windows | |||
SDL Emulation | X | X | demo code can be run without real OLED HW via MinGW32 + SDL library |
Digispark users, please check compilation options in your Arduino prior to using this library. Ssd1306 library requires at least c++11 and c99 (by default Digispark package misses the options -std=gnu11, -std=gnu++11).
i2c Hardware setup is described here
Setting up for Arduino from github sources)
Setting up for Arduino from Arduino IDE library manager
Using with plain avr-gcc:
For esp32:
For more information about this library, please, visit https://github.com/lexus2k/ssd1306. Doxygen documentation can be found at github.io site. If you found any problem or have any idea, please, report to Issues section.
The library is free. If this project helps you, you can give me a cup of coffee. Donate via Paypal
MIT License
Copyright (c) 2016-2019, Alexey Dynda
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.