Skip to content

Commit

Permalink
improve description, fix links
Browse files Browse the repository at this point in the history
  • Loading branch information
dniklaus committed Feb 17, 2018
1 parent 4375fd1 commit 7337bed
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@
arduino-display-lcdkeypad
=========================

Arduino LCD Keypad Shield driver, supporting both [LiquidCrystal](http://arduino.cc/en/Reference/LiquidCrystal) (4 or 8 bit parallel data bus) and [LiquidTWI2](https://github.com/lincomatic/LiquidTWI2) (I2C bus and RGB color backlight) based HW types.
Arduino LCD Keypad Shield driver, supporting two HW types:
* 4 or 8 bit parallel data bus ([LiquidCrystal](http://arduino.cc/en/Reference/LiquidCrystal) driver)
* I2C bus and RGB color backlight ([LiquidTWI2](https://github.com/lincomatic/LiquidTWI2) driver)

The **LiquidCrystal** HW can be ordered from here:
* http://www.robotshop.com/dfrobot-lcd-keypad-shield-arduino-1.html
* http://hobbyking.com/hobbyking/store/uh_viewItem.asp?idProduct=25087
The HW type supported by **LiquidCrystal** can be ordered from here:
* https://www.robotshop.com/en/lcd-keypad-shield-arduino.html
* https://hobbyking.com/en_us/kingduino-lcd-keypad-shield-1.html
* http://www.dx.com/p/arduino-2-6-lcd-keypad-shield-expansion-board-134404#.U4z6LygUdpU

The schematic of this LcdKeypad Shield can be found [here](http://forum.arduino.cc/index.php?action=dlattach;topic=95618.0;attach=15041).
Expand All @@ -19,18 +21,18 @@ The **LiquidTWI2** HW can be ordered from here:
* http://www.adafruit.com/product/772 (blue & white)
* http://www.adafruit.com/products/716 (RGB color, negative)

Uses a copy of the files taken from the LiquidTWI2 driver (https://github.com/lincomatic/LiquidTWI2)
Uses a copy of the files taken from the LiquidTWI2 driver: https://github.com/lincomatic/LiquidTWI2



This driver supports the 5 key pad buttons (one button at a time only).
This driver detects whether a LiquidTWI2 HW or a LiquidCrystal HW type is present and automatically chooses the apropriate driver variant.
As long as this driver is used, the I2C address 0x20 is reserved for the LiquidTWI2 HW type (even when you are actually using the LiquidCrystal HW type).
This driver detects whether a LiquidTWI2 HW or a LiquidCrystal HW type is present and automatically chooses the appropriate driver variant.
As long as this driver is used, the **I2C address 0x20** is reserved for the LiquidTWI2 HW type (even when you are actually using the LiquidCrystal HW type).

**Requires**:
* Wire (Arduino Library: https://www.arduino.cc/en/Reference/Wire)
* LiquidCrystal (Arduino Library: http://arduino.cc/en/Reference/LiquidCrystal)
* Timer (https://github.com/dniklaus/arduino-utils-timer)
* Timer (https://github.com/dniklaus/wiring-timer, Arduino Library Manager: wiring-timer



Expand Down Expand Up @@ -82,7 +84,7 @@ public:
}
};

setup()
void setup()
{
myLcdKeypad = new LcdKeypad(); // instatiate an object of the LcdKeypad class, using default parameters

Expand All @@ -93,7 +95,7 @@ setup()
myLcdKeypad->print("Value:"); // print a Value label on the second line of the display
}

loop()
void loop()
{
scheduleTimers(); // Get the timer(s) ticked, in particular the LcdKeypad dirver's keyPollTimer
}
Expand Down

0 comments on commit 7337bed

Please sign in to comment.