Saad Tayyab / N5110-Modded

Library for interfacing to Nokia 5110 LCD display with Image Loader (as found on the SparkFun website).

N5110.h@2:e93021cfb0a9, 2014-01-26 (annotated)

Committer:
eencae
Date:
Sun Jan 26 20:06:58 2014 +0000
Revision:
2:e93021cfb0a9
Parent:
1:df68f34cd32d
Child:
4:e923c54c1c7d
Added documentation and additional testing.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
eencae 1:df68f34cd32d 1 /**
eencae 2:e93021cfb0a9 2 @file N5110.h
eencae 1:df68f34cd32d 3
eencae 2:e93021cfb0a9 4 @brief Simple library for interfacing with Nokia 5110 LCD display (https://www.sparkfun.com/products/10168) using the hardware SPI on the mbed.
eencae 2:e93021cfb0a9 5 The display is powered from a GPIO pin meaning it can be controlled via software. The LED backlight is also software-controllable (via PWM pin).
eencae 2:e93021cfb0a9 6 -Can print characters and strings to the display using the included 5x7 font.
eencae 2:e93021cfb0a9 7 -The library also implements a screen buffer so that individual pixels on the display (84 x 48) can be set, cleared and read.
eencae 0:d563e74f0ae9 8
eencae 2:e93021cfb0a9 9 Acknowledgements to Chris Yan's Nokia_5110 Library.
eencae 0:d563e74f0ae9 10
eencae 0:d563e74f0ae9 11 Revision 1.0
eencae 0:d563e74f0ae9 12
eencae 2:e93021cfb0a9 13 @author Craig A. Evans
eencae 2:e93021cfb0a9 14 @date January 2014
eencae 0:d563e74f0ae9 15
eencae 0:d563e74f0ae9 16 */
eencae 0:d563e74f0ae9 17
eencae 0:d563e74f0ae9 18 #ifndef N5110_H
eencae 0:d563e74f0ae9 19 #define N5110_H
eencae 0:d563e74f0ae9 20
eencae 0:d563e74f0ae9 21 // Command Bytes - taken from Chris Yan's library
eencae 2:e93021cfb0a9 22 // More information can be found in the display datasheet
eencae 2:e93021cfb0a9 23 // H = 0 - Basic instructions
eencae 0:d563e74f0ae9 24 #define CMD_DC_CLEAR_DISPLAY 0x08
eencae 0:d563e74f0ae9 25 #define CMD_DC_NORMAL_MODE 0x0C
eencae 0:d563e74f0ae9 26 #define CMD_DC_FILL_DISPLAY 0x09
eencae 0:d563e74f0ae9 27 #define CMD_DC_INVERT_VIDEO 0x0D
eencae 0:d563e74f0ae9 28 #define CMD_FS_HORIZONTAL_MODE 0x00
eencae 0:d563e74f0ae9 29 #define CMD_FS_VERTICAL_MODE 0x02
eencae 0:d563e74f0ae9 30 #define CMD_FS_BASIC_MODE 0x00
eencae 0:d563e74f0ae9 31 #define CMD_FS_EXTENDED_MODE 0x01
eencae 0:d563e74f0ae9 32 #define CMD_FS_ACTIVE_MODE 0x00
eencae 0:d563e74f0ae9 33 #define CMD_FS_POWER_DOWN_MODE 0x04
eencae 2:e93021cfb0a9 34 // H = 1 - Extended instructions
eencae 0:d563e74f0ae9 35 #define CMD_TC_TEMP_0 0x04
eencae 0:d563e74f0ae9 36 #define CMD_TC_TEMP_1 0x05
eencae 0:d563e74f0ae9 37 #define CMD_TC_TEMP_2 0x06
eencae 0:d563e74f0ae9 38 #define CMD_TC_TEMP_3 0x07
eencae 0:d563e74f0ae9 39 #define CMD_BI_MUX_24 0x15
eencae 0:d563e74f0ae9 40 #define CMD_BI_MUX_48 0x13
eencae 0:d563e74f0ae9 41 #define CMD_BI_MUX_100 0x10
eencae 0:d563e74f0ae9 42 #define CMD_VOP_6V06 0xB2
eencae 0:d563e74f0ae9 43 #define CMD_VOP_7V38 0xC8
eencae 0:d563e74f0ae9 44
eencae 0:d563e74f0ae9 45 #include "mbed.h"
eencae 0:d563e74f0ae9 46
eencae 2:e93021cfb0a9 47 /** Class for interfacing with Nokia 5110 LCD
eencae 2:e93021cfb0a9 48 *
eencae 2:e93021cfb0a9 49 * Example:
eencae 2:e93021cfb0a9 50 * @code
eencae 2:e93021cfb0a9 51 *
eencae 2:e93021cfb0a9 52 * @endcode
eencae 2:e93021cfb0a9 53 */
eencae 1:df68f34cd32d 54 class N5110
eencae 1:df68f34cd32d 55 {
eencae 0:d563e74f0ae9 56
eencae 1:df68f34cd32d 57 public:
eencae 1:df68f34cd32d 58 /** Create a N5110 object connected to the specified pins
eencae 1:df68f34cd32d 59 *
eencae 1:df68f34cd32d 60 * @param pwr Pin connected to Vcc on the LCD display (pin 1)
eencae 1:df68f34cd32d 61 * @param sce Pin connected to chip enable (pin 3)
eencae 1:df68f34cd32d 62 * @param rst Pin connected to reset (pin 4)
eencae 1:df68f34cd32d 63 * @param dc Pin connected to data/command select (pin 5)
eencae 1:df68f34cd32d 64 * @param mosi Pin connected to data input (MOSI) (pin 6)
eencae 1:df68f34cd32d 65 * @param sclk Pin connected to serial clock (SCLK) (pin 7)
eencae 1:df68f34cd32d 66 * @param led Pin connected to LED backlight (must be PWM) (pin 8)
eencae 1:df68f34cd32d 67 *
eencae 1:df68f34cd32d 68 */
eencae 1:df68f34cd32d 69 N5110(PinName pwrPin, PinName scePin, PinName rstPin, PinName dcPin, PinName mosiPin, PinName sclkPin, PinName ledPin);
eencae 1:df68f34cd32d 70
eencae 1:df68f34cd32d 71 /** Initialise display
eencae 1:df68f34cd32d 72 *
eencae 1:df68f34cd32d 73 * Powers up the display and turns on backlight (50% brightness default).
eencae 1:df68f34cd32d 74 * Sets the display up in horizontal addressing mode and with normal video mode.
eencae 1:df68f34cd32d 75 */
eencae 1:df68f34cd32d 76 void init();
eencae 1:df68f34cd32d 77
eencae 1:df68f34cd32d 78 /** Turn off
eencae 1:df68f34cd32d 79 *
eencae 1:df68f34cd32d 80 * Powers down the display and turns of the backlight.
eencae 1:df68f34cd32d 81 * Needs to be reinitialised before being re-used.
eencae 1:df68f34cd32d 82 */
eencae 1:df68f34cd32d 83 void turnOff();
eencae 1:df68f34cd32d 84
eencae 1:df68f34cd32d 85 /** Clears
eencae 1:df68f34cd32d 86 *
eencae 1:df68f34cd32d 87 * Clears the screen.
eencae 1:df68f34cd32d 88 */
eencae 1:df68f34cd32d 89 void clear();
eencae 1:df68f34cd32d 90
eencae 1:df68f34cd32d 91 /** Turn on normal video mode (default)
eencae 1:df68f34cd32d 92 * Black on white
eencae 1:df68f34cd32d 93 */
eencae 1:df68f34cd32d 94 void normalMode();
eencae 1:df68f34cd32d 95
eencae 1:df68f34cd32d 96 /** Turn on inverse video mode (default)
eencae 1:df68f34cd32d 97 * White on black
eencae 1:df68f34cd32d 98 */
eencae 1:df68f34cd32d 99 void inverseMode();
eencae 1:df68f34cd32d 100
eencae 1:df68f34cd32d 101 /** Set Brightness
eencae 1:df68f34cd32d 102 *
eencae 1:df68f34cd32d 103 * Sets brightness of LED backlight.
eencae 1:df68f34cd32d 104 * @param brightness - float in range 0.0 to 1.0
eencae 1:df68f34cd32d 105 */
eencae 1:df68f34cd32d 106 void setBrightness(float brightness);
eencae 1:df68f34cd32d 107
eencae 1:df68f34cd32d 108 /** Set XY Address
eencae 1:df68f34cd32d 109 *
eencae 1:df68f34cd32d 110 * Sets the X and Y address of where the next data sent to the displa will be written in RAM.
eencae 1:df68f34cd32d 111 * @param x - the column number (0 to 83) - is automatically incremented after data is written
eencae 2:e93021cfb0a9 112 * @param y - the row number (0 to 5) - the diplay is split into 6 banks - each bank can be considered a row
eencae 1:df68f34cd32d 113 */
eencae 1:df68f34cd32d 114 void setXYAddress(int x, int y);
eencae 1:df68f34cd32d 115
eencae 2:e93021cfb0a9 116 /** Print String
eencae 2:e93021cfb0a9 117 *
eencae 2:e93021cfb0a9 118 * Prints a string of characters to the display.
eencae 2:e93021cfb0a9 119 * @param x - the column number (0 to 83)
eencae 2:e93021cfb0a9 120 * @param y - the row number (0 to 5) - the display is split into 6 banks - each bank can be considered a row
eencae 2:e93021cfb0a9 121 */
eencae 1:df68f34cd32d 122 void printString(const char * str,int x,int y);
eencae 1:df68f34cd32d 123
eencae 1:df68f34cd32d 124 /** Print Character
eencae 1:df68f34cd32d 125 *
eencae 1:df68f34cd32d 126 * Sends a character to the display. Will be printed at the current address.
eencae 1:df68f34cd32d 127 * X address is autoincremented by 1 to leave a pixel between successive characters
eencae 1:df68f34cd32d 128 * @param c - the character to print. Can print ASCII as so printChar('C').
eencae 1:df68f34cd32d 129 */
eencae 1:df68f34cd32d 130 void printChar(char c);
eencae 1:df68f34cd32d 131
eencae 1:df68f34cd32d 132 void setPixel(int x, int y);
eencae 1:df68f34cd32d 133 void clearPixel(int x, int y);
eencae 1:df68f34cd32d 134 unsigned char getPixel(int x, int y);
eencae 2:e93021cfb0a9 135
eencae 2:e93021cfb0a9 136
eencae 1:df68f34cd32d 137 void refreshDisplay();
eencae 1:df68f34cd32d 138 void clearBuffer();
eencae 1:df68f34cd32d 139 void randomiseBuffer();
eencae 1:df68f34cd32d 140
eencae 1:df68f34cd32d 141 private:
eencae 1:df68f34cd32d 142 void initSPI();
eencae 1:df68f34cd32d 143 void turnOn();
eencae 1:df68f34cd32d 144 void reset();
eencae 1:df68f34cd32d 145 void clearRAM();
eencae 1:df68f34cd32d 146 void sendCommand(unsigned char command);
eencae 1:df68f34cd32d 147 void sendData(unsigned char data);
eencae 1:df68f34cd32d 148
eencae 1:df68f34cd32d 149 public:
eencae 1:df68f34cd32d 150 unsigned char buffer[84][6]; // screen buffer - the 6 is for the banks - each one is 8 bits;
eencae 1:df68f34cd32d 151
eencae 1:df68f34cd32d 152 private: // private variables
eencae 1:df68f34cd32d 153 SPI* spi;
eencae 1:df68f34cd32d 154 PwmOut* led;
eencae 1:df68f34cd32d 155 DigitalOut* pwr;
eencae 1:df68f34cd32d 156 DigitalOut* sce;
eencae 1:df68f34cd32d 157 DigitalOut* rst;
eencae 1:df68f34cd32d 158 DigitalOut* dc;
eencae 0:d563e74f0ae9 159
eencae 0:d563e74f0ae9 160 };
eencae 0:d563e74f0ae9 161
eencae 0:d563e74f0ae9 162 const unsigned char font5x7[480] = {
eencae 0:d563e74f0ae9 163 0x00, 0x00, 0x00, 0x00, 0x00,// (space)
eencae 0:d563e74f0ae9 164 0x00, 0x00, 0x5F, 0x00, 0x00,// !
eencae 0:d563e74f0ae9 165 0x00, 0x07, 0x00, 0x07, 0x00,// "
eencae 0:d563e74f0ae9 166 0x14, 0x7F, 0x14, 0x7F, 0x14,// #
eencae 0:d563e74f0ae9 167 0x24, 0x2A, 0x7F, 0x2A, 0x12,// $
eencae 0:d563e74f0ae9 168 0x23, 0x13, 0x08, 0x64, 0x62,// %
eencae 0:d563e74f0ae9 169 0x36, 0x49, 0x55, 0x22, 0x50,// &
eencae 0:d563e74f0ae9 170 0x00, 0x05, 0x03, 0x00, 0x00,// '
eencae 0:d563e74f0ae9 171 0x00, 0x1C, 0x22, 0x41, 0x00,// (
eencae 0:d563e74f0ae9 172 0x00, 0x41, 0x22, 0x1C, 0x00,// )
eencae 0:d563e74f0ae9 173 0x08, 0x2A, 0x1C, 0x2A, 0x08,// *
eencae 0:d563e74f0ae9 174 0x08, 0x08, 0x3E, 0x08, 0x08,// +
eencae 0:d563e74f0ae9 175 0x00, 0x50, 0x30, 0x00, 0x00,// ,
eencae 0:d563e74f0ae9 176 0x08, 0x08, 0x08, 0x08, 0x08,// -
eencae 0:d563e74f0ae9 177 0x00, 0x60, 0x60, 0x00, 0x00,// .
eencae 0:d563e74f0ae9 178 0x20, 0x10, 0x08, 0x04, 0x02,// /
eencae 0:d563e74f0ae9 179 0x3E, 0x51, 0x49, 0x45, 0x3E,// 0
eencae 0:d563e74f0ae9 180 0x00, 0x42, 0x7F, 0x40, 0x00,// 1
eencae 0:d563e74f0ae9 181 0x42, 0x61, 0x51, 0x49, 0x46,// 2
eencae 0:d563e74f0ae9 182 0x21, 0x41, 0x45, 0x4B, 0x31,// 3
eencae 0:d563e74f0ae9 183 0x18, 0x14, 0x12, 0x7F, 0x10,// 4
eencae 0:d563e74f0ae9 184 0x27, 0x45, 0x45, 0x45, 0x39,// 5
eencae 0:d563e74f0ae9 185 0x3C, 0x4A, 0x49, 0x49, 0x30,// 6
eencae 0:d563e74f0ae9 186 0x01, 0x71, 0x09, 0x05, 0x03,// 7
eencae 0:d563e74f0ae9 187 0x36, 0x49, 0x49, 0x49, 0x36,// 8
eencae 0:d563e74f0ae9 188 0x06, 0x49, 0x49, 0x29, 0x1E,// 9
eencae 0:d563e74f0ae9 189 0x00, 0x36, 0x36, 0x00, 0x00,// :
eencae 0:d563e74f0ae9 190 0x00, 0x56, 0x36, 0x00, 0x00,// ;
eencae 0:d563e74f0ae9 191 0x00, 0x08, 0x14, 0x22, 0x41,// <
eencae 0:d563e74f0ae9 192 0x14, 0x14, 0x14, 0x14, 0x14,// =
eencae 0:d563e74f0ae9 193 0x41, 0x22, 0x14, 0x08, 0x00,// >
eencae 0:d563e74f0ae9 194 0x02, 0x01, 0x51, 0x09, 0x06,// ?
eencae 0:d563e74f0ae9 195 0x32, 0x49, 0x79, 0x41, 0x3E,// @
eencae 0:d563e74f0ae9 196 0x7E, 0x11, 0x11, 0x11, 0x7E,// A
eencae 0:d563e74f0ae9 197 0x7F, 0x49, 0x49, 0x49, 0x36,// B
eencae 0:d563e74f0ae9 198 0x3E, 0x41, 0x41, 0x41, 0x22,// C
eencae 0:d563e74f0ae9 199 0x7F, 0x41, 0x41, 0x22, 0x1C,// D
eencae 0:d563e74f0ae9 200 0x7F, 0x49, 0x49, 0x49, 0x41,// E
eencae 0:d563e74f0ae9 201 0x7F, 0x09, 0x09, 0x01, 0x01,// F
eencae 0:d563e74f0ae9 202 0x3E, 0x41, 0x41, 0x51, 0x32,// G
eencae 0:d563e74f0ae9 203 0x7F, 0x08, 0x08, 0x08, 0x7F,// H
eencae 0:d563e74f0ae9 204 0x00, 0x41, 0x7F, 0x41, 0x00,// I
eencae 0:d563e74f0ae9 205 0x20, 0x40, 0x41, 0x3F, 0x01,// J
eencae 0:d563e74f0ae9 206 0x7F, 0x08, 0x14, 0x22, 0x41,// K
eencae 0:d563e74f0ae9 207 0x7F, 0x40, 0x40, 0x40, 0x40,// L
eencae 0:d563e74f0ae9 208 0x7F, 0x02, 0x04, 0x02, 0x7F,// M
eencae 0:d563e74f0ae9 209 0x7F, 0x04, 0x08, 0x10, 0x7F,// N
eencae 0:d563e74f0ae9 210 0x3E, 0x41, 0x41, 0x41, 0x3E,// O
eencae 0:d563e74f0ae9 211 0x7F, 0x09, 0x09, 0x09, 0x06,// P
eencae 0:d563e74f0ae9 212 0x3E, 0x41, 0x51, 0x21, 0x5E,// Q
eencae 0:d563e74f0ae9 213 0x7F, 0x09, 0x19, 0x29, 0x46,// R
eencae 0:d563e74f0ae9 214 0x46, 0x49, 0x49, 0x49, 0x31,// S
eencae 0:d563e74f0ae9 215 0x01, 0x01, 0x7F, 0x01, 0x01,// T
eencae 0:d563e74f0ae9 216 0x3F, 0x40, 0x40, 0x40, 0x3F,// U
eencae 0:d563e74f0ae9 217 0x1F, 0x20, 0x40, 0x20, 0x1F,// V
eencae 0:d563e74f0ae9 218 0x7F, 0x20, 0x18, 0x20, 0x7F,// W
eencae 0:d563e74f0ae9 219 0x63, 0x14, 0x08, 0x14, 0x63,// X
eencae 0:d563e74f0ae9 220 0x03, 0x04, 0x78, 0x04, 0x03,// Y
eencae 0:d563e74f0ae9 221 0x61, 0x51, 0x49, 0x45, 0x43,// Z
eencae 0:d563e74f0ae9 222 0x00, 0x00, 0x7F, 0x41, 0x41,// [
eencae 0:d563e74f0ae9 223 0x02, 0x04, 0x08, 0x10, 0x20,// "\"
eencae 0:d563e74f0ae9 224 0x41, 0x41, 0x7F, 0x00, 0x00,// ]
eencae 0:d563e74f0ae9 225 0x04, 0x02, 0x01, 0x02, 0x04,// ^
eencae 0:d563e74f0ae9 226 0x40, 0x40, 0x40, 0x40, 0x40,// _
eencae 0:d563e74f0ae9 227 0x00, 0x01, 0x02, 0x04, 0x00,// `
eencae 0:d563e74f0ae9 228 0x20, 0x54, 0x54, 0x54, 0x78,// a
eencae 0:d563e74f0ae9 229 0x7F, 0x48, 0x44, 0x44, 0x38,// b
eencae 0:d563e74f0ae9 230 0x38, 0x44, 0x44, 0x44, 0x20,// c
eencae 0:d563e74f0ae9 231 0x38, 0x44, 0x44, 0x48, 0x7F,// d
eencae 0:d563e74f0ae9 232 0x38, 0x54, 0x54, 0x54, 0x18,// e
eencae 0:d563e74f0ae9 233 0x08, 0x7E, 0x09, 0x01, 0x02,// f
eencae 0:d563e74f0ae9 234 0x08, 0x14, 0x54, 0x54, 0x3C,// g
eencae 0:d563e74f0ae9 235 0x7F, 0x08, 0x04, 0x04, 0x78,// h
eencae 0:d563e74f0ae9 236 0x00, 0x44, 0x7D, 0x40, 0x00,// i
eencae 0:d563e74f0ae9 237 0x20, 0x40, 0x44, 0x3D, 0x00,// j
eencae 0:d563e74f0ae9 238 0x00, 0x7F, 0x10, 0x28, 0x44,// k
eencae 0:d563e74f0ae9 239 0x00, 0x41, 0x7F, 0x40, 0x00,// l
eencae 0:d563e74f0ae9 240 0x7C, 0x04, 0x18, 0x04, 0x78,// m
eencae 0:d563e74f0ae9 241 0x7C, 0x08, 0x04, 0x04, 0x78,// n
eencae 0:d563e74f0ae9 242 0x38, 0x44, 0x44, 0x44, 0x38,// o
eencae 0:d563e74f0ae9 243 0x7C, 0x14, 0x14, 0x14, 0x08,// p
eencae 0:d563e74f0ae9 244 0x08, 0x14, 0x14, 0x18, 0x7C,// q
eencae 0:d563e74f0ae9 245 0x7C, 0x08, 0x04, 0x04, 0x08,// r
eencae 0:d563e74f0ae9 246 0x48, 0x54, 0x54, 0x54, 0x20,// s
eencae 0:d563e74f0ae9 247 0x04, 0x3F, 0x44, 0x40, 0x20,// t
eencae 0:d563e74f0ae9 248 0x3C, 0x40, 0x40, 0x20, 0x7C,// u
eencae 0:d563e74f0ae9 249 0x1C, 0x20, 0x40, 0x20, 0x1C,// v
eencae 0:d563e74f0ae9 250 0x3C, 0x40, 0x30, 0x40, 0x3C,// w
eencae 0:d563e74f0ae9 251 0x44, 0x28, 0x10, 0x28, 0x44,// x
eencae 0:d563e74f0ae9 252 0x0C, 0x50, 0x50, 0x50, 0x3C,// y
eencae 0:d563e74f0ae9 253 0x44, 0x64, 0x54, 0x4C, 0x44,// z
eencae 0:d563e74f0ae9 254 0x00, 0x08, 0x36, 0x41, 0x00,// {
eencae 0:d563e74f0ae9 255 0x00, 0x00, 0x7F, 0x00, 0x00,// |
eencae 0:d563e74f0ae9 256 0x00, 0x41, 0x36, 0x08, 0x00,// }
eencae 0:d563e74f0ae9 257 0x08, 0x08, 0x2A, 0x1C, 0x08,// ->
eencae 0:d563e74f0ae9 258 0x08, 0x1C, 0x2A, 0x08, 0x08 // <-
eencae 0:d563e74f0ae9 259 };
eencae 0:d563e74f0ae9 260
eencae 0:d563e74f0ae9 261 #endif