README.md
Version

Overview

SSD1351 is a 16-bits color OLED driver.

1582693180631.jpg

You can get OLED displays from belows:

Wiring

Here is a wiring example for SPI0 of Kameleon Core.

SSD1351 (OLED) Kameleon Core
3V3 3V3
GND GND
DATA (MOSI) 12 (SPI0-MOSI)
CLK 10 (SPI0 CLK)
D/C 8
RST 9
CS 17

1582692784007.png

Usage

You can initialize SSD1351 driver using SPI interface as below:

var SSD1351 = require('@niklauslee/ssd1351').SSD1351;

var SPI = require('spi').SPI;
var spi0 = new SPI(0);
var ssd1351 = new SSD1351();
var options = {
  width: 128,
  height: 128,
  dcPin: 8,
  rstPin: 9,
  csPin: 17
};
ssd1351.setup(spi0, options, () => {
  var gc = ssd1351.getContext();
  // gc.drawRect(0, 0, width, height);
});

You can use BufferedGraphicsContext instead of general callback-based graphics context as below:

// buffered graphic context
var gc = ssd1351.getContext('buffer');
gc.drawRect(0, 0, width, height);
gc.display(); // must call if buffered graphic context
...

Note that BufferedGraphicsContext allocates a lot of memory (32KB for 128x128 resolution). You cannot use memory enough for you other codes.

API

Class: SSD1351

A class for SSD1351 driver communicating with SPI interface.

new SSD1351()

Create an instance of SSD1351 driver for SPI interface.

ssd1351.setup(spi[, options[, callback]])

  • spi <SPI> An instance of SPI to communicate.
  • options <object> Options for initialization.
    • width <number> Width of display in pixels. Default: 128.
    • height <number> Height of display in pixels. Default: 128.
    • dcPin <number> Pin number for DC. Default: -1.
    • rstPin <number> Pin number for RST (Reset). Default: -1.
    • csPin <number> Pin number of CS (Chip select). Default: -1.
    • extVcc <boolean> Indicate whether to use external VCC. Default: false.
    • rotation <number> Rotation of screen. One of 0 (0 degree), 1 (90 degree in clockwise), 2 (180 degree in clockwise), and 3 (270 degree in clockwise). Default: 0.
  • callback <Function> A function called when setup is complete.

Setup SSD1351 driver for a given SPI bus and options.

ssd1351.getContext([type])

  • type: Optional. Type of graphic context. If "buffer" is given, BufferedGraphicContext is returned.
  • Returns: <GraphicContext> An instance of graphic context for SSD1351.

Get a graphic context.

Note that BufferedGraphicContext is much faster, but it consumes memory a lot.

Note that gc.getPixel(x, y) function is supported only if BufferedGraphicsContext.

Examples

  • ex_128x128.js (128x128 resolution)
  • ex_128x96.js (128x96 resolution)
  • ex_buffer_128x128.js (128x128 resolution with buffered graphics context)
  • ex_buffer_128x96.js (128x96 resolution with buffered graphics context)