upm  0.1.8
Sensor/Actuator repository for libmraa (v0.4.5)
 All Data Structures Files Functions Variables Macros Pages
Public Member Functions
SSD1308 Class Reference

C++ API for SSD1308 i2c controlled OLED displays. More...

Detailed Description

The SSD1308 is a 128x64 Dot matrix OLED/PLED segment driver with controller. This implementation was tested using the Grove LED 128×64 Display module which is an OLED monochrome display

upm::SSD1308 *lcd = new upm::SSD1308(BUS_NUMBER, DEVICE_ADDRESS);
lcd->clear();
lcd->draw(intel_logo, 1024);
lcd->close();
ssd1308.jpeg

Public Member Functions

 SSD1308 (int bus, int address)
 
 ~SSD1308 ()
 
mraa_result_t draw (uint8_t *data, int bytes)
 
mraa_result_t write (std::string msg)
 
mraa_result_t setCursor (int row, int column)
 
mraa_result_t clear ()
 
mraa_result_t home ()
 
- Public Member Functions inherited from I2CLcd
 I2CLcd (int bus, int lcdAddress)
 
mraa_result_t write (int x, int y, std::string msg)
 
virtual mraa_result_t i2Cmd (mraa_i2c_context ctx, uint8_t value)
 
virtual mraa_result_t i2cReg (mraa_i2c_context ctx, int deviceAdress, int addr, uint8_t data)
 
virtual mraa_result_t i2cData (mraa_i2c_context ctx, uint8_t value)
 
mraa_result_t close ()
 
std::string name ()
 

Additional Inherited Members

- Protected Attributes inherited from I2CLcd
std::string m_name
 
int m_lcd_control_address
 
int m_bus
 
mraa_i2c_context m_i2c_lcd_control
 

Constructor & Destructor Documentation

SSD1308 ( int  bus,
int  address 
)

SSD1308 Constructor, calls libmraa initialisation functions

Parameters
busi2c bus to use
addressthe slave address the lcd is registered on

Here is the call graph for this function:

~SSD1308 ( )

SSD1308 Destructor

Member Function Documentation

mraa_result_t draw ( uint8_t *  data,
int  bytes 
)

Draw an image, see examples/python/make_oled_pic.py for an explanation on how the pixels are mapped to bytes

Parameters
datathe buffer to read
bytesthe amount of bytes to read from the pointer
Returns
Result of operation
mraa_result_t write ( std::string  msg)
virtual

Write a string to LCD

Parameters
msgThe std::string to write to display, note only ascii chars are supported
Returns
Result of operation

Implements I2CLcd.

mraa_result_t setCursor ( int  row,
int  column 
)
virtual

Set cursor to a coordinate

Parameters
rowThe row to set cursor to
columnThe column to set cursor to
Returns
Result of operation

Implements I2CLcd.

Here is the caller graph for this function:

mraa_result_t clear ( )
virtual

Clear display from characters

Returns
Result of operatio

Implements I2CLcd.

Here is the call graph for this function:

Here is the caller graph for this function:

mraa_result_t home ( )
virtual

Return to coordinate 0,0

Returns
Result of operation

Implements I2CLcd.

Here is the call graph for this function:

Here is the caller graph for this function:

Inheritance diagram for SSD1308:
Inheritance graph
[legend]
Collaboration diagram for SSD1308:
Collaboration graph
[legend]

The documentation for this class was generated from the following files: