API for SSD1306 I2C-controlled OLED displays. More...

Detailed Description

ID: ssd1306
Name: OLED Display
Other Names: Adafruit SSD1306 OLED Display 0.96"
Category: display
Manufacturer: adafruit
Link: https://www.adafruit.com/datasheets/SSD1306.pdf
Link: http://www.farnell.com/datasheets/609753.pdf
Connection: i2c

SSD1306 is a 128x64 dot-matrix OLED/PLED segment driver with a controller. This device is available from many suppliers for a very low cost. This implementation was tested using a generic SSD1306 device from eBay.

Public Member Functions
synchronized void	delete ()

	SSD1306 (int bus, int address)

	SSD1306 (int bus)

int	draw (byte[] data)

int	write (String msg)

int	setCursor (int row, int column)

int	clear ()

int	home ()

int	invert (boolean i)

void	startscrollright (short start, short stop)

void	startscrollleft (short start, short stop)

void	startscrolldiagright (short start, short stop)

void	startscrolldiagleft (short start, short stop)

void	stopscroll ()

void	dim (boolean dim)

Public Member Functions inherited from LCD
synchronized void	delete ()

int	write (int x, int y, String msg)

int	write (String msg)

int	setCursor (int row, int column)

int	clear ()

int	home ()

String	name ()

Constructor & Destructor Documentation

SSD1306	(	int	bus,
		int	address
	)

SSD1306 constructor; calls libmraa initialisation functions

Parameters

bus	I2C bus to use
address	Slave address the LCD is registered on

Member Function Documentation

int clear ( )

Clears the display of all characters

Returns: Result of the operation

void dim ( boolean dim )

Dims display

Parameters

dim	True to dim display, false for max intensity

Returns: Result of last operation

int home ( )

Returns to the original coordinates (0,0)

Returns: Result of the operation

int invert ( boolean i )

Inverts the display

Parameters

i	true to invert, false for normal display

Returns: Result of the operation

int setCursor	(	int	row,
		int	column
	)

Sets the cursor to specified coordinates

Parameters

row	Row to set the cursor to
column	Column to set the cursor to

Returns: Result of the operation

void startscrolldiagleft	(	short	start,
		short	stop
	)

Activate a scroll to the upper left for rows start through stop The display is 16 rows tall. To scroll the whole display, run: display.startscrolldiaagright(0x00, 0x0F)

Parameters

start	First row to scroll
stop	Last row to scroll

Returns: void

void startscrolldiagright	(	short	start,
		short	stop
	)

Activate a scroll to the upper right for rows start through stop The display is 16 rows tall. To scroll the whole display, run: display.startscrollleft(0x00, 0x0F)

Parameters

start	First row to scroll
stop	Last row to scroll

Returns: void

void startscrollleft	(	short	start,
		short	stop
	)

Activate a scroll to the left for rows start through stop The display is 16 rows tall. To scroll the whole display, run: display.startscrollright(0x00, 0x0F)

Parameters

start	First row to scroll
stop	Last row to scroll

Returns: void

void startscrollright	(	short	start,
		short	stop
	)

Activate a scroll to the right for rows start through stop The display is 16 rows tall. To scroll the whole display, run: display.scrollright(0x00, 0x0F)

Parameters