Revision 50:bbb91c37f550, committed 2019-05-06

Comitter:

mztkb

Date:

Mon May 06 09:54:02 2019 +0000

Parent:

49:93355c01e261

Commit message:

New N5110

Changed in this revision

--- a/N5110.cpp	Mon Mar 19 13:44:23 2018 +0000
+++ b/N5110.cpp	Mon May 06 09:54:02 2019 +0000
@@ -1,6 +1,6 @@
 #include "mbed.h"
 #include "N5110.h"
-
+ 
 // overloaded constructor includes power pin - LCD Vcc connected to GPIO pin
 // this constructor works fine with LPC1768 - enough current sourced from GPIO
 // to power LCD. Doesn't work well with K64F.
@@ -19,7 +19,7 @@
     _rst(new DigitalOut(rstPin)),
     _dc(new DigitalOut(dcPin))
 {}
-
+ 
 // overloaded constructor does not include power pin - LCD Vcc must be tied to +3V3
 // Best to use this with K64F as the GPIO hasn't sufficient output current to reliably
 // drive the LCD.
@@ -37,21 +37,21 @@
     _rst(new DigitalOut(rstPin)),
     _dc(new DigitalOut(dcPin))
 {}
-
+ 
 N5110::~N5110()
 {
     delete _spi;
-
+ 
     if(_pwr) {
         delete _pwr;
     }
-
+ 
     delete _led;
     delete _sce;
     delete _rst;
     delete _dc;
 }
-
+ 
 // initialise function - powers up and sends the initialisation commands
 void N5110::init()
 {
@@ -68,21 +68,21 @@
     clear();   // clear buffer
     setBrightness(0.5);
 }
-
+ 
 // sets normal video mode (black on white)
 void N5110::normalMode()
 {
     sendCommand(0b00100000);   // basic instruction
     sendCommand(0b00001100);  // normal video mode- datasheet
 }
-
+ 
 // sets normal video mode (white on black)
 void N5110::inverseMode()
 {
     sendCommand(0b00100000);   // basic instruction
     sendCommand(0b00001101);   // inverse video mode - datasheet
 }
-
+ 
 // function to power up the LCD and backlight - only works when using GPIO to power
 void N5110::turnOn()
 {
@@ -90,7 +90,7 @@
         _pwr->write(1);  // apply power
     }
 }
-
+ 
 // function to power down LCD
 void N5110::turnOff()
 {
@@ -110,9 +110,9 @@
         wait_ms(10);  // small delay and then turn off the power pin
         _pwr->write(0);  // turn off power
     }
-
+ 
 }
-
+ 
 // function to change LED backlight brightness
 void N5110::setBrightness(float brightness)
 {
@@ -124,7 +124,7 @@
     // set PWM duty cycle
     _led->write(brightness);
 }
-
+ 
 void N5110::setContrast(float contrast) {
     
     // enforce limits
@@ -140,7 +140,7 @@
     sendCommand(0b10000000 | ic);   // set Vop (which controls contrast)
     sendCommand(0b00100000);  // back to basic instruction set
 }
-
+ 
 void N5110::setTempCoefficient(char tc) {
     
     // enforce limits
@@ -149,7 +149,7 @@
     }
     
     // temperature coefficient may need increasing at low temperatures
-
+ 
     sendCommand(0b00100001);  // extended instruction set
     sendCommand(0b00000100 | tc);
     sendCommand(0b00100000);  // back to basic instruction set
@@ -177,21 +177,21 @@
     sendCommand(0b00010000 | bias);  
     sendCommand(0b00100000); // end of extended mode instruction
 }
-
+ 
 // pulse the active low reset line
 void N5110::reset()
 {
     _rst->write(0);  // reset the LCD
     _rst->write(1);
 }
-
+ 
 // function to initialise SPI peripheral
 void N5110::initSPI()
 {
     _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
     _spi->frequency(4000000);  // maximum of screen is 4 MHz
 }
-
+ 
 // send a command to the display
 void N5110::sendCommand(unsigned char command)
 {
@@ -201,7 +201,7 @@
     _dc->write(1);  // turn back to data by default
     _sce->write(1); // set CE high to end frame (expected for transmission of single byte)
 }
