Jhd1313m1 Class Reference

API for the JHD1313M1 I2C controller for HD44780-based displays with an RGB backlight, such as a Grove RGB I2C LCD display. More...

Detailed Description

• ID: jhd1313m1
• Name: LCD Display Driver for the JHD1313M1 Controller for HD44780-based Displays
• Other Names: Grove RGB LCD
• Category: display
• Manufacturer: seeed adafruit sparkfun
• Link: http://www.seeedstudio.com/depot/Grove-LCD-RGB-Backlight-p-1643.html?cPath=34_36
• Connection: i2c
• Kit: gsk

JHD1313M1 has two I2C addreses: one belongs to a controller, very similar to the upm::Lcm1602 LCD driver, that controls the HD44780-based display, and the other controls only the backlight. This module was tested with the Seeed Grove LCD RGB Backlight v2.0 display that requires 5V to operate.

    // 0x62 RGB_ADDRESS, 0x3E LCD_ADDRESS
    upm::Jhd1313m1 lcd(0, 0x3E, 0x62);

    int ndx = 0;
    uint8_t rgb[7][3] = { { 0xd1, 0x00, 0x00 }, { 0xff, 0x66, 0x22 }, { 0xff, 0xda, 0x21 },
                          { 0x33, 0xdd, 0x00 }, { 0x11, 0x33, 0xcc }, { 0x22, 0x00, 0x66 },
                          { 0x33, 0x00, 0x44 } };
    while (shouldRun) {
        // Alternate rows on the LCD
        lcd.setCursor(ndx % 2, 0);
        // Change the color
        uint8_t r = rgb[ndx % 7][0];
        uint8_t g = rgb[ndx % 7][1];
        uint8_t b = rgb[ndx % 7][2];
        lcd.setColor(r, g, b);
        lcd.write("Hello World " + std::to_string(ndx));
        // Echo via printf
        printf("Hello World %d rgb: 0x%02x%02x%02x\n", ndx++, r, g, b);

        upm_delay(1);
    }

Public Member Functions
	Jhd1313m1 (int bus, int lcdAddress=0x3E, int rgbAddress=0x62)
	~Jhd1313m1 ()
upm_result_t	write (std::string msg)
upm_result_t	scroll (bool direction)
upm_result_t	setColor (uint8_t r, uint8_t g, uint8_t b)
upm_result_t	setCursor (int row, int column)
upm_result_t	clear ()
upm_result_t	home ()
upm_result_t	createChar (uint8_t charSlot, std::vector< uint8_t > charData)
upm_result_t	displayOn ()
upm_result_t	displayOff ()
upm_result_t	cursorOn ()
upm_result_t	cursorOff ()
upm_result_t	cursorBlinkOn ()
upm_result_t	cursorBlinkOff ()
upm_result_t	backlightOn ()
upm_result_t	backlightOff ()
upm_result_t	scrollDisplayLeft ()
upm_result_t	scrollDisplayRight ()
upm_result_t	entryLeftToRight ()
upm_result_t	entryRightToLeft ()
upm_result_t	autoscrollOn ()
upm_result_t	autoscrollOff ()

Protected Member Functions
upm_result_t	command (uint8_t cmd)
upm_result_t	data (uint8_t data)

Protected Attributes
jhd1313m1_context	m_jhd1313m1

Constructor & Destructor Documentation

Jhd1313m1	(	int	bus,
		int	lcdAddress = 0x3E,
		int	rgbAddress = 0x62
	)

Jhd1313m1 constructor

Parameters

bus	I2C bus to use
lcdAddress	Slave address the LCD is registered on
rgbAddress	Slave address the RGB backlight is registered on

~Jhd1313m1

(

)

Jhd1313m1 destructor

Here is the call graph for this function:

Member Function Documentation

upm_result_t write

(

std::string

msg

)

Writes a string to the LCD

Parameters

msg	std::string to write to the display; note: only ASCII characters are supported

Returns

Result of the operation

Here is the call graph for this function:

upm_result_t scroll

(

bool

direction

)

Makes the LCD scroll text

Parameters

direction

True if scrolling to the right, false otherwise

Returns

Result of the operation

Here is the call graph for this function:

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

Sets the color of the backlight Can be used to change the color even when the backlight is off

Parameters

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

Returns

Result of the operation

Here is the call graph for this function:

upm_result_t 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

Here is the call graph for this function:

upm_result_t clear

(

)

Clears the display of all characters

Returns

Result of the operation

Here is the call graph for this function:

upm_result_t home

(

)

Returns to the original coordinates (0,0)

Returns

Result of the operation

Here is the call graph for this function:

upm_result_t createChar	(	uint8_t	charSlot,
		std::vector< uint8_t >	charData
	)

Create a custom character

Parameters

charSlot	the character slot to write, only 8 are available
charData	A vector containing 8 bytes making up the character

Returns

Result of operation

Here is the call graph for this function:

upm_result_t displayOn

(

)

Turn the display on

Returns

Result of operation

Here is the call graph for this function:

upm_result_t displayOff

(

)

Turn the display off

Returns

Result of operation

Here is the call graph for this function:

upm_result_t cursorOn

(

)

Turn the cursor on

Returns

Result of operation

Here is the call graph for this function:

upm_result_t cursorOff

(

)

Turn the cursor off

Returns

Result of operation

Here is the call graph for this function:

upm_result_t cursorBlinkOn

(

)

Turn cursor blink on

Returns

Result of operation

Here is the call graph for this function:

upm_result_t cursorBlinkOff

(

)

Turn cursor blink off

Returns

Result of operation

Here is the call graph for this function:

upm_result_t backlightOn

(

)

Turn backlight on

Returns

Result of operation

Here is the call graph for this function:

upm_result_t backlightOff

(

)

Turn backlight off

Returns

Result of operation

Here is the call graph for this function:

upm_result_t scrollDisplayLeft

(

)

Scroll the display left, without changing the character RAM

Returns

Result of operation

Here is the call graph for this function:

upm_result_t scrollDisplayRight

(

)

Scroll the display right, without changing the character RAM

Returns

Result of operation

Here is the call graph for this function:

upm_result_t entryLeftToRight

(

)

set the entry mode so that characters are added left to right

Returns

Result of operation

Here is the call graph for this function:

upm_result_t entryRightToLeft

(

)

set the entry mode so that characters are added right to left

Returns

Result of operation

Here is the call graph for this function:

upm_result_t autoscrollOn

(

)

Right justify text entered from the cursor

Returns

Result of operation

Here is the call graph for this function:

upm_result_t autoscrollOff

(

)

Left justify text entered from the cursor

Returns

Result of operation

Here is the call graph for this function:

Collaboration diagram for Jhd1313m1:

---

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

• src/jhd1313m1/jhd1313m1.hpp
• src/jhd1313m1/jhd1313m1.cxx