i2c-lcd1602.h

Go to the documentation of this file.

/*
 * MIT License
 *
 * Copyright (c) 2018 David Antliff
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef I2C_LCD1602_H
#define I2C_LCD1602_H

#include <stdbool.h>
#include "smbus.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef struct
{
    bool init;                                          
    smbus_info_t * smbus_info;                          
    uint8_t backlight_flag;                             
    uint8_t num_rows;                                   
    uint8_t num_columns;                                
    uint8_t num_visible_columns;                        
    uint8_t display_control_flags;                      
    uint8_t entry_mode_flags;                           
} i2c_lcd1602_info_t;


// Special characters for ROM Code A00

// Use the second set (0bxxxx1xxx) to avoid placing the null character within a string
#define I2C_LCD1602_CHARACTER_CUSTOM_0     0b00001000   
#define I2C_LCD1602_CHARACTER_CUSTOM_1     0b00001001   
#define I2C_LCD1602_CHARACTER_CUSTOM_2     0b00001010   
#define I2C_LCD1602_CHARACTER_CUSTOM_3     0b00001011   
#define I2C_LCD1602_CHARACTER_CUSTOM_4     0b00001100   
#define I2C_LCD1602_CHARACTER_CUSTOM_5     0b00001101   
#define I2C_LCD1602_CHARACTER_CUSTOM_6     0b00001110   
#define I2C_LCD1602_CHARACTER_CUSTOM_7     0b00001111   

#define I2C_LCD1602_CHARACTER_ALPHA        0b11100000   
#define I2C_LCD1602_CHARACTER_BETA         0b11100010   
#define I2C_LCD1602_CHARACTER_THETA        0b11110010   
#define I2C_LCD1602_CHARACTER_PI           0b11110111   
#define I2C_LCD1602_CHARACTER_OMEGA        0b11110100   
#define I2C_LCD1602_CHARACTER_SIGMA        0b11110110   
#define I2C_LCD1602_CHARACTER_INFINITY     0b11110011   
#define I2C_LCD1602_CHARACTER_DEGREE       0b11011111   
#define I2C_LCD1602_CHARACTER_ARROW_RIGHT  0b01111110   
#define I2C_LCD1602_CHARACTER_ARROW_LEFT   0b01111111   
#define I2C_LCD1602_CHARACTER_SQUARE       0b11011011   
#define I2C_LCD1602_CHARACTER_DOT          0b10100101   
#define I2C_LCD1602_CHARACTER_DIVIDE       0b11111101   
#define I2C_LCD1602_CHARACTER_BLOCK        0b11111111   


typedef enum
{
    I2C_LCD1602_INDEX_CUSTOM_0 = 0,                     
    I2C_LCD1602_INDEX_CUSTOM_1,                         
    I2C_LCD1602_INDEX_CUSTOM_2,                         
    I2C_LCD1602_INDEX_CUSTOM_3,                         
    I2C_LCD1602_INDEX_CUSTOM_4,                         
    I2C_LCD1602_INDEX_CUSTOM_5,                         
    I2C_LCD1602_INDEX_CUSTOM_6,                         
    I2C_LCD1602_INDEX_CUSTOM_7,                         
} i2c_lcd1602_custom_index_t;

#define I2C_LCD1602_ERROR_CHECK(x) do {                                     \
        esp_err_t rc = (x);                                                 \
        if (rc != ESP_OK) {                                                 \
            ESP_LOGW(TAG, "I2C error %d at %s:%d", rc, __FILE__, __LINE__); \
        }                                                                   \
    } while(0);

i2c_lcd1602_info_t * i2c_lcd1602_malloc(void);

void i2c_lcd1602_free(i2c_lcd1602_info_t ** tsl2561_info);

esp_err_t i2c_lcd1602_init(i2c_lcd1602_info_t * i2c_lcd1602_info, smbus_info_t * smbus_info,
                           bool backlight, uint8_t num_rows, uint8_t num_columns, uint8_t num_visible_columns);

esp_err_t i2c_lcd1602_reset(const i2c_lcd1602_info_t * i2c_lcd1602_info);

esp_err_t i2c_lcd1602_clear(const i2c_lcd1602_info_t * i2c_lcd1602_info);

esp_err_t i2c_lcd1602_home(const i2c_lcd1602_info_t * i2c_lcd1602_info);

esp_err_t i2c_lcd1602_move_cursor(const i2c_lcd1602_info_t * i2c_lcd1602_info, uint8_t col, uint8_t row);

esp_err_t i2c_lcd1602_set_backlight(i2c_lcd1602_info_t * i2c_lcd1602_info, bool enable);

esp_err_t i2c_lcd1602_set_display(i2c_lcd1602_info_t * i2c_lcd1602_info, bool enable);

esp_err_t i2c_lcd1602_set_cursor(i2c_lcd1602_info_t * i2c_lcd1602_info, bool enable);

esp_err_t i2c_lcd1602_set_blink(i2c_lcd1602_info_t * i2c_lcd1602_info, bool enable);

esp_err_t i2c_lcd1602_set_left_to_right(i2c_lcd1602_info_t * i2c_lcd1602_info);

esp_err_t i2c_lcd1602_set_right_to_left(i2c_lcd1602_info_t * i2c_lcd1602_info);

esp_err_t i2c_lcd1602_set_auto_scroll(i2c_lcd1602_info_t * i2c_lcd1602_info, bool enable);

esp_err_t i2c_lcd1602_scroll_display_left(const i2c_lcd1602_info_t * i2c_lcd1602_info);

esp_err_t i2c_lcd1602_scroll_display_right(const i2c_lcd1602_info_t * i2c_lcd1602_info);

esp_err_t i2c_lcd1602_move_cursor_left(const i2c_lcd1602_info_t * i2c_lcd1602_info);

esp_err_t i2c_lcd1602_move_cursor_right(const i2c_lcd1602_info_t * i2c_lcd1602_info);

esp_err_t i2c_lcd1602_define_char(const i2c_lcd1602_info_t * i2c_lcd1602_info, i2c_lcd1602_custom_index_t index, const uint8_t pixelmap[]);

esp_err_t i2c_lcd1602_write_char(const i2c_lcd1602_info_t * i2c_lcd1602_info, uint8_t chr);

esp_err_t i2c_lcd1602_write_string(const i2c_lcd1602_info_t * i2c_lcd1602_info, const char * string);

#ifdef __cplusplus
}
#endif

#endif // I2C_LCD1602_H