-
Notifications
You must be signed in to change notification settings - Fork 214
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #31 from natevw/master
LCD support, misc. other fixes
- Loading branch information
Showing
5 changed files
with
339 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,254 @@ | ||
| // port of LiquidCrystal.cpp by natevw | ||
|
|
||
|
|
||
| // commands | ||
| LCD_CLEARDISPLAY = 0x01; | ||
| LCD_RETURNHOME = 0x02; | ||
| LCD_ENTRYMODESET = 0x04; | ||
| LCD_DISPLAYCONTROL = 0x08; | ||
| LCD_CURSORSHIFT = 0x10; | ||
| LCD_FUNCTIONSET = 0x20; | ||
| LCD_SETCGRAMADDR = 0x40; | ||
| LCD_SETDDRAMADDR = 0x80; | ||
|
|
||
| // flags for display entry mode | ||
| LCD_ENTRYRIGHT = 0x00; | ||
| LCD_ENTRYLEFT = 0x02; | ||
| LCD_ENTRYSHIFTINCREMENT = 0x01; | ||
| LCD_ENTRYSHIFTDECREMENT = 0x00; | ||
|
|
||
| // flags for display on/off control | ||
| LCD_DISPLAYON = 0x04; | ||
| LCD_DISPLAYOFF = 0x00; | ||
| LCD_CURSORON = 0x02; | ||
| LCD_CURSOROFF = 0x00; | ||
| LCD_BLINKON = 0x01; | ||
| LCD_BLINKOFF = 0x00; | ||
|
|
||
| // flags for display/cursor shift | ||
| LCD_DISPLAYMOVE = 0x08; | ||
| LCD_CURSORMOVE = 0x00; | ||
| LCD_MOVERIGHT = 0x04; | ||
| LCD_MOVELEFT = 0x00; | ||
|
|
||
| // flags for function set | ||
| LCD_8BITMODE = 0x10; | ||
| LCD_4BITMODE = 0x00; | ||
| LCD_2LINE = 0x08; | ||
| LCD_1LINE = 0x00; | ||
| LCD_5x10DOTS = 0x04; | ||
| LCD_5x8DOTS = 0x00; | ||
|
|
||
|
|
||
|
|
||
| var LCD = function (options) { | ||
| if (!options || !options.board) throw new Error('Must supply required options'); | ||
| this.board = options.board; | ||
|
|
||
| var pins = options.pins || [12, 11, 5, 4, 3, 2]; | ||
| if (!Array.isArray(pins)) | ||
| this.pins = pins; | ||
| else if (pins.length % 2) | ||
| this.pins = {rs:pins[0], rw:pins[1], e:pins[2], data:pins.slice(3)}; | ||
| else | ||
| this.pins = {rs:pins[0], e:pins[1], data:pins.slice(2)}; | ||
| if (!('rw' in this.pins)) this.pins.rw = 255; | ||
|
|
||
| this.board.pinMode(this.pins.rs, 'out'); | ||
| if (this.pins.rw !== 255) { | ||
| this.board.pinMode(this.pins.rw, 'out'); | ||
| } | ||
| this.board.pinMode(this.pins.e, 'out'); | ||
|
|
||
| this.begin(16, 1); | ||
| } | ||
|
|
||
| LCD.prototype.begin = function (cols, lines, dotsize) { | ||
| this._numlines = lines; | ||
|
|
||
| var displayfunction = 0; | ||
| displayfunction |= (lines > 1) ? LCD_2LINE : LCD_1LINE; | ||
| displayfunction |= (dotsize && lines === 1) ? LCD_5x10DOTS : LCD_5x8DOTS; | ||
|
|
||
| this._delayMicroseconds(50000); | ||
| this.board.digitalWrite(this.pins.rs, this.board.LOW); | ||
| this.board.digitalWrite(this.pins.e, this.board.LOW); | ||
| if (this.pins.rw !== 255) | ||
| this.board.digitalWrite(this.pins.rw, this.board.LOW); | ||
|
|
||
| // put the LCD into 4 bit or 8 bit mode | ||
| if (this.pins.data.length === 4) { | ||
| displayfunction |= LCD_4BITMODE; | ||
| this._writeNbits(4, 0x03); | ||
| this._delayMicroseconds(4500); | ||
| this._writeNbits(4, 0x03); | ||
| this._delayMicroseconds(4500); | ||
| this._writeNbits(4, 0x03); | ||
| this._delayMicroseconds(150); | ||
| this._writeNbits(4, 0x02); | ||
| } else { | ||
| displayfunction |= LCD_8BITMODE; | ||
| this.command(LCD_FUNCTIONSET | displayfunction); | ||
| this._delayMicroseconds(4500); | ||
| this.command(LCD_FUNCTIONSET | displayfunction); | ||
| this._delayMicroseconds(150); | ||
| this.command(LCD_FUNCTIONSET | displayfunction); | ||
| } | ||
|
|
||
| this.command(LCD_FUNCTIONSET | displayfunction); | ||
|
|
||
| this._displaycontrol = LCD_DISPLAYON | LCD_CURSOROFF | LCD_BLINKOFF; | ||
| this.display(); | ||
|
|
||
| this.clear(); | ||
|
|
||
| this._displaymode = LCD_ENTRYLEFT | LCD_ENTRYSHIFTDECREMENT; | ||
| this.leftToRight(); | ||
| } | ||
|
|
||
| LCD.prototype.clear = function () { | ||
| this.command(LCD_CLEARDISPLAY); | ||
| this._delayMicroseconds(2000); // this command takes a long time! | ||
| } | ||
|
|
||
| LCD.prototype.home = function () { | ||
| this.command(LCD_RETURNHOME); | ||
| this._delayMicroseconds(2000); | ||
| } | ||
|
|
||
| LCD.prototype.setCursor = function (col, row) { | ||
| if (row >= this._numlines) { | ||
| row = this._numlines - 1; | ||
| } | ||
|
|
||
| var row_offsets = [0x00, 0x40, 0x14, 0x54]; | ||
| this.command(LCD_SETDDRAMADDR | (col + row_offsets[row])); | ||
| } | ||
|
|
||
| LCD.prototype.display = function (on) { | ||
| on = (arguments.length) ? on : true; | ||
| if (on) this._displaycontrol |= LCD_DISPLAYON | ||
| else this._displaycontrol &= ~LCD_DISPLAYON; | ||
| this.command(LCD_DISPLAYCONTROL | this._displaycontrol); | ||
| } | ||
|
|
||
| LCD.prototype.noDisplay = function () { this.display(false); } | ||
|
|
||
| LCD.prototype.cursor = function (on) { | ||
| on = (arguments.length) ? on : true; | ||
| if (on) this._displaycontrol |= LCD_CURSORON | ||
| else this._displaycontrol &= ~LCD_CURSORON; | ||
| this.command(LCD_DISPLAYCONTROL | this._displaycontrol); | ||
| } | ||
|
|
||
| LCD.prototype.noCursor = function () { this.cursor(false); } | ||
|
|
||
| LCD.prototype.blink = function (on) { | ||
| on = (arguments.length) ? on : true; | ||
| if (on) this._displaycontrol |= LCD_BLINKON | ||
| else this._displaycontrol &= ~LCD_BLINKON; | ||
| this.command(LCD_DISPLAYCONTROL | this._displaycontrol); | ||
| } | ||
|
|
||
| LCD.prototype.noBlink = function () { this.blink(false); } | ||
|
|
||
| LCD.prototype.scrollDisplayLeft = function () { | ||
| this.command(LCD_CURSORSHIFT | LCD_DISPLAYMOVE | LCD_MOVELEFT); | ||
| } | ||
|
|
||
| LCD.prototype.scrollDisplayRight = function () { | ||
| this.command(LCD_CURSORSHIFT | LCD_DISPLAYMOVE | LCD_MOVERIGHT); | ||
| } | ||
|
|
||
|
|
||
| LCD.prototype.leftToRight = function () { | ||
| this._displaymode |= LCD_ENTRYLEFT; | ||
| this.command(LCD_ENTRYMODESET | this._displaymode); | ||
| } | ||
|
|
||
| LCD.prototype.rightToLeft = function () { | ||
| this._displaymode &= ~LCD_ENTRYLEFT; | ||
| this.command(LCD_ENTRYMODESET | this._displaymode); | ||
| } | ||
|
|
||
| LCD.prototype.autoscroll = function (on) { | ||
| on = (arguments.length) ? on : true; | ||
| if (on) this._displaymode |= LCD_ENTRYSHIFTINCREMENT | ||
| else this._displaymode &= ~LCD_ENTRYSHIFTINCREMENT; | ||
| this.command(LCD_ENTRYMODESET | this._displaymode); | ||
| } | ||
|
|
||
| LCD.prototype.noAutoscroll = function () { this.autoscroll(false); } | ||
|
|
||
| LCD.prototype.createChar = function (location, charmap) { | ||
| location &= 0x7; | ||
| this.command(LCD_SETCGRAMADDR | (location << 3)); | ||
|
|
||
| var buffer = new Buffer(8); | ||
| if (Array.isArray(charmap)) for (var i = 0; i < 8; i++) { | ||
| buffer[i] = parseInt(charmap[i], 2); | ||
| } else if (typeof charmap === 'string') for (var i = 0; i < 8; i++) { | ||
| var byte = 0; | ||
| if (charmap[5*i + 0] !== ' ') byte |= 0x10; | ||
| if (charmap[5*i + 1] !== ' ') byte |= 0x08; | ||
| if (charmap[5*i + 2] !== ' ') byte |= 0x04; | ||
| if (charmap[5*i + 3] !== ' ') byte |= 0x02; | ||
| if (charmap[5*i + 4] !== ' ') byte |= 0x01; | ||
| buffer[i] = byte; | ||
| } else buffer = charmap; | ||
| this.write(buffer); | ||
| } | ||
|
|
||
| LCD.prototype.write = LCD.prototype.print = function (str) { | ||
| // TODO: map misc Unicode chars to typical LCD extended charset? | ||
| var bytes = (typeof str === 'string') ? new Buffer(str, 'ascii') : | ||
| (typeof str === 'object') ? str : new Buffer([str]); | ||
| for (var i = 0, len = bytes.length; i < len; i++) | ||
| this.send(bytes[i], this.board.HIGH); | ||
| } | ||
|
|
||
|
|
||
| /* | ||
| * mid/low level stuff | ||
| */ | ||
|
|
||
| LCD.prototype.command = function (value) { | ||
| this.send(value, this.board.LOW); | ||
| } | ||
|
|
||
| LCD.prototype.send = function (value, mode) { | ||
| this.board.digitalWrite(this.pins.rs, mode); | ||
| if (this.pins.rw !== 255) { | ||
| this.board.digitalWrite(this.pins.rw, this.board.LOW); | ||
| } | ||
| if (this.pins.data.length === 8) { | ||
| this._writeNbits(8, value); | ||
| } else { | ||
| this._writeNbits(4, value >> 4); | ||
| this._writeNbits(4, value & 0xF); | ||
| } | ||
| } | ||
|
|
||
| LCD.prototype._writeNbits = function (n, value) { | ||
| for (var i = 0; i < n; i++) { | ||
| this.board.pinMode(this.pins.data[i], 'out'); | ||
| var bit = (value >> i) & 0x01; | ||
| this.board.digitalWrite(this.pins.data[i], (bit) ? this.board.HIGH : this.board.LOW); | ||
| } | ||
| this._pulseEnable(); | ||
| } | ||
|
|
||
| LCD.prototype._pulseEnable = function () { | ||
| this.board.digitalWrite(this.pins.e, this.board.LOW); | ||
| this._delayMicroseconds(1); | ||
| this.board.digitalWrite(this.pins.e, this.board.HIGH); | ||
| this._delayMicroseconds(1); // enable pulse must be >450ns | ||
| this.board.digitalWrite(this.pins.e, this.board.LOW); | ||
| this._delayMicroseconds(100); // commands need > 37us to settle | ||
| } | ||
|
|
||
| LCD.prototype._delayMicroseconds = function (us) { | ||
| this.board.delay(us/1000); | ||
| } | ||
|
|
||
| module.exports = LCD; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters