Library and example sketch

5 files changed, 425 insertions, 1 deletions

diff --git a/OLEDFourBit/OLEDFourBit.cpp b/OLEDFourBit/OLEDFourBit.cpp
new file mode 100644
index 0000000..004ba15
--- /dev/null
+++ b/OLEDFourBit/OLEDFourBit.cpp
@@ -0,0 +1,260 @@
+#include "OLEDFourBit.h"
+
+#include <stdio.h>
+#include <string.h>
+#include <inttypes.h>
+#include "Arduino.h"
+
+OLEDFourBit::OLEDFourBit(uint8_t rs, uint8_t rw, uint8_t enable, uint8_t d4, uint8_t d5, uint8_t d6, uint8_t d7)
+{
+  init(rs, rw, enable, d4, d5, d6, d7);
+}
+
+void OLEDFourBit::init(uint8_t rs, uint8_t rw, uint8_t enable, uint8_t d4, uint8_t d5, uint8_t d6, uint8_t d7)
+{
+  _rs_pin = rs;
+  _rw_pin = rw;
+  _enable_pin = enable;
+  _busy_pin = d7;
+
+  _data_pins[0] = d4;
+  _data_pins[1] = d5;
+  _data_pins[2] = d6;
+  _data_pins[3] = d7;
+
+
+  pinMode(_rs_pin, OUTPUT);
+  pinMode(_rw_pin, OUTPUT);
+  pinMode(_enable_pin, OUTPUT);
+
+  _displayfunction = LCD_FUNCTIONSET | LCD_4BITMODE;
+
+  begin(20, 4);
+}
+
+void OLEDFourBit::begin(uint8_t cols, uint8_t lines) {
+  _numlines = lines;
+  _currline = 0;
+
+  pinMode(_rs_pin, OUTPUT);
+  pinMode(_rw_pin, OUTPUT);
+  pinMode(_enable_pin, OUTPUT);
+
+  digitalWrite(_rs_pin, LOW);
+  digitalWrite(_enable_pin, LOW);
+  digitalWrite(_rw_pin, LOW);
+
+  // SEE PAGE 20 of NHD-0420DZW-AY5
+  delayMicroseconds(50000); // wait 50 ms just to be sure tha the lcd is initialized
+
+  // Now we pull both RS and R/W low to begin commands
+
+  for (int i = 0; i < 4; i++) {
+    pinMode(_data_pins[i], OUTPUT);
+    digitalWrite(_data_pins[i], LOW);
+  }
+
+  delayMicroseconds(100000);
+  write4bits(0x03);
+  delayMicroseconds(100000);
+  write4bits(0x02);
+  delayMicroseconds(10000);
+  write4bits(0x02);
+  delayMicroseconds(10000);
+  write4bits(0x08);
+
+
+  //command(0x28);
+  delayMicroseconds(10000);
+
+  command(0x08);	// Display off
+  delayMicroseconds(10000);
+
+  command(0x01);	// display clear
+  delayMicroseconds(10000);
+
+  command(0x06);	// Entry Mode Set:
+  delayMicroseconds(10000);
+
+
+  command(0x02);	// Home
+  delayMicroseconds(10000);
+
+  command(0x0C);	// display on/ cursor on/ cursor blink
+  delayMicroseconds(10000);
+
+
+}
+
+/********** high level commands, for the user! */
+void OLEDFourBit::clear()
+{
+  command(LCD_CLEARDISPLAY);  // clear display, set cursor position to zero
+}
+
+void OLEDFourBit::home()
+{
+  command(LCD_RETURNHOME);  // set cursor position to zero
+}
+
+void OLEDFourBit::setCursor(uint8_t col, uint8_t row)
+{
+  uint8_t row_offsets[] = { 0x00, 0x40, 0x14, 0x54 };
+  if ( row >= _numlines ) {
+    row = 0;  //write to first line if out off bounds
+  }
+
+  command(LCD_SETDDRAMADDR | (col + row_offsets[row]));
+}
+
+// Turn the display on/off (quickly)
+void OLEDFourBit::noDisplay() {
+  _displaycontrol &= ~LCD_DISPLAYON;
+  command(LCD_DISPLAYCONTROL | _displaycontrol);
+}
+void OLEDFourBit::display() {
+  _displaycontrol |= LCD_DISPLAYON;
+  command(LCD_DISPLAYCONTROL | _displaycontrol);
+}
+
+// Turns the underline cursor on/off
+void OLEDFourBit::noCursor() {
+  _displaycontrol &= ~LCD_CURSORON;
+  command(LCD_DISPLAYCONTROL | _displaycontrol);
+}
+void OLEDFourBit::cursor() {
+  _displaycontrol |= LCD_CURSORON;
+  command(LCD_DISPLAYCONTROL | _displaycontrol);
+}
+
+// Turn on and off the blinking cursor
+void OLEDFourBit::noBlink() {
+  _displaycontrol &= ~LCD_BLINKON;
+  command(LCD_DISPLAYCONTROL | _displaycontrol);
+}
+void OLEDFourBit::blink() {
+  _displaycontrol |= LCD_BLINKON;
+  command(LCD_DISPLAYCONTROL | _displaycontrol);
+}
+
+// These commands scroll the display without changing the RAM
+void OLEDFourBit::scrollDisplayLeft(void) {
+  command(LCD_CURSORSHIFT | LCD_DISPLAYMOVE | LCD_MOVELEFT);
+}
+void OLEDFourBit::scrollDisplayRight(void) {
+  command(LCD_CURSORSHIFT | LCD_DISPLAYMOVE | LCD_MOVERIGHT);
+}
+
+// This is for text that flows Left to Right
+void OLEDFourBit::leftToRight(void) {
+  _displaymode |= LCD_ENTRYLEFT;
+  command(LCD_ENTRYMODESET | _displaymode);
+}
+
+// This is for text that flows Right to Left
+void OLEDFourBit::rightToLeft(void) {
+  _displaymode &= ~LCD_ENTRYLEFT;
+  command(LCD_ENTRYMODESET | _displaymode);
+}
+
+// This will 'right justify' text from the cursor
+void OLEDFourBit::autoscroll(void) {
+  _displaymode |= LCD_ENTRYSHIFTINCREMENT;
+  command(LCD_ENTRYMODESET | _displaymode);
+}
+
+// This will 'left justify' text from the cursor
+void OLEDFourBit::noAutoscroll(void) {
+  _displaymode &= ~LCD_ENTRYSHIFTINCREMENT;
+  command(LCD_ENTRYMODESET | _displaymode);
+}
+
+// Allows us to fill the first 8 CGRAM locations
+// with custom characters
+void OLEDFourBit::createChar(uint8_t location, uint8_t charmap[]) {
+  location &= 0x7; // we only have 8 locations 0-7
+  command(LCD_SETCGRAMADDR | (location << 3));
+  for (int i=0; i<8; i++) {
+    write(charmap[i]);
+  }
+}
+
+/*********** mid level commands, for sending data/cmds */
+
+inline void OLEDFourBit::command(uint8_t value) {
+  send(value, LOW);
+  waitBusy();
+}
+
+inline size_t OLEDFourBit::write(uint8_t value) {
+  send(value, HIGH);
+  waitBusy();
+}
+
+/************ low level data pushing commands **********/
+
+// write either command or data
+void OLEDFourBit::send(uint8_t value, uint8_t mode) {
+  digitalWrite(_rs_pin, mode);
+  pinMode(_rw_pin, OUTPUT);
+  digitalWrite(_rw_pin, LOW);
+
+  write4bits(value>>4);
+  write4bits(value);
+}
+
+void OLEDFourBit::pulseEnable(void) {
+  digitalWrite(_enable_pin, HIGH);
+  delayMicroseconds(100);    // enable pulse must be >450ns
+  digitalWrite(_enable_pin, LOW);
+}
+
+void OLEDFourBit::write4bits(uint8_t value) {
+  for (int i = 0; i < 4; i++) {
+    pinMode(_data_pins[i], OUTPUT);
+    digitalWrite(_data_pins[i], (value >> i) & 0x01);
+  }
+  delayMicroseconds(100);
+  pulseEnable();
+}
+
+void OLEDFourBit::waitBusy(void) {
+  //delayMicroseconds(5000);
+  unsigned char busy = 1;
+  pinMode(_busy_pin, INPUT);
+  digitalWrite(_rs_pin, LOW);
+  digitalWrite(_rw_pin, HIGH);
+  do{
+  	digitalWrite(_enable_pin, LOW);
+  	digitalWrite(_enable_pin, HIGH);
+  	delayMicroseconds(10);
+  	busy = digitalRead(_busy_pin);
+  	digitalWrite(_enable_pin, LOW);
+
+  	pulseEnable();		// get remaining 4 bits, which are not used.
+
+  }while(busy);
+
+  pinMode(_busy_pin, OUTPUT);
+  digitalWrite(_rw_pin, LOW);
+}
+
+char OLEDFourBit::readChar(void){
+  char value=0x00;
+  for (int i = 0; i < 4; i++) {
+    pinMode(_data_pins[i], INPUT);
+  }
+  digitalWrite(_rs_pin, HIGH);
+  digitalWrite(_rw_pin, HIGH);
+  pulseEnable();
+  delayMicroseconds(600);
+  for (int i = 0; i < 4; i++) {
+    value = value | (digitalRead(_data_pins[i]) << (i+4));
+  }
+  pulseEnable();
+  delayMicroseconds(600);
+  for (int i = 0; i < 4; i++) {
+    value = value | (digitalRead(_data_pins[i]) << (i));
+  }
+  return value;
+}
\ No newline at end of file
diff --git a/OLEDFourBit/OLEDFourBit.h b/OLEDFourBit/OLEDFourBit.h
new file mode 100644
index 0000000..a57bfcd
--- /dev/null
+++ b/OLEDFourBit/OLEDFourBit.h
@@ -0,0 +1,96 @@
+#ifndef OLEDFourBit_h
+#define OLEDFourBit_h
+
+#include <inttypes.h>
+#include "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 0x28
+#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_ENGLISH_JAPANESE   0x00
+#define LCD_WESTERN_EUROPEAN_1 0x01
+#define LCD_ENGLISH_RUSSIAN    0x02
+#define LCD_WESTERN_EUROPEAN_2 0x03
+
+
+class OLEDFourBit : public Print {
+public:
+  OLEDFourBit(uint8_t rs, uint8_t rw, uint8_t enable, uint8_t d4, uint8_t d5, uint8_t d6, uint8_t d7);
+
+  void init(uint8_t rs, uint8_t rw, uint8_t enable, uint8_t d4, uint8_t d5, uint8_t d6, uint8_t d7);
+
+  void begin(uint8_t cols, uint8_t rows);
+
+  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_t, uint8_t[]);
+  void setCursor(uint8_t, uint8_t);
+  virtual size_t write(uint8_t);
+  void command(uint8_t);
+  char readChar(void);
+
+private:
+  void send(uint8_t, uint8_t);
+  void write4bits(uint8_t);
+  void pulseEnable();
+  void waitBusy();
+
+  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 _busy_pin;
+  uint8_t _data_pins[4];
+
+  uint8_t _displayfunction;
+  uint8_t _displaycontrol;
+  uint8_t _displaymode;
+  uint8_t _initialized;
+  uint8_t _currline;
+  uint8_t _numlines;
+};
+
+#endif
diff --git a/OLEDFourBit/keywords.txt b/OLEDFourBit/keywords.txt
new file mode 100644
index 0000000..83615dc
--- /dev/null
+++ b/OLEDFourBit/keywords.txt
@@ -0,0 +1,37 @@
+#######################################
+# Syntax Coloring Map For OLEDFourBit
+#######################################
+
+#######################################
+# Datatypes (KEYWORD1)
+#######################################
+
+OLEDFourBit	KEYWORD1
+
+#######################################
+# Methods and Functions (KEYWORD2)
+#######################################
+
+begin	KEYWORD2
+clear	KEYWORD2
+home	KEYWORD2
+print	KEYWORD2
+setCursor	KEYWORD2
+cursor	KEYWORD2
+noCursor	KEYWORD2
+blink	KEYWORD2
+noBlink	KEYWORD2
+display	KEYWORD2
+noDisplay	KEYWORD2
+autoscroll	KEYWORD2
+noAutoscroll	KEYWORD2
+leftToRight	KEYWORD2
+rightToLeft	KEYWORD2
+scrollDisplayLeft	KEYWORD2
+scrollDisplayRight	KEYWORD2
+createChar	KEYWORD2
+
+#######################################
+# Constants (LITERAL1)
+#######################################
+
diff --git a/README.md b/README.md
index 91c0888..81f3b6c 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,10 @@
 ArduinoOLEDLibrary
 ==================
 
