Adafruit_LiquidCrystal.h

Go to the documentation of this file.

#ifndef Adafruit_LiquidCrystal_h
#define Adafruit_LiquidCrystal_h

#include "Arduino.h"
#include "Print.h"
#include <Adafruit_MCP23X08.h>

// commands
#define LCD_CLEARDISPLAY 0x01 
#define LCD_RETURNHOME 0x02   
#define LCD_ENTRYMODESET 0x04 
#define LCD_DISPLAYCONTROL                                                     \
  0x08 
#define LCD_CURSORSHIFT 0x10 
#define LCD_FUNCTIONSET                                                        \
  0x20 
#define LCD_SETCGRAMADDR                                                       \
  0x40 
#define LCD_SETDDRAMADDR 0x80 

// flags for display entry mode
#define LCD_ENTRYRIGHT 0x00 
#define LCD_ENTRYLEFT 0x02  
#define LCD_ENTRYSHIFTINCREMENT                                                \
  0x01 
#define LCD_ENTRYSHIFTDECREMENT                                                \
  0x00 

// flags for display on/off control
#define LCD_DISPLAYON 0x04  
#define LCD_DISPLAYOFF 0x00 
#define LCD_CURSORON 0x02   
#define LCD_CURSOROFF 0x00  
#define LCD_BLINKON 0x01    
#define LCD_BLINKOFF 0x00   

// flags for display/cursor shift
#define LCD_DISPLAYMOVE 0x08 
#define LCD_CURSORMOVE 0x00  
#define LCD_MOVERIGHT 0x04   
#define LCD_MOVELEFT 0x00    

// flags for function set
#define LCD_8BITMODE 0x10 
#define LCD_4BITMODE 0x00 
#define LCD_2LINE 0x08    
#define LCD_1LINE 0x00    
#define LCD_5x10DOTS 0x04 
#define LCD_5x8DOTS 0x00  


class Adafruit_LiquidCrystal : public Print {
public:
  Adafruit_LiquidCrystal(uint8_t rs, uint8_t enable, uint8_t d0, uint8_t d1,
                         uint8_t d2, uint8_t d3, uint8_t d4, uint8_t d5,
                         uint8_t d6, uint8_t d7);
  Adafruit_LiquidCrystal(uint8_t rs, uint8_t rw, uint8_t enable, uint8_t d0,
                         uint8_t d1, uint8_t d2, uint8_t d3, uint8_t d4,
                         uint8_t d5, uint8_t d6, uint8_t d7);
  Adafruit_LiquidCrystal(uint8_t rs, uint8_t rw, uint8_t enable, uint8_t d0,
                         uint8_t d1, uint8_t d2, uint8_t d3);
  Adafruit_LiquidCrystal(uint8_t rs, uint8_t enable, uint8_t d0, uint8_t d1,
                         uint8_t d2, uint8_t d3);

  Adafruit_LiquidCrystal(uint8_t i2cAddr, TwoWire *wire = &Wire);
  Adafruit_LiquidCrystal(uint8_t data, uint8_t clock, uint8_t latch);

  void init(uint8_t fourbitmode, uint8_t rs, uint8_t rw, uint8_t enable,
            uint8_t d0, uint8_t d1, uint8_t d2, uint8_t d3, uint8_t d4,
            uint8_t d5, uint8_t d6, uint8_t d7);

  bool begin(uint8_t cols, uint8_t rows, uint8_t charsize = LCD_5x8DOTS);

  void clear();
  void home();
  void noDisplay();
  void display();
  void noBlink();
  void blink();
  void noCursor();
  void cursor();
  void scrollDisplayLeft();
  void scrollDisplayRight();
  void leftToRight();
  void rightToLeft();
  void autoscroll();
  void noAutoscroll();

  void setBacklight(uint8_t value);

  void createChar(uint8_t, uint8_t[]);
  void setCursor(uint8_t, uint8_t);
#if ARDUINO >= 100
  virtual size_t write(uint8_t);
#else

  virtual void write(uint8_t);
#endif

  void command(uint8_t);

private:
  void send(uint8_t value, boolean mode);
  void write4bits(uint8_t);
  void write8bits(uint8_t);
  void pulseEnable();
  void _digitalWrite(uint8_t, uint8_t);
  void _pinMode(uint8_t, uint8_t);

  uint8_t _rs_pin;     // LOW: command.  HIGH: character.
  uint8_t _rw_pin;     // LOW: write to LCD.  HIGH: read from LCD.
  uint8_t _enable_pin; // activated by a HIGH pulse.
  uint8_t _data_pins[8];

  uint8_t _displayfunction;
  uint8_t _displaycontrol;
  uint8_t _displaymode;

  uint8_t _initialized;

  uint8_t _numlines, _currline;

  uint8_t _SPIclock, _SPIdata, _SPIlatch;
  uint8_t _SPIbuff;

  uint8_t _i2cAddr;
  TwoWire *_wire;
  Adafruit_MCP23X08 _mcp;
};

#endif