-
+ 
 // send data to the display at the current XY address
 // dc is set to 1 (i.e. data) after sending a command and so should
 // be the default mode.
@@ -211,7 +211,7 @@
     _spi->write(data);
     _sce->write(1);  // set CE high to end frame (expected for transmission of single byte)
 }
-
+ 
 // this function writes 0 to the 504 bytes to clear the RAM
 void N5110::clearRAM()
 {
@@ -221,7 +221,7 @@
     }
     _sce->write(1); // set CE high to end frame
 }
-
+ 
 // function to set the XY address in RAM for subsequenct data write
 void N5110::setXYAddress(unsigned int const x,
                          unsigned int const y)
@@ -232,7 +232,7 @@
         sendCommand(0b01000000 | y);
     }
 }
-
+ 
 // These functions are used to set, clear and get the value of pixels in the display
 // Pixels are addressed in the range of 0 to 47 (y) and 0 to 83 (x).  The refresh()
 // function must be called after set and clear in order to update the display
@@ -246,7 +246,7 @@
         else      buffer[x][y/8] &= ~(1 << y%8);
     }
 }
-
+ 
 void N5110::clearPixel(unsigned int const x,
                        unsigned int const y)
 {
@@ -255,43 +255,43 @@
         buffer[x][y/8] &= ~(1 << y%8);
     }
 }
-
+ 
 int N5110::getPixel(unsigned int const x,
                     unsigned int const y) const
 {
     if (x<WIDTH && y<HEIGHT) {  // check within range
         // return relevant bank and mask required bit
-
+ 
         int pixel = (int) buffer[x][y/8] & (1 << y%8);
-
+ 
         if (pixel)
             return 1;
         else
             return 0;
     }
-
+ 
     return 0;
-
+ 
 }
-
+ 
 // function to refresh the display
 void N5110::refresh()
 {
     setXYAddress(0,0);  // important to set address back to 0,0 before refreshing display
     // address auto increments after printing string, so buffer[0][0] will not coincide
     // with top-left pixel after priting string
-
+ 
     _sce->write(0);  //set CE low to begin frame
-
+ 
     for(int j = 0; j < BANKS; j++) {  // be careful to use correct order (j,i) for horizontal addressing
         for(int i = 0; i < WIDTH; i++) {
             _spi->write(buffer[i][j]);  // send buffer
         }
     }
     _sce->write(1); // set CE high to end frame
-
+ 
 }
-
+ 
 // fills the buffer with random bytes.  Can be used to test the display.
 // The rand() function isn't seeded so it probably creates the same pattern everytime
 void N5110::randomiseBuffer()
@@ -302,16 +302,16 @@
             buffer[i][j] = rand()%256;  // generate random byte
         }
     }
-
+ 
 }
-
+ 
 // function to print 5x7 font
 void N5110::printChar(char const          c,
                       unsigned int const  x,
                       unsigned int const  y)
 {
     if (y<BANKS) {  // check if printing in range of y banks
-
+ 
         for (int i = 0; i < 5 ; i++ ) {
             int pixel_x = x+i;
             if (pixel_x > WIDTH-1)  // ensure pixel isn't outside the buffer size (0 - 83)
@@ -319,21 +319,21 @@
             buffer[pixel_x][y] = font5x7[(c - 32)*5 + i];
             // array is offset by 32 relative to ASCII, each character is 5 pixels wide
         }
-
+ 
     }
 }
-
+ 
 // function to print string at specified position
 void N5110::printString(const char         *str,
                         unsigned int const  x,
                         unsigned int const  y)
 {
     if (y<BANKS) {  // check if printing in range of y banks
-
+ 
         int n = 0 ; // counter for number of characters in string
         // loop through string and print character
         while(*str) {
-
+ 
             // writes the character bitmap data to the buffer, so that
             // text and pixels can be displayed at the same time
             for (int i = 0; i < 5 ; i++ ) {
@@ -347,13 +347,13 @@
         }
     }
 }
-
+ 
 // function to clear the screen buffer
 void N5110::clear()
 {
     memset(buffer,0,sizeof(buffer));
 }
-
+ 
 // function to plot array on display
 void N5110::plotArray(float const array[])
 {
@@ -363,9 +363,9 @@
         // since top-left is 0,0 in the display geometry
         setPixel(i,47 - int(array[i]*47.0f),true);
     }
-
+ 
 }
