External Functions

External functions for LCD 1602 API. More...

Functions
LCD_WRITE_STATUS	lcd_1602_send_string (i2c_master_dev_handle_t handle, char *str)
	Writes out data to the LCD.
uint8_t	lcd_1602_init (i2c_master_dev_handle_t handle)
	initializes the LCD 1602 correctly according to the datasheet.

Detailed Description

External functions for LCD 1602 API.

Function Documentation

lcd_1602_init()

uint8_t lcd_1602_init

(

i2c_master_dev_handle_t

handle

)

initializes the LCD 1602 correctly according to the datasheet.

Parameters

handle

The device handle use to writing on the i2c bus

Returns

0 for success or 1 for fail.

Definition at line 141 of file lcd_1602.c.

                                                      {
/*
This function sets up the standard mode of the LCD and follows
a specific start up sequence described by the manufacturer.
*/
    // Manufacturer specific order
    vTaskDelay(pdMS_TO_TICKS(15));
    write_nibble(handle, (0x03 << 4), 0);
    vTaskDelay(pdMS_TO_TICKS(5));
    write_nibble(handle, (0x03 << 4), 0);
    vTaskDelay(pdMS_TO_TICKS(2));
    write_nibble(handle, (0x03 << 4), 0);
    vTaskDelay(pdMS_TO_TICKS(2));
    write_nibble(handle, (0x02 << 4), 0);
    // End of manufacturer specific order
 
    send_command(handle, LCD_1602_FUNCTION_SET(LCD_1602_DATA_LEN_4_BIT, LCD_1602_2_ROWS, LCD_1602_FONT_5X10));
    send_command(handle, LCD_1602_CONFIG_DISPLAY_SWITCH(LCD_1602_DISPLAY_ON, LCD_1602_CURSOR_OFF, LCD_1602_N_BLINK_DISPLAY));
    clear_screen(handle);
    send_command(handle, LCD_1602_CONFIG_INPUT_SET(LCD_1602_INCREMENT_MODE, LCD_1602_CURSOR_N_MOVE));
 
    return 0;
}

lcd_1602_send_string()

LCD_WRITE_STATUS lcd_1602_send_string	(	i2c_master_dev_handle_t	handle,
		char *	str )

Writes out data to the LCD.

Parameters

handle	The device handle used to writing on the i2c bus
str	The string to be written to the LCD

Returns

LCD_WRITE_FINISHED for successful. LCD_WRITE_INTERRUPTED if string is too long for screen.

Definition at line 111 of file lcd_1602.c.

                                                                                 {
    clear_screen(handle);
 
    uint8_t char_len = 0;
    uint8_t row = 0;
 
    while(*str != '\0') {
        if(*str == '\n' || char_len >= 16) {
            if(row < LCD_1602_MAX_ROWS) {
                lcd_goto(handle, 0,1);
                row++;
                char_len = 0;
                str++;
                continue;
            }
            else return LCD_WRITE_INTERRUPTED;
        }
 
        if(*str == '\0') {
            return LCD_WRITE_FINISHED;
        }
 
        send_char(handle, *str);
        char_len++;
        str++;
    }
 
    return LCD_WRITE_FINISHED;
}