Carlos Alberto Nascimento Filho / RoboClaw

Roboclaw libray

Fork of TextLCD by Carlos Alberto Nascimento Filho

TextLCD.cpp@5:ab287c4899bf, 2012-11-21 (annotated)

Committer:
carlos_nascimento08
Date:
Wed Nov 21 17:19:24 2012 +0000
Revision:
5:ab287c4899bf
Parent:
2:8d777e7fe49b 
Library personal;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
carlos_nascimento08 2:8d777e7fe49b 1 /* mbed TextLCD Library, for a 4-bit LCD based on HD44780
carlos_nascimento08 2:8d777e7fe49b 2 * Copyright (c) 2007-2010, sford, http://mbed.org
carlos_nascimento08 2:8d777e7fe49b 3 *
carlos_nascimento08 2:8d777e7fe49b 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
carlos_nascimento08 2:8d777e7fe49b 5 * of this software and associated documentation files (the "Software"), to deal
carlos_nascimento08 2:8d777e7fe49b 6 * in the Software without restriction, including without limitation the rights
carlos_nascimento08 2:8d777e7fe49b 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
carlos_nascimento08 2:8d777e7fe49b 8 * copies of the Software, and to permit persons to whom the Software is
carlos_nascimento08 2:8d777e7fe49b 9 * furnished to do so, subject to the following conditions:
carlos_nascimento08 2:8d777e7fe49b 10 *
carlos_nascimento08 2:8d777e7fe49b 11 * The above copyright notice and this permission notice shall be included in
carlos_nascimento08 2:8d777e7fe49b 12 * all copies or substantial portions of the Software.
carlos_nascimento08 2:8d777e7fe49b 13 *
carlos_nascimento08 2:8d777e7fe49b 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
carlos_nascimento08 2:8d777e7fe49b 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
carlos_nascimento08 2:8d777e7fe49b 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
carlos_nascimento08 2:8d777e7fe49b 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
carlos_nascimento08 2:8d777e7fe49b 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
carlos_nascimento08 2:8d777e7fe49b 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
carlos_nascimento08 2:8d777e7fe49b 20 * THE SOFTWARE.
carlos_nascimento08 2:8d777e7fe49b 21 */
carlos_nascimento08 2:8d777e7fe49b 22
carlos_nascimento08 2:8d777e7fe49b 23 #include "TextLCD.h"
carlos_nascimento08 2:8d777e7fe49b 24 #include "mbed.h"
carlos_nascimento08 2:8d777e7fe49b 25
carlos_nascimento08 2:8d777e7fe49b 26 TextLCD::TextLCD(PinName rs, PinName e, PinName d0, PinName d1,
carlos_nascimento08 2:8d777e7fe49b 27 PinName d2, PinName d3, LCDType type) : _rs(rs),
carlos_nascimento08 2:8d777e7fe49b 28 _e(e), _d(d0, d1, d2, d3),
carlos_nascimento08 2:8d777e7fe49b 29 _type(type) {
carlos_nascimento08 2:8d777e7fe49b 30
carlos_nascimento08 2:8d777e7fe49b 31 _e = 1;
carlos_nascimento08 2:8d777e7fe49b 32 _rs = 0; // command mode
carlos_nascimento08 2:8d777e7fe49b 33
carlos_nascimento08 2:8d777e7fe49b 34 wait(0.015); // Wait 15ms to ensure powered up
carlos_nascimento08 2:8d777e7fe49b 35
carlos_nascimento08 2:8d777e7fe49b 36 // send "Display Settings" 3 times (Only top nibble of 0x30 as we've got 4-bit bus)
carlos_nascimento08 2:8d777e7fe49b 37 for (int i=0; i<3; i++) {
carlos_nascimento08 2:8d777e7fe49b 38 writeByte(0x3);
carlos_nascimento08 2:8d777e7fe49b 39 wait(0.00164); // this command takes 1.64ms, so wait for it
carlos_nascimento08 2:8d777e7fe49b 40 }
carlos_nascimento08 2:8d777e7fe49b 41 writeByte(0x2); // 4-bit mode
carlos_nascimento08 2:8d777e7fe49b 42 wait(0.000040f); // most instructions take 40us
carlos_nascimento08 2:8d777e7fe49b 43
carlos_nascimento08 2:8d777e7fe49b 44 writeCommand(0x28); // Function set 001 BW N F - -
carlos_nascimento08 2:8d777e7fe49b 45 writeCommand(0x0C);
carlos_nascimento08 2:8d777e7fe49b 46 writeCommand(0x6); // Cursor Direction and Display Shift : 0000 01 CD S (CD 0-left, 1-right S(hift) 0-no, 1-yes
carlos_nascimento08 2:8d777e7fe49b 47 cls();
carlos_nascimento08 2:8d777e7fe49b 48 }
carlos_nascimento08 2:8d777e7fe49b 49
carlos_nascimento08 2:8d777e7fe49b 50 void TextLCD::character(int column, int row, int c) {
carlos_nascimento08 2:8d777e7fe49b 51 int a = address(column, row);
carlos_nascimento08 2:8d777e7fe49b 52 writeCommand(a);
carlos_nascimento08 2:8d777e7fe49b 53 writeData(c);
carlos_nascimento08 2:8d777e7fe49b 54 }
carlos_nascimento08 2:8d777e7fe49b 55
carlos_nascimento08 2:8d777e7fe49b 56 void TextLCD::cls() {
carlos_nascimento08 2:8d777e7fe49b 57 writeCommand(0x01); // cls, and set cursor to 0
carlos_nascimento08 2:8d777e7fe49b 58 wait(0.00164f); // This command takes 1.64 ms
carlos_nascimento08 2:8d777e7fe49b 59 locate(0, 0);
carlos_nascimento08 2:8d777e7fe49b 60 }
carlos_nascimento08 2:8d777e7fe49b 61
carlos_nascimento08 2:8d777e7fe49b 62 void TextLCD::locate(int column, int row) {
carlos_nascimento08 2:8d777e7fe49b 63 _column = column;
carlos_nascimento08 2:8d777e7fe49b 64 _row = row;
carlos_nascimento08 2:8d777e7fe49b 65 }
carlos_nascimento08 2:8d777e7fe49b 66
carlos_nascimento08 2:8d777e7fe49b 67 int TextLCD::_putc(int value) {
carlos_nascimento08 2:8d777e7fe49b 68 if (value == '\n') {
carlos_nascimento08 2:8d777e7fe49b 69 _column = 0;
carlos_nascimento08 2:8d777e7fe49b 70 _row++;
carlos_nascimento08 2:8d777e7fe49b 71 if (_row >= rows()) {
carlos_nascimento08 2:8d777e7fe49b 72 _row = 0;
carlos_nascimento08 2:8d777e7fe49b 73 }
carlos_nascimento08 2:8d777e7fe49b 74 } else {
carlos_nascimento08 2:8d777e7fe49b 75 character(_column, _row, value);
carlos_nascimento08 2:8d777e7fe49b 76 _column++;
carlos_nascimento08 2:8d777e7fe49b 77 if (_column >= columns()) {
carlos_nascimento08 2:8d777e7fe49b 78 _column = 0;
carlos_nascimento08 2:8d777e7fe49b 79 _row++;
carlos_nascimento08 2:8d777e7fe49b 80 if (_row >= rows()) {
carlos_nascimento08 2:8d777e7fe49b 81 _row = 0;
carlos_nascimento08 2:8d777e7fe49b 82 }
carlos_nascimento08 2:8d777e7fe49b 83 }
carlos_nascimento08 2:8d777e7fe49b 84 }
carlos_nascimento08 2:8d777e7fe49b 85 return value;
carlos_nascimento08 2:8d777e7fe49b 86 }
carlos_nascimento08 2:8d777e7fe49b 87
carlos_nascimento08 2:8d777e7fe49b 88 int TextLCD::_getc() {
carlos_nascimento08 2:8d777e7fe49b 89 return -1;
carlos_nascimento08 2:8d777e7fe49b 90 }
carlos_nascimento08 2:8d777e7fe49b 91
carlos_nascimento08 2:8d777e7fe49b 92 void TextLCD::writeByte(int value) {
carlos_nascimento08 2:8d777e7fe49b 93 _d = value >> 4;
carlos_nascimento08 2:8d777e7fe49b 94 wait(0.000040f); // most instructions take 40us
carlos_nascimento08 2:8d777e7fe49b 95 _e = 0;
carlos_nascimento08 2:8d777e7fe49b 96 wait(0.000040f);
carlos_nascimento08 2:8d777e7fe49b 97 _e = 1;
carlos_nascimento08 2:8d777e7fe49b 98 _d = value >> 0;
carlos_nascimento08 2:8d777e7fe49b 99 wait(0.000040f);
carlos_nascimento08 2:8d777e7fe49b 100 _e = 0;
carlos_nascimento08 2:8d777e7fe49b 101 wait(0.000040f); // most instructions take 40us
carlos_nascimento08 2:8d777e7fe49b 102 _e = 1;
carlos_nascimento08 2:8d777e7fe49b 103 }
carlos_nascimento08 2:8d777e7fe49b 104
carlos_nascimento08 2:8d777e7fe49b 105 void TextLCD::writeCommand(int command) {
carlos_nascimento08 2:8d777e7fe49b 106 _rs = 0;
carlos_nascimento08 2:8d777e7fe49b 107 writeByte(command);
carlos_nascimento08 2:8d777e7fe49b 108 }
carlos_nascimento08 2:8d777e7fe49b 109
carlos_nascimento08 2:8d777e7fe49b 110 void TextLCD::writeData(int data) {
carlos_nascimento08 2:8d777e7fe49b 111 _rs = 1;
carlos_nascimento08 2:8d777e7fe49b 112 writeByte(data);
carlos_nascimento08 2:8d777e7fe49b 113 }
carlos_nascimento08 2:8d777e7fe49b 114
carlos_nascimento08 2:8d777e7fe49b 115 int TextLCD::address(int column, int row) {
carlos_nascimento08 2:8d777e7fe49b 116 switch (_type) {
carlos_nascimento08 2:8d777e7fe49b 117 case LCD20x4:
carlos_nascimento08 2:8d777e7fe49b 118 switch (row) {
carlos_nascimento08 2:8d777e7fe49b 119 case 0:
carlos_nascimento08 2:8d777e7fe49b 120 return 0x80 + column;
carlos_nascimento08 2:8d777e7fe49b 121 case 1:
carlos_nascimento08 2:8d777e7fe49b 122 return 0xc0 + column;
carlos_nascimento08 2:8d777e7fe49b 123 case 2:
carlos_nascimento08 2:8d777e7fe49b 124 return 0x94 + column;
carlos_nascimento08 2:8d777e7fe49b 125 case 3:
carlos_nascimento08 2:8d777e7fe49b 126 return 0xd4 + column;
carlos_nascimento08 2:8d777e7fe49b 127 }
carlos_nascimento08 2:8d777e7fe49b 128 case LCD16x2B:
carlos_nascimento08 2:8d777e7fe49b 129 return 0x80 + (row * 40) + column;
carlos_nascimento08 2:8d777e7fe49b 130 case LCD16x2:
carlos_nascimento08 2:8d777e7fe49b 131 case LCD20x2:
carlos_nascimento08 2:8d777e7fe49b 132 default:
carlos_nascimento08 2:8d777e7fe49b 133 return 0x80 + (row * 0x40) + column;
carlos_nascimento08 2:8d777e7fe49b 134 }
carlos_nascimento08 2:8d777e7fe49b 135 }
carlos_nascimento08 2:8d777e7fe49b 136
carlos_nascimento08 2:8d777e7fe49b 137 int TextLCD::columns() {
carlos_nascimento08 2:8d777e7fe49b 138 switch (_type) {
carlos_nascimento08 2:8d777e7fe49b 139 case LCD20x4:
carlos_nascimento08 2:8d777e7fe49b 140 case LCD20x2:
carlos_nascimento08 2:8d777e7fe49b 141 return 20;
carlos_nascimento08 2:8d777e7fe49b 142 case LCD16x2:
carlos_nascimento08 2:8d777e7fe49b 143 case LCD16x2B:
carlos_nascimento08 2:8d777e7fe49b 144 default:
carlos_nascimento08 2:8d777e7fe49b 145 return 16;
carlos_nascimento08 2:8d777e7fe49b 146 }
carlos_nascimento08 2:8d777e7fe49b 147 }
carlos_nascimento08 2:8d777e7fe49b 148
carlos_nascimento08 2:8d777e7fe49b 149 int TextLCD::rows() {
carlos_nascimento08 2:8d777e7fe49b 150 switch (_type) {
carlos_nascimento08 2:8d777e7fe49b 151 case LCD20x4:
carlos_nascimento08 2:8d777e7fe49b 152 return 4;
carlos_nascimento08 2:8d777e7fe49b 153 case LCD16x2:
carlos_nascimento08 2:8d777e7fe49b 154 case LCD16x2B:
carlos_nascimento08 2:8d777e7fe49b 155 case LCD20x2:
carlos_nascimento08 2:8d777e7fe49b 156 default:
carlos_nascimento08 2:8d777e7fe49b 157 return 2;
carlos_nascimento08 2:8d777e7fe49b 158 }
carlos_nascimento08 2:8d777e7fe49b 159 }