platformio lib install 2978

Service level promise

Credits

mbed-os

Usage

Upgrade

Features

Fonts

Hardware Abstraction

I2C with Wire.h

#include<Wire.h>#include"SSD1306Wire.h"// for 128x64 displays:SSD1306Wiredisplay(0x3c, SDA, SCL);// ADDRESS, SDA, SCL// for 128x32 displays:// SSD1306Wire display(0x3c, SDA, SCL, GEOMETRY_128_32);  // ADDRESS, SDA, SCL, GEOMETRY_128_32 (or 128_64)// for using 2nd Hardware I2C (if available)// SSD1306Wire(0x3c, SDA, SCL, GEOMETRY_128_64, I2C_TWO); //default value is I2C_ONE if not mentioned// By default SD1306Wire set I2C frequency to 700000, you can use set either another frequency or skip setting the frequency by providing -1 value// SSD1306Wire(0x3c, SDA, SCL, GEOMETRY_128_64, I2C_ONE, 400000); //set I2C frequency to 400kHz// SSD1306Wire(0x3c, SDA, SCL, GEOMETRY_128_64, I2C_ONE, -1); //skip setting the I2C bus frequency

#include<Wire.h>#include"SH1106Wire.h"SH1106Wiredisplay(0x3c, SDA, SCL);// ADDRESS, SDA, SCL// By default SH1106Wire set I2C frequency to 700000, you can use set either another frequency or skip setting the frequency by providing -1 value// SH1106Wire(0x3c, SDA, SCL, GEOMETRY_128_64, I2C_ONE, 400000); //set I2C frequency to 400kHz// SH1106Wire(0x3c, SDA, SCL, GEOMETRY_128_64, I2C_ONE, -1); //skip setting the I2C bus frequency

I2C with brzo_i2c

#include<brzo_i2c.h>#include"SSD1306Brzo.h"SSD1306Brzodisplay(0x3c, SDA, SCL);// ADDRESS, SDA, SCL

#include<brzo_i2c.h>#include"SH1106Brzo.h"SH1106Brzodisplay(0x3c, SDA, SCL);// ADDRESS, SDA, SCL

SPI

#include<SPI.h>#include"SSD1306Spi.h"SSD1306Spidisplay(D0, D2, D8);// RES, DC, CS

#include<SPI.h>#include"SH1106Spi.h"SH1106Spidisplay(D0, D2, CS);// RES, DC, CS

API

Display Control

// Initialize the displayvoidinit();// Free the memory used by the displayvoidend();// Cycle through the initializationvoidresetDisplay(void);// Connect again to the display through I2Cvoidreconnect(void);// Turn the display onvoiddisplayOn(void);// Turn the display offsvoiddisplayOff(void);// Clear the local pixel buffervoidclear(void);// Write the buffer to the display memoryvoiddisplay(void);// Inverted display modevoidinvertDisplay(void);// Normal display modevoidnormalDisplay(void);// Set display contrast// really low brightness & contrast: contrast = 10, precharge = 5, comdetect = 0// normal brightness & contrast:  contrast = 100voidsetContrast(uint8_t contrast,uint8_t precharge =241,uint8_t comdetect =64);// Convenience method to accessvoidsetBrightness(uint8_t);// Turn the display upside downvoidflipScreenVertically();// Draw the screen mirroredvoidmirrorScreen();

Pixel drawing

/* Drawing functions*/// Sets the color of all pixel operations// color : BLACK, WHITE, INVERSEvoidsetColor(OLEDDISPLAY_COLOR color);// Draw a pixel at given positionvoidsetPixel(int16_t x,int16_t y);// Draw a line from position 0 to position 1voiddrawLine(int16_t x0,int16_t y0,int16_t x1,int16_t y1);// Draw the border of a rectangle at the given locationvoiddrawRect(int16_t x,int16_t y,int16_t width,int16_t height);// Fill the rectanglevoidfillRect(int16_t x,int16_t y,int16_t width,int16_t height);// Draw the border of a circlevoiddrawCircle(int16_t x,int16_t y,int16_t radius);// Fill circlevoidfillCircle(int16_t x,int16_t y,int16_t radius);// Draw an empty triangle i.e. only the outlinevoiddrawTriangle(int16_t x0,int16_t y0,int16_t x1,int16_t y1,int16_t x2,int16_t y2);// Draw a solid triangle i.e. filledvoidfillTriangle(int16_t x0,int16_t y0,int16_t x1,int16_t y1,int16_t x2,int16_t y2);// Draw a line horizontallyvoiddrawHorizontalLine(int16_t x,int16_t y,int16_t length);// Draw a lin verticallyvoiddrawVerticalLine(int16_t x,int16_t y,int16_t length);// Draws a rounded progress bar with the outer dimensions given by width and height. Progress is// a unsigned byte value between 0 and 100voiddrawProgressBar(uint16_t x,uint16_t y,uint16_t width,uint16_t height,uint8_t progress);// Draw a bitmap in the internal image formatvoiddrawFastImage(int16_t x,int16_t y,int16_t width,int16_t height,constuint8_t *image);// Draw a XBMvoiddrawXbm(int16_t x,int16_t y,int16_t width,int16_t height,constuint8_t *xbm);