-An Arduino v1.0+ library for Newhaven OLED displays. Adapted from Elco Jacobs library for previous versions
+An Arduino v1.0+ library for [Newhaven OLED displays](http://www.newhavendisplay.com/oled-c-119.html), such as the NHD‐0420DZW series.
+
+This is an edit to [Elco Jacobs](http://www.elcojacobs.com) OLED library, which would not compile under v1.0+ of the Arduino IDE (Tested on v1.0.5).
+
+This library is for the 4-bit parallel interface. See the datasheet for wiring diagrams.
+
+To use, just copy the OLEDFourBit folder into arduino-1.x.x/libraries. Initialization and available functions are identical to the default Arduino LiquisCrystal library. An example sketch is included.
\ No newline at end of file
diff --git a/test.ino b/test.ino
new file mode 100644
index 0000000..491d9b3
--- /dev/null
+++ b/test.ino
@@ -0,0 +1,25 @@
+#include <OLEDFourBit.h>
+
+// see datasheet for pinouts
+#define RS 12    //RegisterSelect
+#define RW 10    //ReadWrite
+#define E 11     //Enable
+#define DB4 4    //4bit DataBus
+#define DB5 5
+#define DB6 6
+#define DB7 7
+
+OLEDFourBit oled(RS, RW, E, DB4, DB5, DB6, DB7);
+
+void setup()
+{
+  oled.begin(20,4);
+  oled.print("Hello World!");
+}
+
+void loop()
+{
+  oled.setCursor(0,1);
+  oled.print(millis()/1000);
+}
+