128x64 EasyC OLED Display 1.0.0
This is a library for Soldered OLED Display
Loading...
Searching...
No Matches
Adafruit_SSD1306 Class Reference

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

#include <Adafruit_SSD1306.h>

Inherits Adafruit_GFX.

Inherited by OLED_Display.

Public Member Functions

 Adafruit_SSD1306 (uint8_t w, uint8_t h, TwoWire *twi=&Wire, int8_t rst_pin=-1, uint32_t clkDuring=400000UL, uint32_t clkAfter=100000UL)
 Constructor for I2C-interfaced SSD1306 displays.
 
 Adafruit_SSD1306 (uint8_t w, uint8_t h, int8_t mosi_pin, int8_t sclk_pin, int8_t dc_pin, int8_t rst_pin, int8_t cs_pin)
 
 Adafruit_SSD1306 (uint8_t w, uint8_t h, SPIClass *spi, int8_t dc_pin, int8_t rst_pin, int8_t cs_pin, uint32_t bitrate=8000000UL)
 Constructor for SPI SSD1306 displays, using native hardware SPI.
 
 Adafruit_SSD1306 (int8_t mosi_pin, int8_t sclk_pin, int8_t dc_pin, int8_t rst_pin, int8_t cs_pin)
 DEPRECATED constructor for SPI SSD1306 displays, using software (bitbang) SPI. Provided for older code to maintain compatibility with the current library. Screen size is determined by enabling one of the SSD1306_* size defines in Adafruit_SSD1306.h. New code should NOT use this.
 
 Adafruit_SSD1306 (int8_t dc_pin, int8_t rst_pin, int8_t cs_pin)
 DEPRECATED constructor for SPI SSD1306 displays, using native hardware SPI. Provided for older code to maintain compatibility with the current library. Screen size is determined by enabling one of the SSD1306_* size defines in Adafruit_SSD1306.h. New code should NOT use this. Only the primary SPI bus is supported, and bitrate is fixed at 8 MHz.
 
 Adafruit_SSD1306 (int8_t rst_pin=-1)
 DEPRECATED constructor for I2C SSD1306 displays. Provided for older code to maintain compatibility with the current library. Screen size is determined by enabling one of the SSD1306_* size defines in Adafruit_SSD1306.h. New code should NOT use this. Only the primary I2C bus is supported.
 
 ~Adafruit_SSD1306 (void)
 Destructor for Adafruit_SSD1306 object.
 
bool begin (uint8_t switchvcc=SSD1306_SWITCHCAPVCC, uint8_t i2caddr=0, bool reset=true, bool periphBegin=true)
 Allocate RAM for image buffer, initialize peripherals and pins.
 
void display (void)
 Push data currently in RAM to SSD1306 display.
 
void clearDisplay (void)
 Clear contents of display buffer (set all pixels to off).
 
void invertDisplay (bool i)
 Enable or disable display invert mode (white-on-black vs black-on-white).
 
void dim (bool dim)
 Dim the display.
 
void drawPixel (int16_t x, int16_t y, uint16_t color)
 Set/clear/invert a single pixel. This is also invoked by the Adafruit_GFX library in generating many higher-level graphics primitives.
 
virtual void drawFastHLine (int16_t x, int16_t y, int16_t w, uint16_t color)
 Draw a horizontal line. This is also invoked by the Adafruit_GFX library in generating many higher-level graphics primitives.
 
virtual void drawFastVLine (int16_t x, int16_t y, int16_t h, uint16_t color)
 Draw a vertical line. This is also invoked by the Adafruit_GFX library in generating many higher-level graphics primitives.
 
void startscrollright (uint8_t start, uint8_t stop)
 Activate a right-handed scroll for all or part of the display.
 
void startscrollleft (uint8_t start, uint8_t stop)
 Activate a left-handed scroll for all or part of the display.
 
void startscrolldiagright (uint8_t start, uint8_t stop)
 Activate a diagonal scroll for all or part of the display.
 
void startscrolldiagleft (uint8_t start, uint8_t stop)
 Activate alternate diagonal scroll for all or part of the display.
 
void stopscroll (void)
 Cease a previously-begun scrolling action.
 
void ssd1306_command (uint8_t c)
 Issue a single low-level command directly to the SSD1306 display, bypassing the library.
 
bool getPixel (int16_t x, int16_t y)
 Return color of a single pixel in display buffer.
 