-
+ 
 // function to draw circle
 void N5110:: drawCircle(unsigned int const x0,
                         unsigned int const y0,
@@ -376,9 +376,9 @@
     int x = radius;
     int y = 0;
     int radiusError = 1-x;
-
+ 
     while(x >= y) {
-
+ 
         // if transparent, just draw outline
         if (fill == FILL_TRANSPARENT) {
             setPixel( x + x0,  y + y0,true);
@@ -390,15 +390,15 @@
             setPixel( x + x0, -y + y0,true);
             setPixel(-x + x0, -y + y0,true);
         } else {  // drawing filled circle, so draw lines between points at same y value
-
+ 
             int type = (fill==FILL_BLACK) ? 1:0;  // black or white fill
-
+ 
             drawLine(x+x0,y+y0,-x+x0,y+y0,type);
             drawLine(y+x0,x+y0,-y+x0,x+y0,type);
             drawLine(y+x0,-x+y0,-y+x0,-x+y0,type);
             drawLine(x+x0,-y+y0,-x+x0,-y+y0,type);
         }
-
+ 
         y++;
         if (radiusError<0) {
             radiusError += 2 * y + 1;
@@ -407,9 +407,9 @@
             radiusError += 2 * (y - x) + 1;
         }
     }
-
+ 
 }
-
+ 
 void N5110::drawLine(unsigned int const x0,
                      unsigned int const y0,
                      unsigned int const x1,
@@ -420,48 +420,48 @@
     // into signed integers first
     int const y_range = static_cast<int>(y1) - static_cast<int>(y0);
     int const x_range = static_cast<int>(x1) - static_cast<int>(x0);
-
+ 
     // if dotted line, set step to 2, else step is 1
     unsigned int const step = (type==2) ? 2:1;
-
+ 
     // make sure we loop over the largest range to get the most pixels on the display
     // for instance, if drawing a vertical line (x_range = 0), we need to loop down the y pixels
     // or else we'll only end up with 1 pixel in the x column
     if ( abs(x_range) > abs(y_range) ) {
-
+ 
         // ensure we loop from smallest to largest or else for-loop won't run as expected
         unsigned int const start = x_range > 0 ? x0:x1;
         unsigned int const stop =  x_range > 0 ? x1:x0;
-
+ 
         // loop between x pixels
         for (unsigned int x = start; x<= stop ; x+=step) {
             // do linear interpolation
             int const dx = static_cast<int>(x)-static_cast<int>(x0);
             unsigned int const y = y0 + y_range * dx / x_range;
-
+ 
             // If the line type is '0', this will clear the pixel
             // If it is '1' or '2', the pixel will be set
             setPixel(x,y, type);
         }
     } else {
-
+ 
         // ensure we loop from smallest to largest or else for-loop won't run as expected
         unsigned int const start = y_range > 0 ? y0:y1;
         unsigned int const stop =  y_range > 0 ? y1:y0;
-
+ 
         for (unsigned int y = start; y<= stop ; y+=step) {
             // do linear interpolation
             int const dy = static_cast<int>(y)-static_cast<int>(y0);
             unsigned int const x = x0 + x_range * dy / y_range;
-
+ 
             // If the line type is '0', this will clear the pixel
             // If it is '1' or '2', the pixel will be set
             setPixel(x,y, type);
         }
     }
-
+ 
 }
-
+ 
 void N5110::drawRect(unsigned int const x0,
                      unsigned int const y0,
                      unsigned int const width,
@@ -480,7 +480,7 @@
         }
     }
 }
