N5110.h

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