uint8_t * getBuffer (void)
 Get base address of display buffer for direct reading or writing.
 
- Public Member Functions inherited from Adafruit_GFX
 Adafruit_GFX (int16_t w, int16_t h)
 Instatiate a GFX context for graphics! Can only be done by a superclass.
 
virtual void startWrite (void)
 Start a display-writing routine, overwrite in subclasses.
 
virtual void writePixel (int16_t x, int16_t y, uint16_t color)
 Write a pixel, overwrite in subclasses if startWrite is defined!
 
virtual void writeFillRect (int16_t x, int16_t y, int16_t w, int16_t h, uint16_t color)
 Write a rectangle completely with one color, overwrite in subclasses if startWrite is defined!
 
virtual void writeFastVLine (int16_t x, int16_t y, int16_t h, uint16_t color)
 Write a perfectly vertical line, overwrite in subclasses if startWrite is defined!
 
virtual void writeFastHLine (int16_t x, int16_t y, int16_t w, uint16_t color)
 Write a perfectly horizontal line, overwrite in subclasses if startWrite is defined!
 
virtual void writeLine (int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint16_t color)
 Write a line. Bresenham's algorithm - thx wikpedia.
 
virtual void endWrite (void)
 End a display-writing routine, overwrite in subclasses if startWrite is defined!
 
virtual void setRotation (uint8_t r)
 Set rotation setting for display.
 
virtual void fillRect (int16_t x, int16_t y, int16_t w, int16_t h, uint16_t color)
 Fill a rectangle completely with one color. Update in subclasses if desired!
 
virtual void fillScreen (uint16_t color)
 Fill the screen completely with one color. Update in subclasses if desired!
 
virtual void drawLine (int16_t x0, int16_t y0, int16_t x1, int16_t y1, uint16_t color)
 Draw a line.
 
virtual void drawRect (int16_t x, int16_t y, int16_t w, int16_t h, uint16_t color)
 Draw a rectangle with no fill color.
 
void drawCircle (int16_t x0, int16_t y0, int16_t r, uint16_t color)
 Draw a circle outline.
 
void drawCircleHelper (int16_t x0, int16_t y0, int16_t r, uint8_t cornername, uint16_t color)
 Quarter-circle drawer, used to do circles and roundrects.
 
void fillCircle (int16_t x0, int16_t y0, int16_t r, uint16_t color)
 Draw a circle with filled color.
 
void fillCircleHelper (int16_t x0, int16_t y0, int16_t r, uint8_t cornername, int16_t delta, uint16_t color)
 Quarter-circle drawer with fill, used for circles and roundrects.
 
void drawTriangle (int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint16_t color)
 Draw a triangle with no fill color.
 
void fillTriangle (int16_t x0, int16_t y0, int16_t x1, int16_t y1, int16_t x2, int16_t y2, uint16_t color)
 Draw a triangle with color-fill.
 
void drawRoundRect (int16_t x0, int16_t y0, int16_t w, int16_t h, int16_t radius, uint16_t color)
 Draw a rounded rectangle with no fill color.
 
void fillRoundRect (int16_t x0, int16_t y0, int16_t w, int16_t h, int16_t radius, uint16_t color)
 Draw a rounded rectangle with fill color.
 
void drawBitmap (int16_t x, int16_t y, const uint8_t bitmap[], int16_t w, int16_t h, uint16_t color)
 Draw a PROGMEM-resident 1-bit image at the specified (x,y) position, using the specified foreground color (unset bits are transparent).
 
void drawBitmap (int16_t x, int16_t y, const uint8_t bitmap[], int16_t w, int16_t h, uint16_t color, uint16_t bg)
 Draw a PROGMEM-resident 1-bit image at the specified (x,y) position, using the specified foreground (for set bits) and background (unset bits) colors.
 
void drawBitmap (int16_t x, int16_t y, uint8_t *bitmap, int16_t w, int16_t h, uint16_t color)
 Draw a RAM-resident 1-bit image at the specified (x,y) position, using the specified foreground color (unset bits are transparent).
 
void drawBitmap (int16_t x, int16_t y, uint8_t *bitmap, int16_t w, int16_t h, uint16_t color, uint16_t bg)
 Draw a RAM-resident 1-bit image at the specified (x,y) position, using the specified foreground (for set bits) and background (unset bits) colors.
 
