Adafruit_SSD1306.h File Reference

#include <Adafruit_GFX.h>
#include <SPI.h>
#include <Wire.h>

Go to the source code of this file.

Classes
class	Adafruit_SSD1306
	Class that stores state and functions for interacting with SSD1306 OLED displays. More...

Macros
#define	SSD1306_128_32
	DEPRECATED: old way to specify 128x32 screen.
#define	BLACK   SSD1306_BLACK
	Draw 'off' pixels. More...
#define	WHITE   SSD1306_WHITE
	Draw 'on' pixels.
#define	INVERSE   SSD1306_INVERSE
	Invert pixels.
#define	SSD1306_BLACK   0
	fit into the SSD1306_ naming scheme More...
#define	SSD1306_WHITE   1
	Draw 'on' pixels.
#define	SSD1306_INVERSE   2
	Invert pixels.
#define	SSD1306_MEMORYMODE   0x20
	See datasheet.
#define	SSD1306_COLUMNADDR   0x21
	See datasheet.
#define	SSD1306_PAGEADDR   0x22
	See datasheet.
#define	SSD1306_SETCONTRAST   0x81
	See datasheet.
#define	SSD1306_CHARGEPUMP   0x8D
	See datasheet.
#define	SSD1306_SEGREMAP   0xA0
	See datasheet.
#define	SSD1306_DISPLAYALLON_RESUME   0xA4
	See datasheet.
#define	SSD1306_DISPLAYALLON   0xA5
	Not currently used.
#define	SSD1306_NORMALDISPLAY   0xA6
	See datasheet.
#define	SSD1306_INVERTDISPLAY   0xA7
	See datasheet.
#define	SSD1306_SETMULTIPLEX   0xA8
	See datasheet.
#define	SSD1306_DISPLAYOFF   0xAE
	See datasheet.
#define	SSD1306_DISPLAYON   0xAF
	See datasheet.
#define	SSD1306_COMSCANINC   0xC0
	Not currently used.
#define	SSD1306_COMSCANDEC   0xC8
	See datasheet.
#define	SSD1306_SETDISPLAYOFFSET   0xD3
	See datasheet.
#define	SSD1306_SETDISPLAYCLOCKDIV   0xD5
	See datasheet.
#define	SSD1306_SETPRECHARGE   0xD9
	See datasheet.
#define	SSD1306_SETCOMPINS   0xDA
	See datasheet.
#define	SSD1306_SETVCOMDETECT   0xDB
	See datasheet.
#define	SSD1306_SETLOWCOLUMN   0x00
	Not currently used.
#define	SSD1306_SETHIGHCOLUMN   0x10
	Not currently used.
#define	SSD1306_SETSTARTLINE   0x40
	See datasheet.
#define	SSD1306_EXTERNALVCC   0x01
	External display voltage source.
#define	SSD1306_SWITCHCAPVCC   0x02
	Gen. display voltage from 3.3V.
#define	SSD1306_RIGHT_HORIZONTAL_SCROLL   0x26
	Init rt scroll.
#define	SSD1306_LEFT_HORIZONTAL_SCROLL   0x27
	Init left scroll.
#define	SSD1306_VERTICAL_AND_RIGHT_HORIZONTAL_SCROLL   0x29
	Init diag scroll.
#define	SSD1306_VERTICAL_AND_LEFT_HORIZONTAL_SCROLL   0x2A
	Init diag scroll.
#define	SSD1306_DEACTIVATE_SCROLL   0x2E
	Stop scroll.
#define	SSD1306_ACTIVATE_SCROLL   0x2F
	Start scroll.
#define	SSD1306_SET_VERTICAL_SCROLL_AREA   0xA3
	Set scroll range.
#define	SSD1306_LCDWIDTH   128
	DEPRECATED: width w/SSD1306_128_32 defined.
#define	SSD1306_LCDHEIGHT   32
	DEPRECATED: height w/SSD1306_128_32 defined.

Detailed Description

This is part of for Adafruit's SSD1306 library for monochrome OLED displays: http://www.adafruit.com/category/63_98

These displays use I2C or SPI to communicate. I2C requires 2 pins (SCL+SDA) and optionally a RESET pin. SPI requires 4 pins (MOSI, SCK, select, data/command) and optionally a reset pin. Hardware SPI or 'bitbang' software SPI are both supported.

Adafruit invests time and resources providing this open source code, please support Adafruit and open-source hardware by purchasing products from Adafruit!

Written by Limor Fried/Ladyada for Adafruit Industries, with contributions from the open source community.

BSD license, all text above, and the splash screen header file, must be included in any redistribution.

Macro Definition Documentation

BLACK

#define BLACK   SSD1306_BLACK

Draw 'off' pixels.

The following "raw" color names are kept for backwards client compatability They can be disabled by predefining this macro before including the Adafruit header client code will then need to be modified to use the scoped enum values directly

SSD1306_BLACK

#define SSD1306_BLACK   0

fit into the SSD1306_ naming scheme

Draw 'off' pixels