N5110.h

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