oled-ssd1306-i2c

!‘npm version’ !‘downloads over month’

OLED JS Pi
========================

!oled-cat

What is this?

A NodeJS driver for I2C/SPI compatible monochrome OLED screens. Only I2C is supported at this time.
Compatible with Raspberry Pi, Works with 128 x 32, 128 x 64, 96 x 16 and 64x48 sized screens, of the SSD1306 OLED/PLED Controller (read the datasheet here).

This based on the Blog Post and code by Suz Hinton - Read her blog post about how OLED screens work!

OLED screens are really cool - now you can control them with JavaScript!

Install

If you haven't already, install NodeJS.

npm install oled-ssd1306-i2c

I2C screens

Hook up I2C compatible oled to the Raspberry Pi. Pins: SDL and SCL.

$3

``javascript
var oled = require('oled-ssd1306-i2c');

var opts = {
width: 128,
height: 64,
};

var oled = new oled(opts);

// do cool oled things here
`

The above code uses the default I2C address of 0x3C and the I2C device /dev/i2c-1 (default on newer Raspberry Pi boards).

Additional options that can be passed, with default values shown:

`javascript
var opts = {
width: 128, // screen width
height; 32, // screen height
address: 0x3C, // Pass I2C address of screen if it is not the default of 0x3C
device: '/dev/i2c-1', // Pass your i2c device here if it is not /dev/i2c-1
microview: true, // set to true if you have a microview display
};
`

Allowable combinations for screen width and height are:
128x32, 128x64, 96x16 and 64x48.

$3

You can use the i2c npm library for this. Make sure the display is connected to the I2C bus with pull-ups and run the
following:

`
npm install i2c
`

Then run the following script:

`javascript
var i2c = require('i2c');
var address = 0x3C;
var wire = new i2c(address, {device: '/dev/i2c-1'});

wire.scan(function(err, data) {
// result contains an array of addresses
});
`

This will return the I2C addresses of any I2C devices connected to the bus at /dev/i2c-1. If you have other devices
than the screen attached, you will need to manually filter those out.

Available methods

$3

Usage:
`javascript
oled.clearDisplay();
`

$3

Usage:
`javascript
oled.dimDisplay(true|false);
`

$3

Usage:
`javascript
oled.invertDisplay(true|false);
`

$3

Usage:
`javascript
oled.turnOffDisplay();
`

$3

Usage:
`javascript
oled.turnOnDisplay();
`

$3

Usage:
`javascript
// draws 4 white pixels total
// format: [x, y, color]
oled.drawPixel([
[128, 1, 1],
[128, 32, 1],
[128, 16, 1],
[64, 16, 1]
]);
`

$3

Usage:
`javascript
// args: (x0, y0, x1, y1, color)
oled.drawLine(1, 1, 128, 32, 1);
`

$3

Usage:
`javascript
// args: (x0, y0, x1, y1, color)
oled.fillRect(1, 1, 10, 20, 1);
`

$3

Usage:
`javascript
// args: (x0, y0, x1, y1, color)
oled.drawRect(1, 1, 10, 20, 1);
`

$3

Usage:
`javascript
// args: (x, y, r, color)
oled.drawCircle(30, 10, 5, 1);
`

$3


Example usage:
`
npm install pngparse
`

`javascript
var pngparse = require('pngparse');

pngparse.parseFile('indexed_file.png', function(err, image) {
oled.drawBitmap(image.data);
});
`

This method is provided as a primitive convenience. A better way to display images is to use NodeJS package png-to-lcd instead. It's just as easy to use as drawBitmap, but is compatible with all image depths (lazy is good!). It will also auto-dither if you choose. You should still resize your image to your screen dimensions. This alternative method is covered below:

`
npm install png-to-lcd
`

`javascript
var pngtolcd = require('png-to-lcd');

pngtolcd('nyan-cat.png', true, function(err, bitmap) {
oled.buffer = bitmap;
oled.update();
});
`

$3

Usage:
`javascript
// args: (direction, start, stop)
oled.startscroll('left', 0, 15); // this will scroll an entire 128 x 32 screen
`

$3

Usage:
`javascript
oled.stopscroll();
`

$3

Usage:
`javascript
// sets cursor to x = 1, y = 1
oled.setCursor(1, 1);
`

$3

Usage:
`
npm install oled-font-5x7
`

`javascript
var font = require('oled-font-5x7');

// sets cursor to x = 1, y = 1
oled.setCursor(1, 1);
oled.writeString(font, 1, 'Cats and dogs are really cool animals, you know.', 1, true);
`

$3

Usage:
`javascript
oled.update();
``

Forked from https://github.com/kd7yva/oled-js-pi