Emir Sokic / N5110

Simple library for interfacing to Nokia 5110 LCD display (as found on the SparkFun website). - koristen softverski SPI umjesto hardverskog

Dependents:   Nokia_FRDM

Fork of N5110 by Craig Evans

N5110.cpp@7:9efee30ed6d3, 2016-05-20 (annotated)

Committer:
esokic
Date:
Fri May 20 23:23:46 2016 +0000
Revision:
7:9efee30ed6d3
Parent:
6:adb79338d40f 
Testni kod za spajanje Nokia displeja sa Freeescale FRDM razvojnim sistemom

Who changed what in which revision?

UserRevisionLine numberNew contents of line
eencae 5:6ea180eef702 1 /**
eencae 5:6ea180eef702 2 @file N5110.cpp
eencae 5:6ea180eef702 3
eencae 5:6ea180eef702 4 @brief Member functions implementations
eencae 5:6ea180eef702 5
eencae 5:6ea180eef702 6 */
eencae 0:d563e74f0ae9 7 #include "mbed.h"
eencae 0:d563e74f0ae9 8 #include "N5110.h"
esokic 7:9efee30ed6d3 9 #include "SWSPI.h"
eencae 2:e93021cfb0a9 10
eencae 1:df68f34cd32d 11 N5110::N5110(PinName pwrPin, PinName scePin, PinName rstPin, PinName dcPin, PinName mosiPin, PinName sclkPin, PinName ledPin)
eencae 0:d563e74f0ae9 12 {
eencae 0:d563e74f0ae9 13
esokic 7:9efee30ed6d3 14 //spi = new SPI(mosiPin,NC,sclkPin); // create new SPI instance and initialise
esokic 7:9efee30ed6d3 15 spi = new SWSPI(mosiPin,PTC0,sclkPin); // create new SPI instance and initialise
esokic 7:9efee30ed6d3 16
eencae 0:d563e74f0ae9 17 initSPI();
eencae 0:d563e74f0ae9 18
eencae 6:adb79338d40f 19 // set up pins as required
eencae 0:d563e74f0ae9 20 led = new PwmOut(ledPin);
eencae 0:d563e74f0ae9 21 pwr = new DigitalOut(pwrPin);
eencae 0:d563e74f0ae9 22 sce = new DigitalOut(scePin);
eencae 0:d563e74f0ae9 23 rst = new DigitalOut(rstPin);
eencae 0:d563e74f0ae9 24 dc = new DigitalOut(dcPin);
eencae 0:d563e74f0ae9 25
eencae 0:d563e74f0ae9 26 }
eencae 0:d563e74f0ae9 27
eencae 6:adb79338d40f 28 // initialise function - powers up and sends the initialisation commands
eencae 0:d563e74f0ae9 29 void N5110::init()
eencae 0:d563e74f0ae9 30 {
eencae 6:adb79338d40f 31 turnOn(); // power up
eencae 6:adb79338d40f 32 wait_ms(10); // small delay seems to prevent spurious pixels during mbed reset
eencae 6:adb79338d40f 33 reset(); // reset LCD - must be done within 100 ms
eencae 0:d563e74f0ae9 34
eencae 0:d563e74f0ae9 35 // function set - extended
eencae 0:d563e74f0ae9 36 sendCommand(0x20 | CMD_FS_ACTIVE_MODE | CMD_FS_HORIZONTAL_MODE | CMD_FS_EXTENDED_MODE);
eencae 6:adb79338d40f 37 // Don't completely understand these parameters - they seem to work as they are
eencae 6:adb79338d40f 38 // Consult the datasheet if you need to change them
eencae 1:df68f34cd32d 39 sendCommand(CMD_VOP_7V38); // operating voltage - these values are from Chris Yan's Library
eencae 0:d563e74f0ae9 40 sendCommand(CMD_TC_TEMP_2); // temperature control
eencae 0:d563e74f0ae9 41 sendCommand(CMD_BI_MUX_48); // bias
eencae 0:d563e74f0ae9 42
eencae 0:d563e74f0ae9 43 // function set - basic
eencae 0:d563e74f0ae9 44 sendCommand(0x20 | CMD_FS_ACTIVE_MODE | CMD_FS_HORIZONTAL_MODE | CMD_FS_BASIC_MODE);
eencae 1:df68f34cd32d 45 normalMode(); // normal video mode by default
eencae 0:d563e74f0ae9 46 sendCommand(CMD_DC_NORMAL_MODE); // black on white
eencae 0:d563e74f0ae9 47
eencae 0:d563e74f0ae9 48 // RAM is undefined at power-up so clear
eencae 0:d563e74f0ae9 49 clearRAM();
eencae 0:d563e74f0ae9 50
eencae 0:d563e74f0ae9 51 }
eencae 1:df68f34cd32d 52
eencae 1:df68f34cd32d 53 // sets normal video mode (black on white)
eencae 1:df68f34cd32d 54 void N5110::normalMode() {
eencae 1:df68f34cd32d 55 sendCommand(CMD_DC_NORMAL_MODE);
eencae 1:df68f34cd32d 56
eencae 1:df68f34cd32d 57 }
eencae 1:df68f34cd32d 58
eencae 1:df68f34cd32d 59 // sets normal video mode (white on black)
eencae 1:df68f34cd32d 60 void N5110::inverseMode() {
eencae 1:df68f34cd32d 61 sendCommand(CMD_DC_INVERT_VIDEO);
eencae 1:df68f34cd32d 62 }
eencae 0:d563e74f0ae9 63
eencae 0:d563e74f0ae9 64 // function to power up the LCD and backlight
eencae 0:d563e74f0ae9 65 void N5110::turnOn()
eencae 0:d563e74f0ae9 66 {
eencae 0:d563e74f0ae9 67 // set brightness of LED - 0.0 to 1.0 - default is 50%
eencae 0:d563e74f0ae9 68 setBrightness(0.5);
eencae 0:d563e74f0ae9 69 pwr->write(1); // apply power
eencae 0:d563e74f0ae9 70 }
eencae 0:d563e74f0ae9 71
eencae 0:d563e74f0ae9 72 // function to power down LCD
eencae 0:d563e74f0ae9 73 void N5110::turnOff()
eencae 0:d563e74f0ae9 74 {
eencae 0:d563e74f0ae9 75 setBrightness(0.0); // turn backlight off
eencae 0:d563e74f0ae9 76 clearRAM(); // clear RAM to ensure specified current consumption
eencae 6:adb79338d40f 77 // send command to ensure we are in basic model
eencae 0:d563e74f0ae9 78 sendCommand(0x20 | CMD_FS_ACTIVE_MODE | CMD_FS_HORIZONTAL_MODE | CMD_FS_BASIC_MODE);
eencae 6:adb79338d40f 79 // clear the display
eencae 0:d563e74f0ae9 80 sendCommand(CMD_DC_CLEAR_DISPLAY);
eencae 6:adb79338d40f 81 // enter the extended mode and power down
eencae 0:d563e74f0ae9 82 sendCommand(0x20 | CMD_FS_POWER_DOWN_MODE | CMD_FS_HORIZONTAL_MODE | CMD_FS_EXTENDED_MODE);
eencae 6:adb79338d40f 83 // small delay and then turn off the power pin
eencae 6:adb79338d40f 84 wait_ms(10);
eencae 0:d563e74f0ae9 85 pwr->write(0);
eencae 0:d563e74f0ae9 86
eencae 0:d563e74f0ae9 87 }
eencae 0:d563e74f0ae9 88
eencae 0:d563e74f0ae9 89 // function to change LED backlight brightness
eencae 0:d563e74f0ae9 90 void N5110::setBrightness(float brightness)
eencae 0:d563e74f0ae9 91 {
eencae 0:d563e74f0ae9 92 // check whether brightness is within range
eencae 0:d563e74f0ae9 93 if (brightness < 0.0)
eencae 0:d563e74f0ae9 94 brightness = 0.0;
eencae 0:d563e74f0ae9 95 if (brightness > 1.0)
eencae 0:d563e74f0ae9 96 brightness = 1.0;
eencae 0:d563e74f0ae9 97 // set PWM duty cycle
eencae 0:d563e74f0ae9 98 led->write(brightness);
eencae 0:d563e74f0ae9 99 }
eencae 0:d563e74f0ae9 100
eencae 0:d563e74f0ae9 101
eencae 0:d563e74f0ae9 102 // pulse the active low reset line
eencae 0:d563e74f0ae9 103 void N5110::reset()
eencae 0:d563e74f0ae9 104 {
eencae 0:d563e74f0ae9 105 rst->write(0); // reset the LCD
eencae 0:d563e74f0ae9 106 rst->write(1);
eencae 0:d563e74f0ae9 107 }
eencae 0:d563e74f0ae9 108
eencae 0:d563e74f0ae9 109 // function to initialise SPI peripheral
eencae 0:d563e74f0ae9 110 void N5110::initSPI()
eencae 0:d563e74f0ae9 111 {
esokic 7:9efee30ed6d3 112 //spi->format(8,1); // 8 bits, Mode 1 - polarity 0, phase 1 - base value of clock is 0, data captured on falling edge/propagated on rising edge
eencae 0:d563e74f0ae9 113 spi->format(8,1); // 8 bits, Mode 1 - polarity 0, phase 1 - base value of clock is 0, data captured on falling edge/propagated on rising edge
esokic 7:9efee30ed6d3 114
eencae 0:d563e74f0ae9 115 spi->frequency(4000000); // maximum of screen is 4 MHz
eencae 0:d563e74f0ae9 116 }
eencae 0:d563e74f0ae9 117
eencae 6:adb79338d40f 118 // send a command to the display
eencae 0:d563e74f0ae9 119 void N5110::sendCommand(unsigned char command)
eencae 0:d563e74f0ae9 120 {
eencae 0:d563e74f0ae9 121 dc->write(0); // set DC low for command
eencae 0:d563e74f0ae9 122 sce->write(0); // set CE low to begin frame
eencae 0:d563e74f0ae9 123 spi->write(command); // send command
eencae 0:d563e74f0ae9 124 dc->write(1); // turn back to data by default
eencae 0:d563e74f0ae9 125 sce->write(1); // set CE high to end frame (expected for transmission of single byte)
eencae 0:d563e74f0ae9 126
eencae 0:d563e74f0ae9 127 }
eencae 0:d563e74f0ae9 128
eencae 6:adb79338d40f 129 // send data to the display at the current XY address
eencae 6:adb79338d40f 130 // dc is set to 1 (i.e. data) after sending a command and so should
eencae 6:adb79338d40f 131 // be the default mode.
eencae 0:d563e74f0ae9 132 void N5110::sendData(unsigned char data)
eencae 0:d563e74f0ae9 133 {
eencae 0:d563e74f0ae9 134 sce->write(0); // set CE low to begin frame
eencae 0:d563e74f0ae9 135 spi->write(data);
eencae 0:d563e74f0ae9 136 sce->write(1); // set CE high to end frame (expected for transmission of single byte)
eencae 0:d563e74f0ae9 137 }
eencae 0:d563e74f0ae9 138
eencae 0:d563e74f0ae9 139 // this function writes 0 to the 504 bytes to clear the RAM
eencae 0:d563e74f0ae9 140 void N5110::clearRAM()
eencae 0:d563e74f0ae9 141 {
eencae 0:d563e74f0ae9 142 int i;
eencae 0:d563e74f0ae9 143 sce->write(0); //set CE low to begin frame
eencae 0:d563e74f0ae9 144 for(i = 0; i < 504; i++) { // 48 x 84 bits = 504 bytes
eencae 0:d563e74f0ae9 145 spi->write(0x00); // send 0's
eencae 0:d563e74f0ae9 146 }
eencae 0:d563e74f0ae9 147 sce->write(1); // set CE high to end frame
eencae 0:d563e74f0ae9 148
eencae 0:d563e74f0ae9 149 }
eencae 0:d563e74f0ae9 150
eencae 6:adb79338d40f 151 // function to set the XY address in RAM for subsequenct data write
eencae 0:d563e74f0ae9 152 void N5110::setXYAddress(int x, int y)
eencae 0:d563e74f0ae9 153 {
eencae 0:d563e74f0ae9 154 // check whether address is in range
eencae 0:d563e74f0ae9 155 if (x > 83)
eencae 0:d563e74f0ae9 156 x=83;
eencae 0:d563e74f0ae9 157 if (y > 5)
eencae 0:d563e74f0ae9 158 y=5;
eencae 3:f90dd1042d17 159 if (x < 0)
eencae 3:f90dd1042d17 160 x=0;
eencae 3:f90dd1042d17 161 if (y < 0)
eencae 3:f90dd1042d17 162 y=0;
eencae 0:d563e74f0ae9 163
eencae 3:f90dd1042d17 164 sendCommand(0x80 | x); // send addresses to display with relevant mask
eencae 0:d563e74f0ae9 165 sendCommand(0x40 | y);
eencae 0:d563e74f0ae9 166 }
eencae 0:d563e74f0ae9 167
eencae 6:adb79338d40f 168 // These functions are used to set, clear and get the value of pixels in the display
eencae 6:adb79338d40f 169 // Pixels are addressed in the range of 0 to 47 (y) and 0 to 83 (x). The refresh()
eencae 6:adb79338d40f 170 // function must be called after set and clear in order to update the display
eencae 0:d563e74f0ae9 171 void N5110::setPixel(int x, int y)
eencae 0:d563e74f0ae9 172 {
eencae 6:adb79338d40f 173 // calculate bank and shift 1 to required position in the data byte
eencae 0:d563e74f0ae9 174 buffer[x][y/8] |= (1 << y%8);
eencae 0:d563e74f0ae9 175 }
eencae 0:d563e74f0ae9 176
eencae 0:d563e74f0ae9 177 void N5110::clearPixel(int x, int y)
eencae 0:d563e74f0ae9 178 {
eencae 0:d563e74f0ae9 179 // calculate bank and shift 1 to required position (using bit clear)
eencae 0:d563e74f0ae9 180 buffer[x][y/8] &= ~(1 << y%8);
eencae 0:d563e74f0ae9 181 }
eencae 0:d563e74f0ae9 182
eencae 0:d563e74f0ae9 183 unsigned char N5110::getPixel(int x, int y)
eencae 0:d563e74f0ae9 184 {
eencae 0:d563e74f0ae9 185 // return relevant bank and mask required bit
eencae 0:d563e74f0ae9 186 return buffer[x][y/8] & (1 << y%8);
eencae 0:d563e74f0ae9 187
eencae 0:d563e74f0ae9 188 }
eencae 0:d563e74f0ae9 189
eencae 6:adb79338d40f 190 // function to refresh the display
eencae 6:adb79338d40f 191 void N5110::refresh()
eencae 0:d563e74f0ae9 192 {
eencae 0:d563e74f0ae9 193 int i,j;
eencae 0:d563e74f0ae9 194 sce->write(0); //set CE low to begin frame
eencae 0:d563e74f0ae9 195
eencae 0:d563e74f0ae9 196 for(j = 0; j < 6; j++) { // be careful to use correct order (j,i) for horizontal addressing
eencae 0:d563e74f0ae9 197 for(i = 0; i < 84; i++) {
eencae 0:d563e74f0ae9 198 spi->write(buffer[i][j]); // send buffer
eencae 0:d563e74f0ae9 199 }
eencae 0:d563e74f0ae9 200 }
eencae 0:d563e74f0ae9 201 sce->write(1); // set CE high to end frame
eencae 0:d563e74f0ae9 202
eencae 0:d563e74f0ae9 203 }
eencae 0:d563e74f0ae9 204
eencae 6:adb79338d40f 205 // fills the buffer with random bytes. Can be used to test the display.
eencae 6:adb79338d40f 206 // The rand() function isn't seeded so it probably creates the same pattern everytime
eencae 0:d563e74f0ae9 207 void N5110::randomiseBuffer()
eencae 0:d563e74f0ae9 208 {
eencae 0:d563e74f0ae9 209 int i,j;
eencae 0:d563e74f0ae9 210 for(j = 0; j < 6; j++) { // be careful to use correct order (j,i) for horizontal addressing
eencae 0:d563e74f0ae9 211 for(i = 0; i < 84; i++) {
eencae 0:d563e74f0ae9 212 buffer[i][j] = rand()%256; // generate random byte
eencae 0:d563e74f0ae9 213 }
eencae 0:d563e74f0ae9 214 }
eencae 0:d563e74f0ae9 215
eencae 0:d563e74f0ae9 216 }
eencae 0:d563e74f0ae9 217
eencae 0:d563e74f0ae9 218 // function to print 5x7 font
eencae 0:d563e74f0ae9 219 void N5110::printChar(char c)
eencae 0:d563e74f0ae9 220 {
eencae 6:adb79338d40f 221 int i;
eencae 0:d563e74f0ae9 222 // loop through 5 columns
eencae 6:adb79338d40f 223 for (i = 0; i < 5 ; i++ ) {
eencae 6:adb79338d40f 224 sendData(font5x7[(c - 32)*5 + i]);
eencae 0:d563e74f0ae9 225 // array is offset by 32 relative to ASCII, each character is 5 pixels wide
eencae 6:adb79338d40f 226 // the X address is automatically incremented after each data write
eencae 0:d563e74f0ae9 227 }
eencae 1:df68f34cd32d 228 sendData(0); // send an empty byte to introduce space between characters
eencae 0:d563e74f0ae9 229
eencae 0:d563e74f0ae9 230 }
eencae 0:d563e74f0ae9 231
eencae 0:d563e74f0ae9 232 // function to print string at specified position
eencae 0:d563e74f0ae9 233 void N5110::printString(const char * str,int x,int y)
eencae 0:d563e74f0ae9 234 {
eencae 0:d563e74f0ae9 235 int n = 0 ; // counter for number of characters in string
eencae 0:d563e74f0ae9 236 // loop through string and print character
eencae 0:d563e74f0ae9 237 while(*str) {
eencae 0:d563e74f0ae9 238
eencae 0:d563e74f0ae9 239 setXYAddress(x+6*n,y); // leave 1 pixel (6 = 5 + 1) between each character
eencae 6:adb79338d40f 240 printChar(*str); // print the char - can probably so *str++ and remove next line
eencae 0:d563e74f0ae9 241 str++; // go to next character in string
eencae 0:d563e74f0ae9 242 n++; // increment index
eencae 0:d563e74f0ae9 243 }
eencae 0:d563e74f0ae9 244
eencae 0:d563e74f0ae9 245 }
eencae 0:d563e74f0ae9 246
eencae 6:adb79338d40f 247 // function to clear the screen
eencae 0:d563e74f0ae9 248 void N5110::clear()
eencae 0:d563e74f0ae9 249 {
eencae 6:adb79338d40f 250 clearBuffer(); // clear the buffer then call the refresh function
eencae 6:adb79338d40f 251 refresh();
eencae 0:d563e74f0ae9 252 }
eencae 0:d563e74f0ae9 253
eencae 6:adb79338d40f 254 // function to clear the buffer
eencae 0:d563e74f0ae9 255 void N5110::clearBuffer()
eencae 0:d563e74f0ae9 256 {
eencae 0:d563e74f0ae9 257 int i,j;
eencae 6:adb79338d40f 258 for (i=0; i<84; i++) { // loop through the banks and set the buffer to 0
eencae 0:d563e74f0ae9 259 for (j=0; j<6; j++) {
eencae 0:d563e74f0ae9 260 buffer[i][j]=0;
eencae 0:d563e74f0ae9 261 }
eencae 0:d563e74f0ae9 262 }
eencae 0:d563e74f0ae9 263 }