Text operations

// Draws a string at the given location, returns how many chars have been writtenuint16_tdrawString(int16_t x,int16_t y,const String &text);// Draws a String with a maximum width at the given location.// If the given String is wider than the specified width// The text will be wrapped to the next line at a space or dash// returns 0 if everything fits on the screen or the numbers of characters in the// first line if notuint16_tdrawStringMaxWidth(int16_t x,int16_t y,uint16_t maxLineWidth,const String &text);// Returns the width of the const char* with the current// font settingsuint16_tgetStringWidth(constchar* text,uint16_t length,bool utf8 =false);// Convencience method for the const char versionuint16_tgetStringWidth(const String &text);// Specifies relative to which anchor point// the text is rendered. Available constants:// TEXT_ALIGN_LEFT, TEXT_ALIGN_CENTER, TEXT_ALIGN_RIGHT, TEXT_ALIGN_CENTER_BOTHvoidsetTextAlignment(OLEDDISPLAY_TEXT_ALIGNMENT textAlignment);// Sets the current font. Available default fonts// ArialMT_Plain_10, ArialMT_Plain_16, ArialMT_Plain_24// Or create one with the font tool at http://oleddisplay.squix.chvoidsetFont(constuint8_t* fontData);

ArduinoPrint functionality

// cls() will clear the display immediately and empty the logBuffer, meaning// the next print statement will print at the top of the display again.// cls() should not be confused with clear(), which only clears the internal// graphics buffer, which can then be shown on the display with display().voidcls();> _Note that printing to the display, contrary to what you might expect, doesnot wrap your lines, so everything on a line that doesn't fit on the screen is cut off._

Ui Library (OLEDDisplayUi)

/** * Initialise the display*/voidinit();/** * Configure the internal used target FPS*/voidsetTargetFPS(uint8_t fps);/** * Enable automatic transition to next frame after the some time can be configured with * `setTimePerFrame` and `setTimePerTransition`.*/voidenableAutoTransition();/** * Disable automatic transition to next frame.*/voiddisableAutoTransition();/** * Set the direction if the automatic transitioning*/voidsetAutoTransitionForwards();voidsetAutoTransitionBackwards();/** *  Set the approx. time a frame is displayed*/voidsetTimePerFrame(uint16_t time);/** * Set the approx. time a transition will take*/voidsetTimePerTransition(uint16_t time);/** * Draw the indicator. * This is the default state for all frames if * the indicator was hidden on the previous frame * it will be slided in.*/voidenableIndicator();/** * Don't draw the indicator. * This will slide out the indicator * when transitioning to the next frame.*/voiddisableIndicator();/** * Enable drawing of all indicators.*/voidenableAllIndicators();/** * Disable drawing of all indicators.*/voiddisableAllIndicators();/** * Set the position of the indicator bar.*/voidsetIndicatorPosition(IndicatorPosition pos);/** * Set the direction of the indicator bar. Defining the order of frames ASCENDING / DESCENDING*/voidsetIndicatorDirection(IndicatorDirection dir);/** * Set the symbol to indicate an active frame in the indicator bar.*/voidsetActiveSymbol(constuint8_t* symbol);/** * Set the symbol to indicate an inactive frame in the indicator bar.*/voidsetInactiveSymbol(constuint8_t* symbol);/** * Configure what animation is used to transition from one frame to another*/voidsetFrameAnimation(AnimationDirection dir);/** * Add frame drawing functions*/voidsetFrames(FrameCallback* frameFunctions,uint8_t frameCount);/** * Add overlays drawing functions that are draw independent of the Frames*/voidsetOverlays(OverlayCallback* overlayFunctions,uint8_t overlayCount);/** * Set the function that will draw each step * in the loading animation*/voidsetLoadingDrawFunction(LoadingDrawFunction loadingDrawFunction);/** * Run the loading process*/voidrunLoadingProcess(LoadingStage* stages,uint8_t stagesCount);// Manual controlvoidnextFrame();voidpreviousFrame();/** * Switch without transition to frame `frame`.*/voidswitchToFrame(uint8_t frame);/** * Transition to frame `frame`. When the `frame` number is bigger than the current * frame the forward animation will be used, otherwise the backwards animation is used.*/voidtransitionToFrame(uint8_t frame);// State InfoOLEDDisplayUiState*getUiState();// This needs to be called in the main loop// the returned value is the remaining time (in ms)// you have to draw after drawing to keep the frame budget.int8_tupdate();

Creating and using XBM bitmaps

constunsignedchar epd_example [] PROGMEM = {0x00,0x00,0x00,0x00,0x00,0x00, ...     ...};

display.clear();display.drawXbm(0,0,128,64, epd_example);// assuming your bitmap is 128x64display.display();

Example: SSD1306Demo

Frame 1

Frame 2

Frame 3

Frame 4

SPI version

Selection of projects using this library