-
+ 
 void N5110::drawSprite(int x0,
                        int y0,
                        int nrows,
@@ -489,7 +489,7 @@
 {
     for (int i = 0; i < nrows; i++) {
         for (int j = 0 ; j < ncols ; j++) {
-
+ 
             int pixel = *((sprite+i*ncols)+j);
             setPixel(x0+j,y0+i, pixel);
         }

--- a/N5110.h	Mon Mar 19 13:44:23 2018 +0000
+++ b/N5110.h	Mon May 06 09:54:02 2019 +0000
@@ -1,20 +1,20 @@
 #ifndef N5110_H
 #define N5110_H
-
+ 
 #include "mbed.h"
-
+ 
 // number of pixels on display
 #define WIDTH 84
 #define HEIGHT 48
 #define BANKS 6
-
+ 
 /// Fill types for 2D shapes
 enum FillType {
     FILL_TRANSPARENT, ///< Transparent with outline
     FILL_BLACK,       ///< Filled black
     FILL_WHITE,       ///< Filled white (no outline)
 };
-
+ 
 /** N5110 Class
 @brief Library for interfacing with Nokia 5110 LCD display (https://www.sparkfun.com/products/10168) using the hardware SPI on the mbed.
 @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).
@@ -22,17 +22,17 @@
 @brief The library also implements a screen buffer so that individual pixels on the display (84 x 48) can be set, cleared and read.
 @brief The library can print primitive shapes (lines, circles, rectangles)
 @brief Acknowledgements to Chris Yan's Nokia_5110 Library.
-
+ 
 @brief Revision 1.3
-
+ 
 @author Craig A. Evans
 @date   7th February 2017
-
+ 
 @code
-
+ 
 #include "mbed.h"
 #include "N5110.h"
-
+ 
 //      rows,cols
 int sprite[8][5] =   {
     { 0,0,1,0,0 },
@@ -44,12 +44,12 @@
     { 1,1,0,1,1 },
     { 1,1,0,1,1 },
 };
-
+ 
 //    VCC,SCE,RST,D/C,MOSI,SCLK,LED
 //N5110 lcd(p7,p8,p9,p10,p11,p13,p21);  // LPC1768 - pwr from GPIO
 N5110 lcd(p8,p9,p10,p11,p13,p21);  // LPC1768 - powered from +3V3 - JP1 in 2/3 position
 //N5110 lcd(PTC9,PTC0,PTC7,PTD2,PTD1,PTC11);  // K64F - pwr from 3V3
-
+ 
 int main()
 {
     // first need to initialise display
@@ -58,23 +58,23 @@
     // change set contrast in range 0.0 to 1.0
     // 0.4 appears to be a good starting point
     lcd.setContrast(0.4);
-
+ 
     while(1) {
-
+ 
         // these are default settings so not strictly needed
         lcd.normalMode();      // normal colour mode
         lcd.setBrightness(0.5); // put LED backlight on 50%
-
+ 
         lcd.clear();
         // x origin, y origin, rows, cols, sprite
         lcd.drawSprite(20,6,8,5,(int *)sprite);
         lcd.refresh();
         wait(5.0);
-
+ 
         lcd.clear(); // clear buffer at start of every loop
         // can directly print strings at specified co-ordinates (must be less than 84 pixels to fit on display)
         lcd.printString("Hello, World!",0,0);
-
+ 
         char buffer[14];  // each character is 6 pixels wide, screen is 84 pixels (84/6 = 14)
         // so can display a string of a maximum 14 characters in length
         // or create formatted strings - ensure they aren't more than 14 characters long
@@ -83,15 +83,15 @@
         // it is important the format specifier ensures the length will fit in the buffer
         if (length <= 14)  // if string will fit on display (assuming printing at x=0)
             lcd.printString(buffer,0,1);           // display on screen
-
+ 
         float pressure = 1012.3;  // same idea with floats
         length = sprintf(buffer,"P = %.2f mb",pressure);
         if (length <= 14)
             lcd.printString(buffer,0,2);
-
+ 
         // can also print individual characters at specified place
         lcd.printChar('X',5,3);
-
+ 
         // draw a line across the display at y = 40 pixels (origin top-left)
         for (int i = 0; i < WIDTH; i++) {
             lcd.setPixel(i,40,true);
@@ -99,51 +99,51 @@
         // need to refresh display after setting pixels or writing strings
         lcd.refresh();
         wait(5.0);
-
+ 
         // can check status of pixel using getPixel(x,y);
         lcd.clear();  // clear buffer
         lcd.setPixel(2,2,true);  // set random pixel in buffer
         lcd.refresh();
         wait(1.0);
-
+ 
         int pixel_to_test = lcd.getPixel(2,2);
-
+ 
         if ( pixel_to_test ) {
             lcd.printString("2,2 is set",0,4);
         }
-
+ 
         // this one shouldn't be set
         lcd.setPixel(3,3,false);  // clear random pixel in buffer
         lcd.refresh();
         pixel_to_test = lcd.getPixel(3,3);
-
+ 
         if ( pixel_to_test == 0 ) {
             lcd.printString("3,3 is clear",0,5);
         }
-
+ 
         lcd.refresh();
         wait(4.0);
-
+ 
         lcd.clear();            // clear buffer
         lcd.inverseMode();      // invert colours
         lcd.setBrightness(1.0); // put LED backlight on full
-
+ 
         float array[84];
-
+ 
         for (int i = 0; i < 84; i++) {
             array[i] = 0.5 + 0.5*sin(i*2*3.14/84);
         }
-
+ 
         // can also plot graphs - 84 elements only
         // values must be in range 0.0 - 1.0
         lcd.plotArray(array);
         lcd.refresh();
         wait(5.0);
-
+ 
         lcd.clear();
         lcd.normalMode();      // normal colour mode back
         lcd.setBrightness(0.5); // put LED backlight on 50%
-
+ 
         // example of drawing lines
         for (int x = 0; x < WIDTH ; x+=10) {
             // x0,y0,x1,y1,type 0-white,1-black,2-dotted
@@ -151,8 +151,8 @@
         }
         lcd.refresh();  // refresh after drawing shapes
         wait(5.0);
-
-
+ 
+ 
         lcd.clear();
         // example of how to draw circles
         lcd.drawCircle(WIDTH/2,HEIGHT/2,20,FILL_BLACK);  // x,y,radius,black fill
@@ -160,7 +160,7 @@
         lcd.drawCircle(WIDTH/2,HEIGHT/2,30,FILL_TRANSPARENT);  // x,y,radius,transparent with outline
         lcd.refresh();  // refresh after drawing shapes
         wait(5.0);
-
+ 
         lcd.clear();
         // example of how to draw rectangles
         //          origin x,y,width,height,type
@@ -169,11 +169,11 @@
         lcd.drawRect(2,2,70,40,FILL_TRANSPARENT);    // transparent, just outline
         lcd.refresh();  // refresh after drawing shapes
         wait(5.0);
-
+ 
     }
 }
-
-
+ 
+ 
 @endcode
 */
 class N5110
@@ -186,10 +186,10 @@
     DigitalOut  *_sce;
     DigitalOut  *_rst;
     DigitalOut  *_dc;
-
+ 
 // variables
     unsigned char buffer[84][6];  // screen buffer - the 6 is for the banks - each one is 8 bits;
-
+ 
 public:
     /** Create a N5110 object connected to the specified pins
     *
@@ -209,7 +209,7 @@
           PinName const mosiPin,
           PinName const sclkPin,
           PinName const ledPin);
-
+ 
     /** Create a N5110 object connected to the specified pins (Vcc to +3V3)
     *
     * @param sce  Pin connected to chip enable (pin 3)
@@ -226,32 +226,32 @@
           PinName const mosiPin,
           PinName const sclkPin,
           PinName const ledPin);
-
+ 
     /**
      * Free allocated memory when object goes out of scope
      */
     ~N5110();
-
+ 
     /** Initialise display
     *
     *   Powers up the display and turns on backlight (50% brightness default).
     *   Sets the display up in horizontal addressing mode and with normal video mode.
     */
     void init();
-
+ 
     /** Turn off
     *
     *   Powers down the display and turns of the backlight.
     *   Needs to be reinitialised before being re-used.
     */
     void turnOff();
-
+ 
     /** Clear
     *
     *   Clears the screen buffer.
     */
     void clear();
-
+ 
     /** Set screen constrast
     *   @param constrast - float in range 0.0 to 1.0 (0.40 to 0.60 is usually a good value)
     */
@@ -261,19 +261,19 @@
     *  Black on white
     */
     void normalMode();
-
+ 
     /** Turn on inverse video mode (default)
     *  White on black
     */
     void inverseMode();
-
+ 
     /** Set Brightness
     *
     *   Sets brightness of LED backlight.
     *   @param brightness - float in range 0.0 to 1.0
     */
     void setBrightness(float const brightness);
-
+ 
     /** Print String
     *
     *   Prints a string of characters to the screen buffer. String is cut-off after the 83rd pixel.
@@ -283,7 +283,7 @@
     void printString(char const         *str,
                      unsigned int const  x,
                      unsigned int const  y);
-
+ 
     /** Print Character
     *
     *   Sends a character to the screen buffer.  Printed at the specified location. Character is cut-off after the 83rd pixel.
@@ -294,7 +294,7 @@
     void printChar(char const         c,
                    unsigned int const x,
                    unsigned int const y);
-
+ 
     /**
     * @brief Set a Pixel
     *
@@ -308,7 +308,7 @@
     void setPixel(unsigned int const x,
                   unsigned int const y,
                   bool const         state = true);
-
+ 
     /**
     *  @brief Clear a Pixel
     *
@@ -322,7 +322,7 @@
     void clearPixel(unsigned int const x,
                     unsigned int const y)
     __attribute__((deprecated("Use setPixel(x,y,false) instead")));
-
+ 
     /** Get a Pixel
     *
     *   This function gets the status of a pixel in the screen buffer.
@@ -334,13 +334,13 @@
     */
     int getPixel(unsigned int const x,
                  unsigned int const y) const;
-
+ 
     /** Refresh display
     *
     *   This functions sends the screen buffer to the display.
     */
     void refresh();
-
+ 
     /** Randomise buffer
     *
     *   This function fills the buffer with random data.  Can be used to test the display.
@@ -349,14 +349,14 @@
     *   TODO: Randomise the seed - maybe using the noise on the AnalogIn pins.
     */
     void randomiseBuffer();
-
+ 
     /** Plot Array
     *
     *   This function plots a one-dimensional array in the buffer.
     *   @param array[] - y values of the plot. Values should be normalised in the range 0.0 to 1.0. First 84 plotted.
     */
     void plotArray(float const array[]);
-
+ 
     /** Draw Circle
     *
     *   This function draws a circle at the specified origin with specified radius in the screen buffer
@@ -371,7 +371,7 @@
                     unsigned int const y0,
                     unsigned int const radius,
                     FillType const     fill);
-
+ 
     /** Draw Line
     *
     *   This function draws a line between the specified points using linear interpolation.
@@ -386,7 +386,7 @@
                   unsigned int const x1,
                   unsigned int const y1,
                   unsigned int const type);
-
+ 
     /** Draw Rectangle
     *
     *   This function draws a rectangle.
@@ -401,7 +401,7 @@
                   unsigned int const width,
                   unsigned int const height,
                   FillType const     fill);
-
+ 
     /** Draw Sprite
     *
     *   This function draws a sprite as defined in a 2D array
@@ -416,8 +416,8 @@
                     int nrows,
                     int ncols,
                     int *sprite);
-
-
+ 
+ 
 private:
 // methods
     void setXYAddress(unsigned int const x,
@@ -431,7 +431,7 @@
     void setTempCoefficient(char tc);  // 0 to 3
     void setBias(char bias);  // 0 to 7
 };
-
+ 
 const unsigned char font5x7[480] = {
     0x00, 0x00, 0x00, 0x00, 0x00,// (space)
     0x00, 0x00, 0x5F, 0x00, 0x00,// !
@@ -530,5 +530,5 @@
     0x08, 0x08, 0x2A, 0x1C, 0x08,// ->
     0x08, 0x1C, 0x2A, 0x08, 0x08 // <-
 };
-
+ 
 #endif
\ No newline at end of file