Jhd1313m1 Class Reference

C++ API for Jhd1313m1 i2c controller for HD44780 based displays with an RGB backlight such as the Grove RGB i2c LCD display. More...

Detailed Description

The Jhd1313m1 has two i2c addreses, one belongs to a controller very similar to the upm::Lcm1602 LCD driver which controls the HD44780 based display and the other controls solely the backlight. This module was tested with the Seed Grove LCD RGB Backlight v2.0 display

    // 0x62 RGB_ADDRESS, 0x3E LCD_ADDRESS
    upm::Jhd1313m1 *lcd = new upm::Jhd1313m1(0, 0x3E, 0x62);
    lcd->setCursor(0,0);
    lcd->write("Hello World");
    lcd->setCursor(1,2);
    lcd->write("Hello World");
    lcd->close();

Public Member Functions
	Jhd1313m1 (int bus, int lcdAddress, int rgbAddress)
	~Jhd1313m1 ()
mraa_result_t	scroll (bool direction)
mraa_result_t	setColor (uint8_t r, uint8_t g, uint8_t b)
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

Jhd1313m1	(	int	bus,
		int	lcdAddress,
		int	rgbAddress
	)

Jhd1313m1 constructor

Parameters

bus	i2c bus to use
address	the slave address the lcd is registered on
address	the slave address the rgb backlight is on

Here is the call graph for this function:

~Jhd1313m1

(

)

Jhd1313m1 destructor

Member Function Documentation

mraa_result_t scroll

(

bool

direction

)

Make the LCD scroll text

Parameters

direction,true

is typical scrolling to the right

Returns

Result of operation

mraa_result_t setColor	(	uint8_t	r,
		uint8_t	g,
		uint8_t	b
	)

Set the color of the backlight

Parameters

r	0-255 value for red
g	0-255 value for green
b	0-255 value for blue

Returns

Result of operation

mraa_result_t write ( std::string  msg )

virtual

Write a string to LCD

Parameters

msg	The 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

row	The row to set cursor to
column	The column to set cursor to

Returns

Result of operation

Implements I2CLcd.

mraa_result_t clear ( )

virtual

Clear display from characters

Returns

Result of operatio

Implements I2CLcd.

Here is the caller graph for this function:

mraa_result_t home ( )

virtual

Return to coordinate 0,0

Returns

Result of operation

Implements I2CLcd.

Inheritance diagram for Jhd1313m1:

Collaboration diagram for Jhd1313m1:

---

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

• /var/lib/jenkins/workspace/upm-doc/src/lcd/jhd1313m1.h
• /var/lib/jenkins/workspace/upm-doc/src/lcd/jhd1313m1.cxx