Updating LiquidCrystal API and examples.

Author: damellis

libraries/LiquidCrystal/LiquidCrystal.cpp

@@ -219,25 +219,25 @@ void LiquidCrystal::scrollDisplayRight(void) {
 }
 
 // This is for text that flows Left to Right
-void LiquidCrystal::shiftLeft(void) {
+void LiquidCrystal::leftToRight(void) {
   _displaymode |= LCD_ENTRYLEFT;
   command(LCD_ENTRYMODESET | _displaymode);
 }
 
 // This is for text that flows Right to Left
-void LiquidCrystal::shiftRight(void) {
+void LiquidCrystal::rightToLeft(void) {
   _displaymode &= ~LCD_ENTRYLEFT;
   command(LCD_ENTRYMODESET | _displaymode);
 }
 
 // This will 'right justify' text from the cursor
-void LiquidCrystal::shiftIncrement(void) {
+void LiquidCrystal::autoscroll(void) {
   _displaymode |= LCD_ENTRYSHIFTINCREMENT;
   command(LCD_ENTRYMODESET | _displaymode);
 }
 
 // This will 'left justify' text from the cursor
-void LiquidCrystal::shiftDecrement(void) {
+void LiquidCrystal::noAutoscroll(void) {
   _displaymode &= ~LCD_ENTRYSHIFTINCREMENT;
   command(LCD_ENTRYMODESET | _displaymode);
 }

libraries/LiquidCrystal/LiquidCrystal.h

@@ -72,12 +72,10 @@ class LiquidCrystal : public Print {
   void cursor();
   void scrollDisplayLeft();
   void scrollDisplayRight();
-  void printLeft();
-  void printRight();
-  void shiftLeft();
-  void shiftRight();
-  void shiftIncrement();
-  void shiftDecrement();
+  void leftToRight();
+  void rightToLeft();
+  void autoscroll();
+  void noAutoscroll();
 
   void createChar(uint8_t, uint8_t[]);
   void setCursor(uint8_t, uint8_t); 

libraries/LiquidCrystal/examples/Blink/Blink.pde

@@ -45,12 +45,12 @@ void setup() {
 }
 
 void loop() {
-  // Turn off the display:
+  // Turn off the blinking cursor:
   lcd.noBlink();
-  delay(500);
-  // Turn on the display:
+  delay(3000);
+   // Turn on the blinking cursor:
   lcd.blink();
-  delay(500);
+  delay(3000);
 }
 
 

libraries/LiquidCrystal/examples/Cursor/Cursor.pde

@@ -45,10 +45,10 @@ void setup() {
 }
 
 void loop() {
-  // Turn off the display:
+  // Turn off the cursor:
   lcd.noCursor();
   delay(500);
-   // Turn on the display:
+   // Turn on the cursor:
   lcd.cursor();
   delay(500);
 }

libraries/LiquidCrystal/examples/IncrementDecrement/IncrementDecrement.pde

@@ -1,13 +1,13 @@
 /*
-  LiquidCrystal Library - Increment/Decrement
+  LiquidCrystal Library - Autoscroll
  
  Demonstrates the use a 16x2 LCD display.  The LiquidCrystal
  library works with all LCD displays that are compatible with the 
  Hitachi HD44780 driver. There are many of them out there, and you
  can usually tell them by the 16-pin interface.
  
- This sketch demonstrates the use of the shiftIncrement()
- and shifDecrement() functions.
+ This sketch demonstrates the use of the autoscroll()
+ and noAutoscroll() functions.
  
  The circuit:
  * LCD RS pin to digital pin 12
@@ -37,29 +37,30 @@
 LiquidCrystal lcd(12, 11, 5, 4, 3, 2);
 
 void setup() {
-  // set up the LCD's number of rows and columns: 
+  // set up the LCD's number of columns and rows: 
   lcd.begin(2, 16);
 }
 
 void loop() {
-     // set the cursor to (0,0):
+  // set the cursor to (0,0):
   lcd.setCursor(0, 0);
-  // set the display to left justify:
-  lcd.shiftDecrement();
   // print from 0 to 9:
   for (int thisChar = 0; thisChar < 10; thisChar++) {
    lcd.print(thisChar);
    delay(500);
   }
-  // set the cursor to (16,0):
+
+  // set the cursor to (16,1):
   lcd.setCursor(16,1);
-  // set the display to left justify:
-  lcd.shiftIncrement();
+  // set the display to automatically scroll:
+  lcd.autoscroll();
   // print from 0 to 9:
   for (int thisChar = 0; thisChar < 10; thisChar++) {
     lcd.print(thisChar);
     delay(500);
   }
+  // turn off automatic scrolling
+  lcd.noAutoscroll();
 
   // clear screen for the next loop:
   lcd.clear();

libraries/LiquidCrystal/examples/Shift/Shift.pde

@@ -1,12 +1,12 @@
   /*
-  LiquidCrystal Library - Shift
+  LiquidCrystal Library - TextDirection
  
  Demonstrates the use a 16x2 LCD display.  The LiquidCrystal
  library works with all LCD displays that are compatible with the 
  Hitachi HD44780 driver. There are many of them out there, and you
  can usually tell them by the 16-pin interface.
  
- This sketch demonstrates how to use shiftLeft() and shiftRight()
+ This sketch demonstrates how to use leftToRight() and rightToLeft()
  to move the cursor.
  
  The circuit:
@@ -51,12 +51,12 @@ void loop() {
   // reverse directions at 'm':
   if (thisChar == 'm') {
     // go right for the next letter
-    lcd.shiftRight(); 
+    lcd.rightToLeft(); 
   }
   // reverse again at 's':
   if (thisChar == 's') {
     // go left for the next letter
-    lcd.shiftLeft(); 
+    lcd.leftToRight(); 
   }
   // reset at 'z':
   if (thisChar > 'z') {

libraries/LiquidCrystal/keywords.txt

@@ -12,10 +12,15 @@ LiquidCrystal	KEYWORD1
 # Methods and Functions (KEYWORD2)
 #######################################
 
+begin	KEYWORD2
 clear	KEYWORD2
 home	KEYWORD2
 print	KEYWORD2
 setCursor	KEYWORD2
+cursor	KEYWORD2
+noCursor	KEYWORD2
+blink	KEYWORD2
+noBlink	KEYWORD2
 
 #######################################
 # Constants (LITERAL1)