N5110 Library for "Racing Cars" Game
Fork of N5110 by
Embed:
(wiki syntax)
Show/hide line numbers
N5110.h
Go to the documentation of this file.
00001 /** 00002 @file N5110.h 00003 00004 @brief Header file containing member functions and variables 00005 00006 */ 00007 00008 #ifndef N5110_H 00009 #define N5110_H 00010 00011 // Command Bytes - taken from Chris Yan's library 00012 // More information can be found in the display datasheet 00013 // H = 0 - Basic instructions 00014 #define CMD_DC_CLEAR_DISPLAY 0x08 00015 #define CMD_DC_NORMAL_MODE 0x0C 00016 #define CMD_DC_FILL_DISPLAY 0x09 00017 #define CMD_DC_INVERT_VIDEO 0x0D 00018 #define CMD_FS_HORIZONTAL_MODE 0x00 00019 #define CMD_FS_VERTICAL_MODE 0x02 00020 #define CMD_FS_BASIC_MODE 0x00 00021 #define CMD_FS_EXTENDED_MODE 0x01 00022 #define CMD_FS_ACTIVE_MODE 0x00 00023 #define CMD_FS_POWER_DOWN_MODE 0x04 00024 // H = 1 - Extended instructions 00025 #define CMD_TC_TEMP_0 0x04 00026 #define CMD_TC_TEMP_1 0x05 00027 #define CMD_TC_TEMP_2 0x06 00028 #define CMD_TC_TEMP_3 0x07 00029 #define CMD_BI_MUX_24 0x15 00030 #define CMD_BI_MUX_48 0x13 00031 #define CMD_BI_MUX_100 0x10 00032 #define CMD_VOP_6V06 0xB2 00033 #define CMD_VOP_7V38 0xC8 00034 00035 // number of pixels on display 00036 #define WIDTH 84 00037 #define HEIGHT 48 00038 #define BANKS 6 00039 00040 #include "mbed.h" 00041 00042 /** 00043 @brief Library for interfacing with Nokia 5110 LCD display (https://www.sparkfun.com/products/10168) using the hardware SPI on the mbed. 00044 @brief 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). 00045 @brief Can print characters and strings to the display using the included 5x7 font. 00046 @brief The library also implements a screen buffer so that individual pixels on the display (84 x 48) can be set, cleared and read. 00047 @brief The library can print primitive shapes (lines, circles, rectangles) 00048 @brief Acknowledgements to Chris Yan's Nokia_5110 Library. 00049 00050 @brief Revision 1.2 00051 00052 @author Craig A. Evans 00053 @date 17th March 2015 00054 * 00055 * Example: 00056 * @code 00057 00058 #include "mbed.h" 00059 #include "N5110.h" 00060 00061 // VCC,SCE,RST,D/C,MOSI,SCLK,LED 00062 N5110 lcd(p7,p8,p9,p10,p11,p13,p21); 00063 // Can also power (VCC) directly from VOUT (3.3 V) - 00064 // Can give better performance due to current limitation from GPIO pin 00065 00066 int main() 00067 { 00068 // first need to initialise display 00069 lcd.init(); 00070 00071 while(1) { 00072 00073 // these are default settings so not strictly needed 00074 lcd.normalMode(); // normal colour mode 00075 lcd.setBrightness(0.5); // put LED backlight on 50% 00076 00077 // can directly print strings at specified co-ordinates 00078 lcd.printString("Hello, World!",0,0); 00079 00080 char buffer[14]; // each character is 6 pixels wide, screen is 84 pixels (84/6 = 14) 00081 // so can display a string of a maximum 14 characters in length 00082 // or create formatted strings - ensure they aren't more than 14 characters long 00083 int temperature = 27; 00084 int length = sprintf(buffer,"T = %2d C",temperature); // print formatted data to buffer 00085 // it is important the format specifier ensures the length will fit in the buffer 00086 if (length <= 14) // if string will fit on display 00087 lcd.printString(buffer,0,1); // display on screen 00088 00089 float pressure = 1012.3; // same idea with floats 00090 length = sprintf(buffer,"P = %.2f mb",pressure); 00091 if (length <= 14) 00092 lcd.printString(buffer,0,2); 00093 00094 // can also print individual characters at specified place 00095 lcd.printChar('X',5,3); 00096 00097 // draw a line across the display at y = 40 pixels (origin top-left) 00098 for (int i = 0; i < WIDTH; i++) { 00099 lcd.setPixel(i,40); 00100 } 00101 // need to refresh display after setting pixels 00102 lcd.refresh(); 00103 00104 // can also check status of pixels using getPixel(x,y) 00105 00106 wait(5.0); 00107 lcd.clear(); // clear display 00108 lcd.inverseMode(); // invert colours 00109 lcd.setBrightness(1.0); // put LED backlight on full 00110 00111 float array[84]; 00112 00113 for (int i = 0; i < 84; i++) { 00114 array[i] = 0.5 + 0.5*sin(i*2*3.14/84); 00115 } 00116 00117 // can also plot graphs - 84 elements only 00118 // values must be in range 0.0 - 1.0 00119 lcd.plotArray(array); 00120 wait(5.0); 00121 lcd.clear(); 00122 lcd.normalMode(); // normal colour mode back 00123 lcd.setBrightness(0.5); // put LED backlight on 50% 00124 00125 // example of drawing lines 00126 for (int x = 0; x < WIDTH ; x+=10) { 00127 // x0,y0,x1,y1,type 0-white,1-black,2-dotted 00128 lcd.drawLine(0,0,x,HEIGHT,2); 00129 } 00130 00131 wait(5.0); 00132 lcd.clear(); 00133 00134 // example of how to draw circles 00135 lcd.drawCircle(WIDTH/2,HEIGHT/2,20,1); // x,y,radius,black fill 00136 lcd.drawCircle(WIDTH/2,HEIGHT/2,10,2); // x,y,radius,white fill 00137 lcd.drawCircle(WIDTH/2,HEIGHT/2,30,0); // x,y,radius,transparent with outline 00138 00139 wait(5.0); 00140 lcd.clear(); 00141 00142 // example of how to draw rectangles 00143 // origin x,y,width,height,type 00144 lcd.drawRect(10,10,50,30,1); // filled black rectangle 00145 lcd.drawRect(15,15,20,10,2); // filled white rectange (no outline) 00146 lcd.drawRect(2,2,70,40,0); // transparent, just outline 00147 00148 wait(5.0); 00149 lcd.clear(); 00150 00151 } 00152 } 00153 00154 00155 * @endcode 00156 */ 00157 class N5110 00158 { 00159 00160 public: 00161 /** Create a N5110 object connected to the specified pins 00162 * 00163 * @param pwr Pin connected to Vcc on the LCD display (pin 1) 00164 * @param sce Pin connected to chip enable (pin 3) 00165 * @param rst Pin connected to reset (pin 4) 00166 * @param dc Pin connected to data/command select (pin 5) 00167 * @param mosi Pin connected to data input (MOSI) (pin 6) 00168 * @param sclk Pin connected to serial clock (SCLK) (pin 7) 00169 * @param led Pin connected to LED backlight (must be PWM) (pin 8) 00170 * 00171 */ 00172 N5110(PinName pwrPin, PinName scePin, PinName rstPin, PinName dcPin, PinName mosiPin, PinName sclkPin, PinName ledPin); 00173 00174 /** Initialise display 00175 * 00176 * Powers up the display and turns on backlight (50% brightness default). 00177 * Sets the display up in horizontal addressing mode and with normal video mode. 00178 */ 00179 void init(); 00180 00181 /** Turn off 00182 * 00183 * Powers down the display and turns of the backlight. 00184 * Needs to be reinitialised before being re-used. 00185 */ 00186 void turnOff(); 00187 00188 /** Clears 00189 * 00190 * Clears the screen. 00191 */ 00192 void clear(); 00193 00194 /** Turn on normal video mode (default) 00195 * Black on white 00196 */ 00197 void normalMode(); 00198 00199 /** Turn on inverse video mode (default) 00200 * White on black 00201 */ 00202 void inverseMode(); 00203 00204 /** Set Brightness 00205 * 00206 * Sets brightness of LED backlight. 00207 * @param brightness - float in range 0.0 to 1.0 00208 */ 00209 void setBrightness(float brightness); 00210 00211 /** Print String 00212 * 00213 * Prints a string of characters to the display. 00214 * @param x - the column number (0 to 83) 00215 * @param y - the row number (0 to 5) - the display is split into 6 banks - each bank can be considered a row 00216 */ 00217 void printString(const char * str,int x,int y); 00218 00219 /** Print Character 00220 * 00221 * Sends a character to the display. Printed at the specified location 00222 * @param c - the character to print. Can print ASCII as so printChar('C'). 00223 * @param x - the column number (0 to 83) 00224 * @param y - the row number (0 to 5) - the display is split into 6 banks - each bank can be considered a row 00225 */ 00226 void printChar(char c,int x,int y); 00227 00228 /** Set a Pixel 00229 * 00230 * This function sets a pixel in the display. A call to refresh() must be made 00231 * to update the display to reflect the change in pixels. 00232 * @param x - the x co-ordinate of the pixel (0 to 83) 00233 * @param y - the y co-ordinate of the pixel (0 to 47) 00234 */ 00235 void setPixel(int x, int y); 00236 00237 /** Clear a Pixel 00238 * 00239 * This function clears pixel in the display. A call to refresh() must be made 00240 * to update the display to reflect the change in pixels. 00241 * @param x - the x co-ordinate of the pixel (0 to 83) 00242 * @param y - the y co-ordinate of the pixel (0 to 47) 00243 */ 00244 void clearPixel(int x, int y); 00245 00246 /** Get a Pixel 00247 * 00248 * This function gets the status of a pixel in the display. 00249 * @param x - the x co-ordinate of the pixel (0 to 83) 00250 * @param y - the y co-ordinate of the pixel (0 to 47) 00251 * @returns 00252 * 0 - pixel is clear 00253 * non-zero - pixel is set 00254 */ 00255 int getPixel(int x, int y); 00256 00257 /** Refresh display 00258 * 00259 * This functions refreshes the display to reflect the current data in the buffer. 00260 */ 00261 void refresh(); 00262 00263 /** Randomise buffer 00264 * 00265 * This function fills the buffer with random data. Can be used to test the display. 00266 * A call to refresh() must be made to update the display to reflect the change in pixels. 00267 * The seed is not set and so the generated pattern will probably be the same each time. 00268 * TODO: Randomise the seed - maybe using the noise on the AnalogIn pins. 00269 */ 00270 void randomiseBuffer(); 00271 00272 /** Plot Array 00273 * 00274 * This function plots a one-dimensional array on the display. 00275 * @param array[] - y values of the plot. Values should be normalised in the range 0.0 to 1.0. First 84 plotted. 00276 */ 00277 void plotArray(float array[]); 00278 00279 /** Draw Circle 00280 * 00281 * This function draws a circle at the specified origin with specified radius to the display. 00282 * Uses the midpoint circle algorithm. 00283 * @see http://en.wikipedia.org/wiki/Midpoint_circle_algorithm 00284 * @param x0 - x-coordinate of centre 00285 * @param y0 - y-coordinate of centre 00286 * @param radius - radius of circle in pixels 00287 * @param fill - 0 transparent (w/outline), 1 filled black, 2 filled white (wo/outline) 00288 */ 00289 void drawCircle(int x0,int y0,int radius,int fill); 00290 00291 /** Draw Line 00292 * 00293 * This function draws a line between the specified points using linear interpolation. 00294 * @param x0 - x-coordinate of first point 00295 * @param y0 - y-coordinate of first point 00296 * @param x1 - x-coordinate of last point 00297 * @param y1 - y-coordinate of last point 00298 * @param type - 0 white,1 black,2 dotted 00299 */ 00300 void drawLine(int x0,int y0,int x1,int y1,int type); 00301 00302 /** Draw Rectangle 00303 * 00304 * This function draws a rectangle. 00305 * @param x0 - x-coordinate of origin (top-left) 00306 * @param y0 - y-coordinate of origin (top-left) 00307 * @param width - width of rectangle 00308 * @param height - height of rectangle 00309 * @param fill - 0 transparent (w/outline), 1 filled black, 2 filled white (wo/outline) 00310 */ 00311 void drawRect(int x0,int y0,int width,int height,int fill); 00312 00313 00314 /** Set Game Lanes 00315 * 00316 * This function sets the Lanes and boundaries of the game 00317 */ 00318 void gameLanes(); 00319 00320 00321 /** Set XY Address 00322 * 00323 * Sets the X and Y address of where the next data sent to the displa will be written in RAM. 00324 * @param x - the column number (0 to 83) - is automatically incremented after data is written 00325 * @param y - the row number (0 to 5) - the diplay is split into 6 banks - each bank can be considered a row 00326 */ 00327 void setXYAddress(int x, int y); 00328 00329 00330 /** Clear Circle 00331 * 00332 * This function clears a circle at the specified origin with specified radius to the display. 00333 * Uses the midpoint circle algorithm. 00334 * @see http://en.wikipedia.org/wiki/Midpoint_circle_algorithm 00335 * @param x0 - x-coordinate of centre 00336 * @param y0 - y-coordinate of centre 00337 * @param radius - radius of circle in pixels 00338 * @param fill - 0 transparent (w/outline), 1 filled black, 2 filled white (wo/outline) 00339 */ 00340 void clearCircle(int x0,int y0,int radius,int fill); 00341 00342 00343 /** Clear Line 00344 * 00345 * This function clears an existing line between the specified points using linear interpolation. 00346 * @param x0 - x-coordinate of first point 00347 * @param y0 - y-coordinate of first point 00348 * @param x1 - x-coordinate of last point 00349 * @param y1 - y-coordinate of last point 00350 * @param type - 0 white,1 black,2 dotted 00351 */ 00352 void clearLine(int x0,int y0,int x1,int y1,int type); 00353 00354 00355 private: 00356 00357 void initSPI(); 00358 void turnOn(); 00359 void reset(); 00360 void clearRAM(); 00361 void clearBuffer(); 00362 void sendCommand(unsigned char command); 00363 void sendData(unsigned char data); 00364 00365 public: 00366 unsigned char buffer[84][6]; // screen buffer - the 6 is for the banks - each one is 8 bits; 00367 00368 private: // private variables 00369 SPI* spi; 00370 PwmOut* led; 00371 DigitalOut* pwr; 00372 DigitalOut* sce; 00373 DigitalOut* rst; 00374 DigitalOut* dc; 00375 00376 }; 00377 00378 const unsigned char font5x7[480] = { 00379 0x00, 0x00, 0x00, 0x00, 0x00,// (space) 00380 0x00, 0x00, 0x5F, 0x00, 0x00,// ! 00381 0x00, 0x07, 0x00, 0x07, 0x00,// " 00382 0x14, 0x7F, 0x14, 0x7F, 0x14,// # 00383 0x24, 0x2A, 0x7F, 0x2A, 0x12,// $ 00384 0x23, 0x13, 0x08, 0x64, 0x62,// % 00385 0x36, 0x49, 0x55, 0x22, 0x50,// & 00386 0x00, 0x05, 0x03, 0x00, 0x00,// ' 00387 0x00, 0x1C, 0x22, 0x41, 0x00,// ( 00388 0x00, 0x41, 0x22, 0x1C, 0x00,// ) 00389 0x08, 0x2A, 0x1C, 0x2A, 0x08,// * 00390 0x08, 0x08, 0x3E, 0x08, 0x08,// + 00391 0x00, 0x50, 0x30, 0x00, 0x00,// , 00392 0x08, 0x08, 0x08, 0x08, 0x08,// - 00393 0x00, 0x60, 0x60, 0x00, 0x00,// . 00394 0x20, 0x10, 0x08, 0x04, 0x02,// / 00395 0x3E, 0x51, 0x49, 0x45, 0x3E,// 0 00396 0x00, 0x42, 0x7F, 0x40, 0x00,// 1 00397 0x42, 0x61, 0x51, 0x49, 0x46,// 2 00398 0x21, 0x41, 0x45, 0x4B, 0x31,// 3 00399 0x18, 0x14, 0x12, 0x7F, 0x10,// 4 00400 0x27, 0x45, 0x45, 0x45, 0x39,// 5 00401 0x3C, 0x4A, 0x49, 0x49, 0x30,// 6 00402 0x01, 0x71, 0x09, 0x05, 0x03,// 7 00403 0x36, 0x49, 0x49, 0x49, 0x36,// 8 00404 0x06, 0x49, 0x49, 0x29, 0x1E,// 9 00405 0x00, 0x36, 0x36, 0x00, 0x00,// : 00406 0x00, 0x56, 0x36, 0x00, 0x00,// ; 00407 0x00, 0x08, 0x14, 0x22, 0x41,// < 00408 0x14, 0x14, 0x14, 0x14, 0x14,// = 00409 0x41, 0x22, 0x14, 0x08, 0x00,// > 00410 0x02, 0x01, 0x51, 0x09, 0x06,// ? 00411 0x32, 0x49, 0x79, 0x41, 0x3E,// @ 00412 0x7E, 0x11, 0x11, 0x11, 0x7E,// A 00413 0x7F, 0x49, 0x49, 0x49, 0x36,// B 00414 0x3E, 0x41, 0x41, 0x41, 0x22,// C 00415 0x7F, 0x41, 0x41, 0x22, 0x1C,// D 00416 0x7F, 0x49, 0x49, 0x49, 0x41,// E 00417 0x7F, 0x09, 0x09, 0x01, 0x01,// F 00418 0x3E, 0x41, 0x41, 0x51, 0x32,// G 00419 0x7F, 0x08, 0x08, 0x08, 0x7F,// H 00420 0x00, 0x41, 0x7F, 0x41, 0x00,// I 00421 0x20, 0x40, 0x41, 0x3F, 0x01,// J 00422 0x7F, 0x08, 0x14, 0x22, 0x41,// K 00423 0x7F, 0x40, 0x40, 0x40, 0x40,// L 00424 0x7F, 0x02, 0x04, 0x02, 0x7F,// M 00425 0x7F, 0x04, 0x08, 0x10, 0x7F,// N 00426 0x3E, 0x41, 0x41, 0x41, 0x3E,// O 00427 0x7F, 0x09, 0x09, 0x09, 0x06,// P 00428 0x3E, 0x41, 0x51, 0x21, 0x5E,// Q 00429 0x7F, 0x09, 0x19, 0x29, 0x46,// R 00430 0x46, 0x49, 0x49, 0x49, 0x31,// S 00431 0x01, 0x01, 0x7F, 0x01, 0x01,// T 00432 0x3F, 0x40, 0x40, 0x40, 0x3F,// U 00433 0x1F, 0x20, 0x40, 0x20, 0x1F,// V 00434 0x7F, 0x20, 0x18, 0x20, 0x7F,// W 00435 0x63, 0x14, 0x08, 0x14, 0x63,// X 00436 0x03, 0x04, 0x78, 0x04, 0x03,// Y 00437 0x61, 0x51, 0x49, 0x45, 0x43,// Z 00438 0x00, 0x00, 0x7F, 0x41, 0x41,// [ 00439 0x02, 0x04, 0x08, 0x10, 0x20,// "\" 00440 0x41, 0x41, 0x7F, 0x00, 0x00,// ] 00441 0x04, 0x02, 0x01, 0x02, 0x04,// ^ 00442 0x40, 0x40, 0x40, 0x40, 0x40,// _ 00443 0x00, 0x01, 0x02, 0x04, 0x00,// ` 00444 0x20, 0x54, 0x54, 0x54, 0x78,// a 00445 0x7F, 0x48, 0x44, 0x44, 0x38,// b 00446 0x38, 0x44, 0x44, 0x44, 0x20,// c 00447 0x38, 0x44, 0x44, 0x48, 0x7F,// d 00448 0x38, 0x54, 0x54, 0x54, 0x18,// e 00449 0x08, 0x7E, 0x09, 0x01, 0x02,// f 00450 0x08, 0x14, 0x54, 0x54, 0x3C,// g 00451 0x7F, 0x08, 0x04, 0x04, 0x78,// h 00452 0x00, 0x44, 0x7D, 0x40, 0x00,// i 00453 0x20, 0x40, 0x44, 0x3D, 0x00,// j 00454 0x00, 0x7F, 0x10, 0x28, 0x44,// k 00455 0x00, 0x41, 0x7F, 0x40, 0x00,// l 00456 0x7C, 0x04, 0x18, 0x04, 0x78,// m 00457 0x7C, 0x08, 0x04, 0x04, 0x78,// n 00458 0x38, 0x44, 0x44, 0x44, 0x38,// o 00459 0x7C, 0x14, 0x14, 0x14, 0x08,// p 00460 0x08, 0x14, 0x14, 0x18, 0x7C,// q 00461 0x7C, 0x08, 0x04, 0x04, 0x08,// r 00462 0x48, 0x54, 0x54, 0x54, 0x20,// s 00463 0x04, 0x3F, 0x44, 0x40, 0x20,// t 00464 0x3C, 0x40, 0x40, 0x20, 0x7C,// u 00465 0x1C, 0x20, 0x40, 0x20, 0x1C,// v 00466 0x3C, 0x40, 0x30, 0x40, 0x3C,// w 00467 0x44, 0x28, 0x10, 0x28, 0x44,// x 00468 0x0C, 0x50, 0x50, 0x50, 0x3C,// y 00469 0x44, 0x64, 0x54, 0x4C, 0x44,// z 00470 0x00, 0x08, 0x36, 0x41, 0x00,// { 00471 0x00, 0x00, 0x7F, 0x00, 0x00,// | 00472 0x00, 0x41, 0x36, 0x08, 0x00,// } 00473 0x08, 0x08, 0x2A, 0x1C, 0x08,// -> 00474 0x08, 0x1C, 0x2A, 0x08, 0x08, // <- 00475 00476 }; 00477 00478 #endif
Generated on Thu Jul 21 2022 01:25:55 by 1.7.2