aboutsummaryrefslogtreecommitdiffstats
path: root/libraries/LiquidCrystal/LiquidCrystal.h
blob: 06a159df4076a058630fdd9a38892c7f426efbd9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
#ifndef LiquidCrystal_h
#define LiquidCrystal_h

//#include <inttypes.h>
#include <wirish/wirish.h>
#include <wirish/Print.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 LiquidCrystal : public Print {
public:
  LiquidCrystal(uint8 rs, uint8 enable,
                uint8 d0, uint8 d1, uint8 d2, uint8 d3,
                uint8 d4, uint8 d5, uint8 d6, uint8 d7);
  LiquidCrystal(uint8 rs, uint8 rw, uint8 enable,
                uint8 d0, uint8 d1, uint8 d2, uint8 d3,
                uint8 d4, uint8 d5, uint8 d6, uint8 d7);
  LiquidCrystal(uint8 rs, uint8 rw, uint8 enable,
                uint8 d0, uint8 d1, uint8 d2, uint8 d3);
  LiquidCrystal(uint8 rs, uint8 enable,
                uint8 d0, uint8 d1, uint8 d2, uint8 d3);

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

  void begin(uint8 cols, uint8 rows, uint8 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 createChar(uint8, uint8[]);
  void setCursor(uint8, uint8);
  virtual void write(uint8);
  void command(uint8);
private:
  void send(uint8, uint8);
  void write4bits(uint8);
  void write8bits(uint8);
  void pulseEnable();

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

  uint8 _displayfunction;
  uint8 _displaycontrol;
  uint8 _displaymode;

  uint8 _initialized;

  uint8 _numlines,_currline;
};

#endif