LCD_I2C-C.h

Go to the documentation of this file.

 
#pragma once
#include <stdint.h>
#include <hardware/i2c.h>
 
    typedef uint8_t byte;
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
    void lcd_init(byte address, byte columns, byte rows, i2c_inst_t *I2C) ;
 
 
 
    void  lcd_writeChar(byte val) ;
 
    void lcd_writeString(const char str[]) ;
 
 
    void lcd_writeBuffer(const uint8_t *buffer, size_t size) ;
 
 
 
    void lcd_setCursor(byte line, byte position) ;
 
    void lcd_clear(void) ;
 
    void lcd_home(void) ;
 
 
    void lcd_backlight(void) ;
    
    void lcd_noBacklight(void) ;
 
    void lcd_display(void) ;
 
    void lcd_noDisplay(void) ;
 
 
 
    void lcd_cursor(void) ;
 
    void lcd_noCursor(void) ;
 
    void lcd_blink(void) ;
 
    void lcd_noBlink(void) ;
 
 
    
    void lcd_scrollDisplayLeft(void) ;
 
    void lcd_scrollDisplayRight(void) ;
 
    void lcd_autoscroll(void) ;
 
    void lcd_noAutoscroll(void) ;
 
    void lcd_leftToRight(void) ;
 
    void lcd_rightToLeft(void) ;
 
 
    void lcd_createChar(byte charnum, const byte char_map[])  ;
 
 
#ifndef I2C_Setup_defined
    #define I2C_Setup_defined
 
    /*  
     * @brief Helper function to set up the I2C bus on Pi Pico
     * 
     * Sets up the I2C bus given instance on the given pins with a specified 
     * clock rate. Defines the pins for the pico tools.
     * 
     * @param I2C   is the I2C bus instance to use. Either i2c0 or i2c1.
     * @param SDA   is the Pi Pico Pin for the I2C SDA (data) line. 
     * @param SCL   is the Pi Pico Pin for the I2C SCL (clock) line.
     * @param I2C_Clock is the I2C bus speed. Typically 100000 or 400000.
     * 
     * @return (int)  The actual *(theoretical)* I2C speed from i2c_init
     * 
     */
 
    int LCD_I2C_Setup(i2c_inst_t* I2C, uint SDA_Pin, uint SCL_Pin, uint I2C_Clock) ;
;
#endif
 
 
#ifdef __cplusplus
}
#endif