han back / Mbed OS CLEO_FLAME

SMART CLEO Flame

TextLCD/TextLCD.cpp@0:dd25ed169eae, 2017-09-28 (annotated)

Committer:
SMART_CLEO
Date:
Thu Sep 28 02:13:22 2017 +0000
Revision:
0:dd25ed169eae
SMART_CLEO

;

Who changed what in which revision?

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