Flexible Grayscale OLED Hookup Guide

Contributors: Englandsaurus

Library Overview

First, you'll need to download and install the Sparkfun Flexible Grayscale OLED Brekaout library. You can do this through the Arduino library manager or manually installing it by clicking the button below.

Before we get started developing a sketch, let's look at the available functions of the library.

• void command(uint8_t c); --- Sends the display a command byte.
• void data(uint8_t c); --- Sends the display a data byte.
• void setColumnAddress(uint8_t add); --- Sets the column address.
• void setPageAddress(uint8_t add); --- Sets the page address.

LCD Drawing Functions

• void clearDisplay(uint8_t mode): --- Clears the screen buffer in the OLED's memory, pass in mode = CLEAR_DISPLAY to clear the memory of the display, mode = CLEAR_BUFFER to clear the display buffer, or mode = CLEAR_ALL to clear both.
• void display(void); --- Moves display memory to the screen to draw the image in memory.
• void setCursor(uint8_t x, uint8_t y); --- Set cursor position to (x, y).
• void invert(boolean inv); --- Turns every black pixel white, turns all white pixels black.
• void setContrast(uint8_t contrast); --- Changes the contrast value anywhere between 0 and 255.
• void flipVertical(boolean flip); --- Does a vertical mirror of the screen.

• void flipHorizontal(boolean flip); --- Does a horiontal mirror of the screen.

• void setPixel(uint8_t x, uint8_t y); --- Draw a pixel using the current fore color and current draw mode in the screen buffer's x,y position.

• void setPixel(uint8_t x, uint8_t y, uint8_t color, uint8_t mode); --- Draw a pixel with NORM or XOR draw mode in the screen buffer's x,y position.

• void line(uint8_t x0, uint8_t y0, uint8_t x1, uint8_t y1); --- Draw line using current fore color and current draw mode from x0,y0 to x1,y1 of the screen buffer.

• void line(uint8_t x0, uint8_t y0, uint8_t x1, uint8_t y1, uint8_t color, uint8_t mode); --- Draw line using color and mode from x0,y0 to x1,y1 of the screen buffer.
• void lineH(uint8_t x, uint8_t y, uint8_t width); --- Draw horizontal line using current fore color and current draw mode from x,y to x+width,y of the screen buffer.
• void lineH(uint8_t x, uint8_t y, uint8_t width, uint8_t color, uint8_t mode); --- Draw horizontal line using color and mode from x,y to x+width,y of the screen buffer.
• void lineV(uint8_t x, uint8_t y, uint8_t height); --- Draw vertical line using current fore color and current draw mode from x,y to x,y+height of the screen buffer.

• void lineV(uint8_t x, uint8_t y, uint8_t height, uint8_t color, uint8_t mode); --- Draw vertical line using color and mode from x,y to x,y+height of the screen buffer.

• void rect(uint8_t x, uint8_t y, uint8_t width, uint8_t height); --- Draw rectangle using current fore color and current draw mode from x,y to x+width,y+height of the screen buffer.

• void rect(uint8_t x, uint8_t y, uint8_t width, uint8_t height, uint8_t color , uint8_t mode); ---Draw rectangle using color and mode from x,y to x+width,y+height of the screen buffer.
• void rectFill(uint8_t x, uint8_t y, uint8_t width, uint8_t height); --- Draw filled rectangle using current fore color and current draw mode from x,y to x+width,y+height of the screen buffer.

• void rectFill(uint8_t x, uint8_t y, uint8_t width, uint8_t height, uint8_t color , uint8_t mode); --- Draw filled rectangle using color and mode from x,y to x+width,y+height of the screen buffer.

• void circle(uint8_t x, uint8_t y, uint8_t radius); --- Draw circle with radius using current fore color and current draw mode with center at x,y of the screen buffer.

• void circle(uint8_t x, uint8_t y, uint8_t radius, uint8_t color, uint8_t mode); --- Draw circle with radius using color and mode with center at x,y of the screen buffer.
• void circleFill(uint8_t x0, uint8_t y0, uint8_t radius); --- Draw filled circle with radius using current fore color and current draw mode with center at x,y of the screen buffer.

• void circleFill(uint8_t x0, uint8_t y0, uint8_t radius, uint8_t color, uint8_t mode); --- Draw filled circle with radius using color and mode with center at x,y of the screen buffer.

• void drawChar(uint8_t x, uint8_t y, uint8_t c); --- Draws a character at position (x, y).

• void drawChar(uint8_t x, uint8_t y, uint8_t c, uint8_t color, uint8_t mode); --- Draws a character using a color and mode at position (x, y)

• void drawBitmap(uint8_t * bitArray); --- Draws a preloaded bitmap.

• uint16_t getDisplayWidth(void); --- Gets the width of the OLED.
• uint16_t getDisplayHeight(void); --- Gets the height of the OLED.
• void setDisplayWidth(uint16_t); --- Sets the width of the OLED.
• void setDisplayHeight(uint16_t); --- Sets the height of the OLED.
• void setColor(uint8_t color); --- Sets the color of the OLED
• void setDrawMode(uint8_t mode); --- Sets the drawing mode of the OLED
• uint8_t *getScreenBuffer(void); ---

Font Settings

• uint8_t getFontWidth(void); --- Gets the current font width as a byte.
• uint8_t getFontHeight(void); --- Gets the current font height as a byte.
• uint8_t getTotalFonts(void); --- Return the total number of fonts loaded into the MicroOLED's flash memory.
• uint8_t getFontType(void); --- Returns the font type number of the current font (Font types shown below).

• boolean setFontType(uint8_t type); --- Sets the font type (Font types shown below).

• uint8_t getFontStartChar(void); --- Returns the starting ASCII character of the current font.
• uint8_t getFontTotalChar(void); --- Return the total characters of the current font.

Rotation and Scrolling

The following functions will scroll the screen in the various specified directions of each function. Start and stop indicate the range of rows/columns that will be scrolling.

• void scrollRight(uint8_t start, uint8_t stop);
• void scrollLeft(uint8_t start, uint8_t stop);
• void scrollUp(uint8_t start, uint8_t stop);
• void scrollStop(void);