void drawXBitmap (int16_t x, int16_t y, const uint8_t bitmap[], int16_t w, int16_t h, uint16_t color)
 Draw PROGMEM-resident XBitMap Files (*.xbm), exported from GIMP. Usage: Export from GIMP to *.xbm, rename *.xbm to *.c and open in editor. C Array can be directly used with this function. There is no RAM-resident version of this function; if generating bitmaps in RAM, use the format defined by drawBitmap() and call that instead.
 
void drawGrayscaleBitmap (int16_t x, int16_t y, const uint8_t bitmap[], int16_t w, int16_t h)
 Draw a PROGMEM-resident 8-bit image (grayscale) at the specified (x,y) pos. Specifically for 8-bit display devices such as IS31FL3731; no color reduction/expansion is performed.
 
void drawGrayscaleBitmap (int16_t x, int16_t y, uint8_t *bitmap, int16_t w, int16_t h)
 Draw a RAM-resident 8-bit image (grayscale) at the specified (x,y) pos. Specifically for 8-bit display devices such as IS31FL3731; no color reduction/expansion is performed.
 
void drawGrayscaleBitmap (int16_t x, int16_t y, const uint8_t bitmap[], const uint8_t mask[], int16_t w, int16_t h)
 Draw a PROGMEM-resident 8-bit image (grayscale) with a 1-bit mask (set bits = opaque, unset bits = clear) at the specified (x,y) position. BOTH buffers (grayscale and mask) must be PROGMEM-resident. Specifically for 8-bit display devices such as IS31FL3731; no color reduction/expansion is performed.
 
void drawGrayscaleBitmap (int16_t x, int16_t y, uint8_t *bitmap, uint8_t *mask, int16_t w, int16_t h)
 Draw a RAM-resident 8-bit image (grayscale) with a 1-bit mask (set bits = opaque, unset bits = clear) at the specified (x,y) position. BOTH buffers (grayscale and mask) must be RAM-residentt, no mix-and-match Specifically for 8-bit display devices such as IS31FL3731; no color reduction/expansion is performed.
 
void drawRGBBitmap (int16_t x, int16_t y, const uint16_t bitmap[], int16_t w, int16_t h)
 Draw a PROGMEM-resident 16-bit image (RGB 5/6/5) at the specified (x,y) position. For 16-bit display devices; no color reduction performed.
 
void drawRGBBitmap (int16_t x, int16_t y, uint16_t *bitmap, int16_t w, int16_t h)
 Draw a RAM-resident 16-bit image (RGB 5/6/5) at the specified (x,y) position. For 16-bit display devices; no color reduction performed.
 
void drawRGBBitmap (int16_t x, int16_t y, const uint16_t bitmap[], const uint8_t mask[], int16_t w, int16_t h)
 Draw a PROGMEM-resident 16-bit image (RGB 5/6/5) with a 1-bit mask (set bits = opaque, unset bits = clear) at the specified (x,y) position. BOTH buffers (color and mask) must be PROGMEM-resident. For 16-bit display devices; no color reduction performed.
 
void drawRGBBitmap (int16_t x, int16_t y, uint16_t *bitmap, uint8_t *mask, int16_t w, int16_t h)
 Draw a RAM-resident 16-bit image (RGB 5/6/5) with a 1-bit mask (set bits = opaque, unset bits = clear) at the specified (x,y) position. BOTH buffers (color and mask) must be RAM-resident. For 16-bit display devices; no color reduction performed.
 
void drawChar (int16_t x, int16_t y, unsigned char c, uint16_t color, uint16_t bg, uint8_t size)
 Draw a single character.
 
void drawChar (int16_t x, int16_t y, unsigned char c, uint16_t color, uint16_t bg, uint8_t size_x, uint8_t size_y)
 Draw a single character.
 
void getTextBounds (const char *string, int16_t x, int16_t y, int16_t *x1, int16_t *y1, uint16_t *w, uint16_t *h)
 Helper to determine size of a string with current font/size. Pass string and a cursor position, returns UL corner and W,H.
 
void getTextBounds (const __FlashStringHelper *s, int16_t x, int16_t y, int16_t *x1, int16_t *y1, uint16_t *w, uint16_t *h)
 Helper to determine size of a PROGMEM string with current font/size. Pass string and a cursor position, returns UL corner and W,H.
 
void getTextBounds (const String &str, int16_t x, int16_t y, int16_t *x1, int16_t *y1, uint16_t *w, uint16_t *h)
 Helper to determine size of a string with current font/size. Pass string and a cursor position, returns UL corner and W,H.
 
void setTextSize (uint8_t s)
 Set text 'magnification' size. Each increase in s makes 1 pixel that much bigger.
 
void setTextSize (uint8_t sx, uint8_t sy)
 Set text 'magnification' size. Each increase in s makes 1 pixel that much bigger.
 
void setFont (const GFXfont *f=NULL)
 Set the font to display when print()ing, either custom or default.
 
void setCursor (int16_t x, int16_t y)
 Set text cursor location.
 
void setTextColor (uint16_t c)
 Set text font color with transparant background.
 
void setTextColor (uint16_t c, uint16_t bg)
 Set text font color with custom background color.
 
void setTextWrap (bool w)
 Set whether text that is too long for the screen width should automatically wrap around to the next line (else clip right).
 
void cp437 (bool x=true)
 Enable (or disable) Code Page 437-compatible charset. There was an error in glcdfont.c for the longest time – one character (#176, the 'light shade' block) was missing – this threw off the index of every character that followed it. But a TON of code has been written with the erroneous character indices. By default, the library uses the original 'wrong' behavior and old sketches will still work. Pass 'true' to this function to use correct CP437 character values in your code.
 
virtual size_t write (uint8_t)
 Print one byte/character of data, used to support print()
 
virtual void write (uint8_t)
 
int16_t width (void) const
 Get width of the display, accounting for current rotation.
 
int16_t height (void) const
 Get height of the display, accounting for current rotation.
 
uint8_t getRotation (void) const
 Get rotation setting for display.
 
int16_t getCursorX (void) const
 Get text cursor X location.
 
int16_t getCursorY (void) const
 Get text cursor Y location.
 

Protected Attributes

SPISettings spiSettings
 
- Protected Attributes inherited from Adafruit_GFX
int16_t WIDTH
 This is the 'raw' display width - never changes.
 
int16_t HEIGHT
 This is the 'raw' display height - never changes.
 
int16_t _width
 Display width as modified by current rotation.
 
int16_t _height
 Display height as modified by current rotation.
 
int16_t cursor_x
 x location to start print()ing text
 
int16_t cursor_y
 y location to start print()ing text
 
uint16_t textcolor
 16-bit background color for print()
 
uint16_t textbgcolor
 16-bit text color for print()
 
uint8_t textsize_x
 Desired magnification in X-axis of text to print()
 
uint8_t textsize_y
 Desired magnification in Y-axis of text to print()
 
uint8_t rotation
 Display rotation (0 thru 3)
 
bool wrap
 If set, 'wrap' text at right edge of display.
 
bool _cp437
 If set, use correct CP437 charset (default is off)
 
GFXfontgfxFont
 Pointer to special font.
 

Private Member Functions

void SPIwrite (uint8_t d) __attribute__((always_inline))
 
void drawFastHLineInternal (int16_t x, int16_t y, int16_t w, uint16_t color)
 
void drawFastVLineInternal (int16_t x, int16_t y, int16_t h, uint16_t color)
 
void ssd1306_command1 (uint8_t c)
 
void ssd1306_commandList (const uint8_t *c, uint8_t n)
 

Private Attributes

SPIClassspi
 
TwoWire * wire
 
uint8_t * buffer
 
int8_t i2caddr
 
int8_t vccstate
 
int8_t page_end
 
int8_t mosiPin
 
int8_t clkPin
 
int8_t dcPin
 
int8_t csPin
 
int8_t rstPin
 
PortRegmosiPort
 
PortRegclkPort
 
PortRegdcPort
 
PortRegcsPort
 
PortMask mosiPinMask
 
PortMask clkPinMask
 
PortMask dcPinMask
 
PortMask csPinMask
 
uint32_t wireClk
 
uint32_t restoreClk
 
uint8_t contrast
 

Additional Inherited Members

- Protected Member Functions inherited from Adafruit_GFX
void charBounds (unsigned char c, int16_t *x, int16_t *y, int16_t *minx, int16_t *miny, int16_t *maxx, int16_t *maxy)
 Helper to determine size of a character with current font/size. Broke this out as it's used by both the PROGMEM- and RAM-resident getTextBounds() functions.
 

Detailed Description

Class that stores state and functions for interacting with SSD1306 OLED displays.

Constructor & Destructor Documentation

◆ Adafruit_SSD1306() [1/6]

Adafruit_SSD1306::Adafruit_SSD1306 ( uint8_t w,
uint8_t h,
TwoWire * twi = &Wire,
int8_t rst_pin = -1,
uint32_t clkDuring = 400000UL,
uint32_t clkAfter = 100000UL )

Constructor for I2C-interfaced SSD1306 displays.

Parameters
wDisplay width in pixels
hDisplay height in pixels
twiPointer to an existing TwoWire instance (e.g. &Wire, the microcontroller's primary I2C bus).
rst_pinReset pin (using Arduino pin numbering), or -1 if not used (some displays might be wired to share the microcontroller's reset pin).
clkDuringSpeed (in Hz) for Wire transmissions in SSD1306 library calls. Defaults to 400000 (400 KHz), a known 'safe' value for most microcontrollers, and meets the SSD1306 datasheet spec. Some systems can operate I2C faster (800 KHz for ESP32, 1 MHz for many other 32-bit MCUs), and some (perhaps not all) SSD1306's can work with this – so it's optionally be specified here and is not a default behavior. (Ignored if using pre-1.5.7 Arduino software, which operates I2C at a fixed 100 KHz.)
clkAfterSpeed (in Hz) for Wire transmissions following SSD1306 library calls. Defaults to 100000 (100 KHz), the default Arduino Wire speed. This is done rather than leaving it at the 'during' speed because other devices on the I2C bus might not be compatible with the faster rate. (Ignored if using pre-1.5.7 Arduino software, which operates I2C at a fixed 100 KHz.)
Returns
Adafruit_SSD1306 object.
Note
Call the object's begin() function before use – buffer allocation is performed there!

Constructor for SPI SSD1306 displays, using software (bitbang) SPI.

Parameters
wDisplay width in pixels
hDisplay height in pixels
mosi_pinMOSI (master out, slave in) pin (using Arduino pin numbering). This transfers serial data from microcontroller to display.
sclk_pinSCLK (serial clock) pin (using Arduino pin numbering). This clocks each bit from MOSI.
dc_pinData/command pin (using Arduino pin numbering), selects whether display is receiving commands (low) or data (high).
rst_pinReset pin (using Arduino pin numbering), or -1 if not used (some displays might be wired to share the microcontroller's reset pin).
cs_pinChip-select pin (using Arduino pin numbering) for sharing the bus with other devices. Active low.
Returns
Adafruit_SSD1306 object.
Note
Call the object's begin() function before use – buffer allocation is performed there!

◆ Adafruit_SSD1306() [2/6]

Adafruit_SSD1306::Adafruit_SSD1306 ( uint8_t w,
uint8_t h,
int8_t mosi_pin,
int8_t sclk_pin,
int8_t dc_pin,
int8_t rst_pin,
int8_t cs_pin )

◆ Adafruit_SSD1306() [3/6]

Adafruit_SSD1306::Adafruit_SSD1306 ( uint8_t w,
uint8_t h,
SPIClass * spi,
int8_t dc_pin,
int8_t rst_pin,
int8_t cs_pin,
uint32_t bitrate = 8000000UL )

Constructor for SPI SSD1306 displays, using native hardware SPI.

Parameters
wDisplay width in pixels
hDisplay height in pixels
spiPointer to an existing SPIClass instance (e.g. &SPI, the microcontroller's primary SPI bus).
dc_pinData/command pin (using Arduino pin numbering), selects whether display is receiving commands (low) or data (high).
rst_pinReset pin (using Arduino pin numbering), or -1 if not used (some displays might be wired to share the microcontroller's reset pin).
cs_pinChip-select pin (using Arduino pin numbering) for sharing the bus with other devices. Active low.
bitrateSPI clock rate for transfers to this display. Default if unspecified is 8000000UL (8 MHz).
Returns
Adafruit_SSD1306 object.
Note
Call the object's begin() function before use – buffer allocation is performed there!

◆ Adafruit_SSD1306() [4/6]

Adafruit_SSD1306::Adafruit_SSD1306 ( int8_t mosi_pin,
int8_t sclk_pin,
int8_t dc_pin,
int8_t rst_pin,
int8_t cs_pin )

DEPRECATED constructor for SPI SSD1306 displays, using software (bitbang) SPI. Provided for older code to maintain compatibility with the current library. Screen size is determined by enabling one of the SSD1306_* size defines in Adafruit_SSD1306.h. New code should NOT use this.

Parameters
mosi_pinMOSI (master out, slave in) pin (using Arduino pin numbering). This transfers serial data from microcontroller to display.
sclk_pinSCLK (serial clock) pin (using Arduino pin numbering). This clocks each bit from MOSI.
dc_pinData/command pin (using Arduino pin numbering), selects whether display is receiving commands (low) or data (high).
rst_pinReset pin (using Arduino pin numbering), or -1 if not used (some displays might be wired to share the microcontroller's reset pin).
cs_pinChip-select pin (using Arduino pin numbering) for sharing the bus with other devices. Active low.
Returns
Adafruit_SSD1306 object.
Note
Call the object's begin() function before use – buffer allocation is performed there!

◆ Adafruit_SSD1306() [5/6]

Adafruit_SSD1306::Adafruit_SSD1306 ( int8_t dc_pin,
int8_t rst_pin,
int8_t cs_pin )

DEPRECATED constructor for SPI SSD1306 displays, using native hardware SPI. Provided for older code to maintain compatibility with the current library. Screen size is determined by enabling one of the SSD1306_* size defines in Adafruit_SSD1306.h. New code should NOT use this. Only the primary SPI bus is supported, and bitrate is fixed at 8 MHz.

Parameters
dc_pinData/command pin (using Arduino pin numbering), selects whether display is receiving commands (low) or data (high).
rst_pinReset pin (using Arduino pin numbering), or -1 if not used (some displays might be wired to share the microcontroller's reset pin).
cs_pinChip-select pin (using Arduino pin numbering) for sharing the bus with other devices. Active low.
Returns
Adafruit_SSD1306 object.
Note
Call the object's begin() function before use – buffer allocation is performed there!

◆ Adafruit_SSD1306() [6/6]

Adafruit_SSD1306::Adafruit_SSD1306 ( int8_t rst_pin = -1)

DEPRECATED constructor for I2C SSD1306 displays. Provided for older code to maintain compatibility with the current library. Screen size is determined by enabling one of the SSD1306_* size defines in Adafruit_SSD1306.h. New code should NOT use this. Only the primary I2C bus is supported.

Parameters
rst_pinReset pin (using Arduino pin numbering), or -1 if not used (some displays might be wired to share the microcontroller's reset pin).
Returns
Adafruit_SSD1306 object.
Note
Call the object's begin() function before use – buffer allocation is performed there!

◆ ~Adafruit_SSD1306()

Adafruit_SSD1306::~Adafruit_SSD1306 ( void )

Destructor for Adafruit_SSD1306 object.

Member Function Documentation

◆ begin()

bool Adafruit_SSD1306::begin ( uint8_t vcs = SSD1306_SWITCHCAPVCC,
uint8_t addr = 0,
bool reset = true,
bool periphBegin = true )

Allocate RAM for image buffer, initialize peripherals and pins.

Parameters
vcsVCC selection. Pass SSD1306_SWITCHCAPVCC to generate the display voltage (step up) from the 3.3V source, or SSD1306_EXTERNALVCC otherwise. Most situations with Adafruit SSD1306 breakouts will want SSD1306_SWITCHCAPVCC.
addrI2C address of corresponding SSD1306 display (or pass 0 to use default of 0x3C for 128x32 display, 0x3D for all others). SPI displays (hardware or software) do not use addresses, but this argument is still required (pass 0 or any value really, it will simply be ignored). Default if unspecified is 0.
resetIf true, and if the reset pin passed to the constructor is valid, a hard reset will be performed before initializing the display. If using multiple SSD1306 displays on the same bus, and if they all share the same reset pin, you should only pass true on the first display being initialized, false on all others, else the already-initialized displays would be reset. Default if unspecified is true.
periphBeginIf true, and if a hardware peripheral is being used (I2C or SPI, but not software SPI), call that peripheral's begin() function, else (false) it has already been done in one's sketch code. Cases where false might be used include multiple displays or other devices sharing a common bus, or situations on some platforms where a nonstandard begin() function is available (e.g. a TwoWire interface on non-default pins, as can be done on the ESP8266 and perhaps others).
Returns
true on successful allocation/init, false otherwise. Well-behaved code should check the return value before proceeding.
Note
MUST call this function before any drawing or updates!

◆ clearDisplay()

void Adafruit_SSD1306::clearDisplay ( void )

Clear contents of display buffer (set all pixels to off).

Returns
None (void).
Note
Changes buffer contents only, no immediate effect on display. Follow up with a call to display(), or with other graphics commands as needed by one's own application.

◆ dim()

void Adafruit_SSD1306::dim ( bool dim)

Dim the display.

Parameters
dimtrue to enable lower brightness mode, false for full brightness.
Returns
None (void).
Note
This has an immediate effect on the display, no need to call the display() function – buffer contents are not changed.

◆ display()

void Adafruit_SSD1306::display ( void )

Push data currently in RAM to SSD1306 display.

Returns
None (void).
Note
Drawing operations are not visible until this function is called. Call after each graphics command, or after a whole set of graphics commands, as best needed by one's own application.

◆ drawFastHLine()

void Adafruit_SSD1306::drawFastHLine ( int16_t x,
int16_t y,
int16_t w,
uint16_t color )
virtual

Draw a horizontal line. This is also invoked by the Adafruit_GFX library in generating many higher-level graphics primitives.

Parameters
xLeftmost column – 0 at left to (screen width - 1) at right.
yRow of display – 0 at top to (screen height -1) at bottom.
wWidth of line, in pixels.
colorLine color, one of: SSD1306_BLACK, SSD1306_WHITE or SSD1306_INVERT.
Returns
None (void).
Note
Changes buffer contents only, no immediate effect on display. Follow up with a call to display(), or with other graphics commands as needed by one's own application.

Reimplemented from Adafruit_GFX.

◆ drawFastHLineInternal()

void Adafruit_SSD1306::drawFastHLineInternal ( int16_t x,
int16_t y,
int16_t w,
uint16_t color )
private

◆ drawFastVLine()

void Adafruit_SSD1306::drawFastVLine ( int16_t x,
int16_t y,
int16_t h,
uint16_t color )
virtual

Draw a vertical line. This is also invoked by the Adafruit_GFX library in generating many higher-level graphics primitives.

Parameters
xColumn of display – 0 at left to (screen width -1) at right.
yTopmost row – 0 at top to (screen height - 1) at bottom.
hHeight of line, in pixels.
colorLine color, one of: SSD1306_BLACK, SSD1306_WHITE or SSD1306_INVERT.
Returns
None (void).
Note
Changes buffer contents only, no immediate effect on display. Follow up with a call to display(), or with other graphics commands as needed by one's own application.

Reimplemented from Adafruit_GFX.

◆ drawFastVLineInternal()

void Adafruit_SSD1306::drawFastVLineInternal ( int16_t x,
int16_t y,
int16_t h,
uint16_t color )
private

◆ drawPixel()

void Adafruit_SSD1306::drawPixel ( int16_t x,
int16_t y,
uint16_t color )
virtual

Set/clear/invert a single pixel. This is also invoked by the Adafruit_GFX library in generating many higher-level graphics primitives.

Parameters
xColumn of display – 0 at left to (screen width - 1) at right.
yRow of display – 0 at top to (screen height -1) at bottom.
colorPixel color, one of: SSD1306_BLACK, SSD1306_WHITE or SSD1306_INVERT.
Returns
None (void).
Note
Changes buffer contents only, no immediate effect on display. Follow up with a call to display(), or with other graphics commands as needed by one's own application.

Implements Adafruit_GFX.

◆ getBuffer()

uint8_t * Adafruit_SSD1306::getBuffer ( void )

Get base address of display buffer for direct reading or writing.

Returns
Pointer to an unsigned 8-bit array, column-major, columns padded to full byte boundary if needed.

◆ getPixel()

bool Adafruit_SSD1306::getPixel ( int16_t x,
int16_t y )

Return color of a single pixel in display buffer.

Parameters
xColumn of display – 0 at left to (screen width - 1) at right.
yRow of display – 0 at top to (screen height -1) at bottom.
Returns
true if pixel is set (usually SSD1306_WHITE, unless display invert mode is enabled), false if clear (SSD1306_BLACK).
Note
Reads from buffer contents; may not reflect current contents of screen if display() has not been called.

◆ invertDisplay()

void Adafruit_SSD1306::invertDisplay ( bool i)
virtual

Enable or disable display invert mode (white-on-black vs black-on-white).

Parameters
iIf true, switch to invert mode (black-on-white), else normal mode (white-on-black).
Returns
None (void).
Note
This has an immediate effect on the display, no need to call the display() function – buffer contents are not changed, rather a different pixel mode of the display hardware is used. When enabled, drawing SSD1306_BLACK (value 0) pixels will actually draw white, SSD1306_WHITE (value 1) will draw black.

Reimplemented from Adafruit_GFX.

◆ SPIwrite()

void Adafruit_SSD1306::SPIwrite ( uint8_t d)
inlineprivate

◆ ssd1306_command()

void Adafruit_SSD1306::ssd1306_command ( uint8_t c)

Issue a single low-level command directly to the SSD1306 display, bypassing the library.

Parameters
cCommand to issue (0x00 to 0xFF, see datasheet).
Returns
None (void).

◆ ssd1306_command1()

void Adafruit_SSD1306::ssd1306_command1 ( uint8_t c)
private

◆ ssd1306_commandList()

void Adafruit_SSD1306::ssd1306_commandList ( const uint8_t * c,
uint8_t n )
private

◆ startscrolldiagleft()

void Adafruit_SSD1306::startscrolldiagleft ( uint8_t start,
uint8_t stop )

Activate alternate diagonal scroll for all or part of the display.

Parameters
startFirst row.
stopLast row.
Returns
None (void).

◆ startscrolldiagright()

void Adafruit_SSD1306::startscrolldiagright ( uint8_t start,
uint8_t stop )

Activate a diagonal scroll for all or part of the display.

Parameters
startFirst row.
stopLast row.
Returns
None (void).

◆ startscrollleft()

void Adafruit_SSD1306::startscrollleft ( uint8_t start,
uint8_t stop )

Activate a left-handed scroll for all or part of the display.

Parameters
startFirst row.
stopLast row.
Returns
None (void).

◆ startscrollright()

void Adafruit_SSD1306::startscrollright ( uint8_t start,
uint8_t stop )

Activate a right-handed scroll for all or part of the display.

Parameters
startFirst row.
stopLast row.
Returns
None (void).

◆ stopscroll()

void Adafruit_SSD1306::stopscroll ( void )

Cease a previously-begun scrolling action.

Returns
None (void).

Member Data Documentation

◆ buffer

uint8_t* Adafruit_SSD1306::buffer
private

◆ clkPin

int8_t Adafruit_SSD1306::clkPin
private

◆ clkPinMask

PortMask Adafruit_SSD1306::clkPinMask
private

◆ clkPort

PortReg * Adafruit_SSD1306::clkPort
private

◆ contrast

uint8_t Adafruit_SSD1306::contrast
private

◆ csPin

int8_t Adafruit_SSD1306::csPin
private

◆ csPinMask

PortMask Adafruit_SSD1306::csPinMask
private

◆ csPort

PortReg * Adafruit_SSD1306::csPort
private

◆ dcPin

int8_t Adafruit_SSD1306::dcPin
private

◆ dcPinMask

PortMask Adafruit_SSD1306::dcPinMask
private

◆ dcPort

PortReg * Adafruit_SSD1306::dcPort
private

◆ i2caddr

int8_t Adafruit_SSD1306::i2caddr
private

◆ mosiPin

int8_t Adafruit_SSD1306::mosiPin
private

◆ mosiPinMask

PortMask Adafruit_SSD1306::mosiPinMask
private

◆ mosiPort

PortReg* Adafruit_SSD1306::mosiPort
private

◆ page_end

int8_t Adafruit_SSD1306::page_end
private

◆ restoreClk

uint32_t Adafruit_SSD1306::restoreClk
private

◆ rstPin

int8_t Adafruit_SSD1306::rstPin
private

◆ spi

SPIClass* Adafruit_SSD1306::spi
private

◆ spiSettings

SPISettings Adafruit_SSD1306::spiSettings
protected

◆ vccstate

int8_t Adafruit_SSD1306::vccstate
private

◆ wire

TwoWire* Adafruit_SSD1306::wire
private

◆ wireClk

uint32_t Adafruit_SSD1306::wireClk
private

The documentation for this class was generated from the following files: