ELEC2645 (2018/19) / Mbed 2 deprecated el17m2h_public

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

N5110/N5110.h@0:40c03e733b77, 2019-03-11 (annotated)

Committer:
el17m2h
Date:
Mon Mar 11 10:04:06 2019 +0000
Revision:
0:40c03e733b77
Child:
1:0001cb3eb053
initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
el17m2h 0:40c03e733b77 1 #ifndef N5110_H
el17m2h 0:40c03e733b77 2 #define N5110_H
el17m2h 0:40c03e733b77 3
el17m2h 0:40c03e733b77 4 #include "mbed.h"
el17m2h 0:40c03e733b77 5
el17m2h 0:40c03e733b77 6 // number of pixels on display
el17m2h 0:40c03e733b77 7 #define WIDTH 84
el17m2h 0:40c03e733b77 8 #define HEIGHT 48
el17m2h 0:40c03e733b77 9 #define BANKS 6
el17m2h 0:40c03e733b77 10
el17m2h 0:40c03e733b77 11 /// Fill types for 2D shapes
el17m2h 0:40c03e733b77 12 enum FillType {
el17m2h 0:40c03e733b77 13 FILL_TRANSPARENT, ///< Transparent with outline
el17m2h 0:40c03e733b77 14 FILL_BLACK, ///< Filled black
el17m2h 0:40c03e733b77 15 FILL_WHITE, ///< Filled white (no outline)
el17m2h 0:40c03e733b77 16 };
el17m2h 0:40c03e733b77 17
el17m2h 0:40c03e733b77 18 /** N5110 Class
el17m2h 0:40c03e733b77 19 @brief Library for interfacing with Nokia 5110 LCD display (https://www.sparkfun.com/products/10168) using the hardware SPI on the mbed.
el17m2h 0:40c03e733b77 20 @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).
el17m2h 0:40c03e733b77 21 @brief Can print characters and strings to the display using the included 5x7 font.
el17m2h 0:40c03e733b77 22 @brief The library also implements a screen buffer so that individual pixels on the display (84 x 48) can be set, cleared and read.
el17m2h 0:40c03e733b77 23 @brief The library can print primitive shapes (lines, circles, rectangles)
el17m2h 0:40c03e733b77 24 @brief Acknowledgements to Chris Yan's Nokia_5110 Library.
el17m2h 0:40c03e733b77 25
el17m2h 0:40c03e733b77 26 @brief Revision 1.3
el17m2h 0:40c03e733b77 27
el17m2h 0:40c03e733b77 28 @author Craig A. Evans
el17m2h 0:40c03e733b77 29 @date 7th February 2017
el17m2h 0:40c03e733b77 30
el17m2h 0:40c03e733b77 31 @code
el17m2h 0:40c03e733b77 32
el17m2h 0:40c03e733b77 33 #include "mbed.h"
el17m2h 0:40c03e733b77 34 #include "N5110.h"
el17m2h 0:40c03e733b77 35
el17m2h 0:40c03e733b77 36 // rows,cols
el17m2h 0:40c03e733b77 37 int sprite[8][5] = {
el17m2h 0:40c03e733b77 38 { 0,0,1,0,0 },
el17m2h 0:40c03e733b77 39 { 0,1,1,1,0 },
el17m2h 0:40c03e733b77 40 { 0,0,1,0,0 },
el17m2h 0:40c03e733b77 41 { 0,1,1,1,0 },
el17m2h 0:40c03e733b77 42 { 1,1,1,1,1 },
el17m2h 0:40c03e733b77 43 { 1,1,1,1,1 },
el17m2h 0:40c03e733b77 44 { 1,1,0,1,1 },
el17m2h 0:40c03e733b77 45 { 1,1,0,1,1 },
el17m2h 0:40c03e733b77 46 };
el17m2h 0:40c03e733b77 47
el17m2h 0:40c03e733b77 48 // VCC,SCE,RST,D/C,MOSI,SCLK,LED
el17m2h 0:40c03e733b77 49 //N5110 lcd(p7,p8,p9,p10,p11,p13,p21); // LPC1768 - pwr from GPIO
el17m2h 0:40c03e733b77 50 N5110 lcd(p8,p9,p10,p11,p13,p21); // LPC1768 - powered from +3V3 - JP1 in 2/3 position
el17m2h 0:40c03e733b77 51 //N5110 lcd(PTC9,PTC0,PTC7,PTD2,PTD1,PTC11); // K64F - pwr from 3V3
el17m2h 0:40c03e733b77 52
el17m2h 0:40c03e733b77 53 int main()
el17m2h 0:40c03e733b77 54 {
el17m2h 0:40c03e733b77 55 // first need to initialise display
el17m2h 0:40c03e733b77 56 lcd.init();
el17m2h 0:40c03e733b77 57
el17m2h 0:40c03e733b77 58 // change set contrast in range 0.0 to 1.0
el17m2h 0:40c03e733b77 59 // 0.4 appears to be a good starting point
el17m2h 0:40c03e733b77 60 lcd.setContrast(0.4);
el17m2h 0:40c03e733b77 61
el17m2h 0:40c03e733b77 62 while(1) {
el17m2h 0:40c03e733b77 63
el17m2h 0:40c03e733b77 64 // these are default settings so not strictly needed
el17m2h 0:40c03e733b77 65 lcd.normalMode(); // normal colour mode
el17m2h 0:40c03e733b77 66 lcd.setBrightness(0.5); // put LED backlight on 50%
el17m2h 0:40c03e733b77 67
el17m2h 0:40c03e733b77 68 lcd.clear();
el17m2h 0:40c03e733b77 69 // x origin, y origin, rows, cols, sprite
el17m2h 0:40c03e733b77 70 lcd.drawSprite(20,6,8,5,(int *)sprite);
el17m2h 0:40c03e733b77 71 lcd.refresh();
el17m2h 0:40c03e733b77 72 wait(5.0);
el17m2h 0:40c03e733b77 73
el17m2h 0:40c03e733b77 74 lcd.clear(); // clear buffer at start of every loop
el17m2h 0:40c03e733b77 75 // can directly print strings at specified co-ordinates (must be less than 84 pixels to fit on display)
el17m2h 0:40c03e733b77 76 lcd.printString("Hello, World!",0,0);
el17m2h 0:40c03e733b77 77
el17m2h 0:40c03e733b77 78 char buffer[14]; // each character is 6 pixels wide, screen is 84 pixels (84/6 = 14)
el17m2h 0:40c03e733b77 79 // so can display a string of a maximum 14 characters in length
el17m2h 0:40c03e733b77 80 // or create formatted strings - ensure they aren't more than 14 characters long
el17m2h 0:40c03e733b77 81 int temperature = 27;
el17m2h 0:40c03e733b77 82 int length = sprintf(buffer,"T = %2d C",temperature); // print formatted data to buffer
el17m2h 0:40c03e733b77 83 // it is important the format specifier ensures the length will fit in the buffer
el17m2h 0:40c03e733b77 84 if (length <= 14) // if string will fit on display (assuming printing at x=0)
el17m2h 0:40c03e733b77 85 lcd.printString(buffer,0,1); // display on screen
el17m2h 0:40c03e733b77 86
el17m2h 0:40c03e733b77 87 float pressure = 1012.3; // same idea with floats
el17m2h 0:40c03e733b77 88 length = sprintf(buffer,"P = %.2f mb",pressure);
el17m2h 0:40c03e733b77 89 if (length <= 14)
el17m2h 0:40c03e733b77 90 lcd.printString(buffer,0,2);
el17m2h 0:40c03e733b77 91
el17m2h 0:40c03e733b77 92 // can also print individual characters at specified place
el17m2h 0:40c03e733b77 93 lcd.printChar('X',5,3);
el17m2h 0:40c03e733b77 94
el17m2h 0:40c03e733b77 95 // draw a line across the display at y = 40 pixels (origin top-left)
el17m2h 0:40c03e733b77 96 for (int i = 0; i < WIDTH; i++) {
el17m2h 0:40c03e733b77 97 lcd.setPixel(i,40,true);
el17m2h 0:40c03e733b77 98 }
el17m2h 0:40c03e733b77 99 // need to refresh display after setting pixels or writing strings
el17m2h 0:40c03e733b77 100 lcd.refresh();
el17m2h 0:40c03e733b77 101 wait(5.0);
el17m2h 0:40c03e733b77 102
el17m2h 0:40c03e733b77 103 // can check status of pixel using getPixel(x,y);
el17m2h 0:40c03e733b77 104 lcd.clear(); // clear buffer
el17m2h 0:40c03e733b77 105 lcd.setPixel(2,2,true); // set random pixel in buffer
el17m2h 0:40c03e733b77 106 lcd.refresh();
el17m2h 0:40c03e733b77 107 wait(1.0);
el17m2h 0:40c03e733b77 108
el17m2h 0:40c03e733b77 109 int pixel_to_test = lcd.getPixel(2,2);
el17m2h 0:40c03e733b77 110
el17m2h 0:40c03e733b77 111 if ( pixel_to_test ) {
el17m2h 0:40c03e733b77 112 lcd.printString("2,2 is set",0,4);
el17m2h 0:40c03e733b77 113 }
el17m2h 0:40c03e733b77 114
el17m2h 0:40c03e733b77 115 // this one shouldn't be set
el17m2h 0:40c03e733b77 116 lcd.setPixel(3,3,false); // clear random pixel in buffer
el17m2h 0:40c03e733b77 117 lcd.refresh();
el17m2h 0:40c03e733b77 118 pixel_to_test = lcd.getPixel(3,3);
el17m2h 0:40c03e733b77 119
el17m2h 0:40c03e733b77 120 if ( pixel_to_test == 0 ) {
el17m2h 0:40c03e733b77 121 lcd.printString("3,3 is clear",0,5);
el17m2h 0:40c03e733b77 122 }
el17m2h 0:40c03e733b77 123
el17m2h 0:40c03e733b77 124 lcd.refresh();
el17m2h 0:40c03e733b77 125 wait(4.0);
el17m2h 0:40c03e733b77 126
el17m2h 0:40c03e733b77 127 lcd.clear(); // clear buffer
el17m2h 0:40c03e733b77 128 lcd.inverseMode(); // invert colours
el17m2h 0:40c03e733b77 129 lcd.setBrightness(1.0); // put LED backlight on full
el17m2h 0:40c03e733b77 130
el17m2h 0:40c03e733b77 131 float array[84];
el17m2h 0:40c03e733b77 132
el17m2h 0:40c03e733b77 133 for (int i = 0; i < 84; i++) {
el17m2h 0:40c03e733b77 134 array[i] = 0.5 + 0.5*sin(i*2*3.14/84);
el17m2h 0:40c03e733b77 135 }
el17m2h 0:40c03e733b77 136
el17m2h 0:40c03e733b77 137 // can also plot graphs - 84 elements only
el17m2h 0:40c03e733b77 138 // values must be in range 0.0 - 1.0
el17m2h 0:40c03e733b77 139 lcd.plotArray(array);
el17m2h 0:40c03e733b77 140 lcd.refresh();
el17m2h 0:40c03e733b77 141 wait(5.0);
el17m2h 0:40c03e733b77 142
el17m2h 0:40c03e733b77 143 lcd.clear();
el17m2h 0:40c03e733b77 144 lcd.normalMode(); // normal colour mode back
el17m2h 0:40c03e733b77 145 lcd.setBrightness(0.5); // put LED backlight on 50%
el17m2h 0:40c03e733b77 146
el17m2h 0:40c03e733b77 147 // example of drawing lines
el17m2h 0:40c03e733b77 148 for (int x = 0; x < WIDTH ; x+=10) {
el17m2h 0:40c03e733b77 149 // x0,y0,x1,y1,type 0-white,1-black,2-dotted
el17m2h 0:40c03e733b77 150 lcd.drawLine(0,0,x,HEIGHT,2);
el17m2h 0:40c03e733b77 151 }
el17m2h 0:40c03e733b77 152 lcd.refresh(); // refresh after drawing shapes
el17m2h 0:40c03e733b77 153 wait(5.0);
el17m2h 0:40c03e733b77 154
el17m2h 0:40c03e733b77 155
el17m2h 0:40c03e733b77 156 lcd.clear();
el17m2h 0:40c03e733b77 157 // example of how to draw circles
el17m2h 0:40c03e733b77 158 lcd.drawCircle(WIDTH/2,HEIGHT/2,20,FILL_BLACK); // x,y,radius,black fill
el17m2h 0:40c03e733b77 159 lcd.drawCircle(WIDTH/2,HEIGHT/2,10,FILL_WHITE); // x,y,radius,white fill
el17m2h 0:40c03e733b77 160 lcd.drawCircle(WIDTH/2,HEIGHT/2,30,FILL_TRANSPARENT); // x,y,radius,transparent with outline
el17m2h 0:40c03e733b77 161 lcd.refresh(); // refresh after drawing shapes
el17m2h 0:40c03e733b77 162 wait(5.0);
el17m2h 0:40c03e733b77 163
el17m2h 0:40c03e733b77 164 lcd.clear();
el17m2h 0:40c03e733b77 165 // example of how to draw rectangles
el17m2h 0:40c03e733b77 166 // origin x,y,width,height,type
el17m2h 0:40c03e733b77 167 lcd.drawRect(10,10,50,30,FILL_BLACK); // filled black rectangle
el17m2h 0:40c03e733b77 168 lcd.drawRect(15,15,20,10,FILL_WHITE); // filled white rectange (no outline)
el17m2h 0:40c03e733b77 169 lcd.drawRect(2,2,70,40,FILL_TRANSPARENT); // transparent, just outline
el17m2h 0:40c03e733b77 170 lcd.refresh(); // refresh after drawing shapes
el17m2h 0:40c03e733b77 171 wait(5.0);
el17m2h 0:40c03e733b77 172
el17m2h 0:40c03e733b77 173 }
el17m2h 0:40c03e733b77 174 }
el17m2h 0:40c03e733b77 175
el17m2h 0:40c03e733b77 176
el17m2h 0:40c03e733b77 177 @endcode
el17m2h 0:40c03e733b77 178 */
el17m2h 0:40c03e733b77 179 class N5110
el17m2h 0:40c03e733b77 180 {
el17m2h 0:40c03e733b77 181 private:
el17m2h 0:40c03e733b77 182 // objects
el17m2h 0:40c03e733b77 183 SPI *_spi;
el17m2h 0:40c03e733b77 184 PwmOut *_led;
el17m2h 0:40c03e733b77 185 DigitalOut *_pwr;
el17m2h 0:40c03e733b77 186 DigitalOut *_sce;
el17m2h 0:40c03e733b77 187 DigitalOut *_rst;
el17m2h 0:40c03e733b77 188 DigitalOut *_dc;
el17m2h 0:40c03e733b77 189
el17m2h 0:40c03e733b77 190 // variables
el17m2h 0:40c03e733b77 191 unsigned char buffer[84][6]; // screen buffer - the 6 is for the banks - each one is 8 bits;
el17m2h 0:40c03e733b77 192
el17m2h 0:40c03e733b77 193 public:
el17m2h 0:40c03e733b77 194 /** Create a N5110 object connected to the specified pins
el17m2h 0:40c03e733b77 195 *
el17m2h 0:40c03e733b77 196 * @param pwr Pin connected to Vcc on the LCD display (pin 1)
el17m2h 0:40c03e733b77 197 * @param sce Pin connected to chip enable (pin 3)
el17m2h 0:40c03e733b77 198 * @param rst Pin connected to reset (pin 4)
el17m2h 0:40c03e733b77 199 * @param dc Pin connected to data/command select (pin 5)
el17m2h 0:40c03e733b77 200 * @param mosi Pin connected to data input (MOSI) (pin 6)
el17m2h 0:40c03e733b77 201 * @param sclk Pin connected to serial clock (SCLK) (pin 7)
el17m2h 0:40c03e733b77 202 * @param led Pin connected to LED backlight (must be PWM) (pin 8)
el17m2h 0:40c03e733b77 203 *
el17m2h 0:40c03e733b77 204 */
el17m2h 0:40c03e733b77 205 N5110(PinName const pwrPin,
el17m2h 0:40c03e733b77 206 PinName const scePin,
el17m2h 0:40c03e733b77 207 PinName const rstPin,
el17m2h 0:40c03e733b77 208 PinName const dcPin,
el17m2h 0:40c03e733b77 209 PinName const mosiPin,
el17m2h 0:40c03e733b77 210 PinName const sclkPin,
el17m2h 0:40c03e733b77 211 PinName const ledPin);
el17m2h 0:40c03e733b77 212
el17m2h 0:40c03e733b77 213 /** Create a N5110 object connected to the specified pins (Vcc to +3V3)
el17m2h 0:40c03e733b77 214 *
el17m2h 0:40c03e733b77 215 * @param sce Pin connected to chip enable (pin 3)
el17m2h 0:40c03e733b77 216 * @param rst Pin connected to reset (pin 4)
el17m2h 0:40c03e733b77 217 * @param dc Pin connected to data/command select (pin 5)
el17m2h 0:40c03e733b77 218 * @param mosi Pin connected to data input (MOSI) (pin 6)
el17m2h 0:40c03e733b77 219 * @param sclk Pin connected to serial clock (SCLK) (pin 7)
el17m2h 0:40c03e733b77 220 * @param led Pin connected to LED backlight (must be PWM) (pin 8)
el17m2h 0:40c03e733b77 221 *
el17m2h 0:40c03e733b77 222 */
el17m2h 0:40c03e733b77 223 N5110(PinName const scePin,
el17m2h 0:40c03e733b77 224 PinName const rstPin,
el17m2h 0:40c03e733b77 225 PinName const dcPin,
el17m2h 0:40c03e733b77 226 PinName const mosiPin,
el17m2h 0:40c03e733b77 227 PinName const sclkPin,
el17m2h 0:40c03e733b77 228 PinName const ledPin);
el17m2h 0:40c03e733b77 229
el17m2h 0:40c03e733b77 230 /**
el17m2h 0:40c03e733b77 231 * Free allocated memory when object goes out of scope
el17m2h 0:40c03e733b77 232 */
el17m2h 0:40c03e733b77 233 ~N5110();
el17m2h 0:40c03e733b77 234
el17m2h 0:40c03e733b77 235 /** Initialise display
el17m2h 0:40c03e733b77 236 *
el17m2h 0:40c03e733b77 237 * Powers up the display and turns on backlight (50% brightness default).
el17m2h 0:40c03e733b77 238 * Sets the display up in horizontal addressing mode and with normal video mode.
el17m2h 0:40c03e733b77 239 */
el17m2h 0:40c03e733b77 240 void init();
el17m2h 0:40c03e733b77 241
el17m2h 0:40c03e733b77 242 /** Turn off
el17m2h 0:40c03e733b77 243 *
el17m2h 0:40c03e733b77 244 * Powers down the display and turns of the backlight.
el17m2h 0:40c03e733b77 245 * Needs to be reinitialised before being re-used.
el17m2h 0:40c03e733b77 246 */
el17m2h 0:40c03e733b77 247 void turnOff();
el17m2h 0:40c03e733b77 248
el17m2h 0:40c03e733b77 249 /** Clear
el17m2h 0:40c03e733b77 250 *
el17m2h 0:40c03e733b77 251 * Clears the screen buffer.
el17m2h 0:40c03e733b77 252 */
el17m2h 0:40c03e733b77 253 void clear();
el17m2h 0:40c03e733b77 254
el17m2h 0:40c03e733b77 255 /** Set screen constrast
el17m2h 0:40c03e733b77 256 * @param constrast - float in range 0.0 to 1.0 (0.40 to 0.60 is usually a good value)
el17m2h 0:40c03e733b77 257 */
el17m2h 0:40c03e733b77 258 void setContrast(float contrast);
el17m2h 0:40c03e733b77 259
el17m2h 0:40c03e733b77 260 /** Turn on normal video mode (default)
el17m2h 0:40c03e733b77 261 * Black on white
el17m2h 0:40c03e733b77 262 */
el17m2h 0:40c03e733b77 263 void normalMode();
el17m2h 0:40c03e733b77 264
el17m2h 0:40c03e733b77 265 /** Turn on inverse video mode (default)
el17m2h 0:40c03e733b77 266 * White on black
el17m2h 0:40c03e733b77 267 */
el17m2h 0:40c03e733b77 268 void inverseMode();
el17m2h 0:40c03e733b77 269
el17m2h 0:40c03e733b77 270 /** Set Brightness
el17m2h 0:40c03e733b77 271 *
el17m2h 0:40c03e733b77 272 * Sets brightness of LED backlight.
el17m2h 0:40c03e733b77 273 * @param brightness - float in range 0.0 to 1.0
el17m2h 0:40c03e733b77 274 */
el17m2h 0:40c03e733b77 275 void setBrightness(float const brightness);
el17m2h 0:40c03e733b77 276
el17m2h 0:40c03e733b77 277 /** Print String
el17m2h 0:40c03e733b77 278 *
el17m2h 0:40c03e733b77 279 * Prints a string of characters to the screen buffer. String is cut-off after the 83rd pixel.
el17m2h 0:40c03e733b77 280 * @param x - the column number (0 to 83)
el17m2h 0:40c03e733b77 281 * @param y - the row number (0 to 5) - the display is split into 6 banks - each bank can be considered a row
el17m2h 0:40c03e733b77 282 */
el17m2h 0:40c03e733b77 283 void printString(char const *str,
el17m2h 0:40c03e733b77 284 unsigned int const x,
el17m2h 0:40c03e733b77 285 unsigned int const y);
el17m2h 0:40c03e733b77 286
el17m2h 0:40c03e733b77 287 /** Print Character
el17m2h 0:40c03e733b77 288 *
el17m2h 0:40c03e733b77 289 * Sends a character to the screen buffer. Printed at the specified location. Character is cut-off after the 83rd pixel.
el17m2h 0:40c03e733b77 290 * @param c - the character to print. Can print ASCII as so printChar('C').
el17m2h 0:40c03e733b77 291 * @param x - the column number (0 to 83)
el17m2h 0:40c03e733b77 292 * @param y - the row number (0 to 5) - the display is split into 6 banks - each bank can be considered a row
el17m2h 0:40c03e733b77 293 */
el17m2h 0:40c03e733b77 294 void printChar(char const c,
el17m2h 0:40c03e733b77 295 unsigned int const x,
el17m2h 0:40c03e733b77 296 unsigned int const y);
el17m2h 0:40c03e733b77 297
el17m2h 0:40c03e733b77 298 /**
el17m2h 0:40c03e733b77 299 * @brief Set a Pixel
el17m2h 0:40c03e733b77 300 *
el17m2h 0:40c03e733b77 301 * @param x The x co-ordinate of the pixel (0 to 83)
el17m2h 0:40c03e733b77 302 * @param y The y co-ordinate of the pixel (0 to 47)
el17m2h 0:40c03e733b77 303 * @param state The state of the pixel [true=black (default), false=white]
el17m2h 0:40c03e733b77 304 *
el17m2h 0:40c03e733b77 305 * @details This function sets the state of a pixel in the screen buffer.
el17m2h 0:40c03e733b77 306 * The third parameter can be omitted,
el17m2h 0:40c03e733b77 307 */
el17m2h 0:40c03e733b77 308 void setPixel(unsigned int const x,
el17m2h 0:40c03e733b77 309 unsigned int const y,
el17m2h 0:40c03e733b77 310 bool const state = true);
el17m2h 0:40c03e733b77 311
el17m2h 0:40c03e733b77 312 /**
el17m2h 0:40c03e733b77 313 * @brief Clear a Pixel
el17m2h 0:40c03e733b77 314 *
el17m2h 0:40c03e733b77 315 * @param x - the x co-ordinate of the pixel (0 to 83)
el17m2h 0:40c03e733b77 316 * @param y - the y co-ordinate of the pixel (0 to 47)
el17m2h 0:40c03e733b77 317 *
el17m2h 0:40c03e733b77 318 * @details This function clears pixel in the screen buffer
el17m2h 0:40c03e733b77 319 *
el17m2h 0:40c03e733b77 320 * @deprecated Use setPixel(x, y, false) instead
el17m2h 0:40c03e733b77 321 */
el17m2h 0:40c03e733b77 322 void clearPixel(unsigned int const x,
el17m2h 0:40c03e733b77 323 unsigned int const y)
el17m2h 0:40c03e733b77 324 __attribute__((deprecated("Use setPixel(x,y,false) instead")));
el17m2h 0:40c03e733b77 325
el17m2h 0:40c03e733b77 326 /** Get a Pixel
el17m2h 0:40c03e733b77 327 *
el17m2h 0:40c03e733b77 328 * This function gets the status of a pixel in the screen buffer.
el17m2h 0:40c03e733b77 329 * @param x - the x co-ordinate of the pixel (0 to 83)
el17m2h 0:40c03e733b77 330 * @param y - the y co-ordinate of the pixel (0 to 47)
el17m2h 0:40c03e733b77 331 * @returns
el17m2h 0:40c03e733b77 332 * 0 - pixel is clear
el17m2h 0:40c03e733b77 333 * 1 - pixel is set
el17m2h 0:40c03e733b77 334 */
el17m2h 0:40c03e733b77 335 int getPixel(unsigned int const x,
el17m2h 0:40c03e733b77 336 unsigned int const y) const;
el17m2h 0:40c03e733b77 337
el17m2h 0:40c03e733b77 338 /** Refresh display
el17m2h 0:40c03e733b77 339 *
el17m2h 0:40c03e733b77 340 * This functions sends the screen buffer to the display.
el17m2h 0:40c03e733b77 341 */
el17m2h 0:40c03e733b77 342 void refresh();
el17m2h 0:40c03e733b77 343
el17m2h 0:40c03e733b77 344 /** Randomise buffer
el17m2h 0:40c03e733b77 345 *
el17m2h 0:40c03e733b77 346 * This function fills the buffer with random data. Can be used to test the display.
el17m2h 0:40c03e733b77 347 * A call to refresh() must be made to update the display to reflect the change in pixels.
el17m2h 0:40c03e733b77 348 * The seed is not set and so the generated pattern will probably be the same each time.
el17m2h 0:40c03e733b77 349 * TODO: Randomise the seed - maybe using the noise on the AnalogIn pins.
el17m2h 0:40c03e733b77 350 */
el17m2h 0:40c03e733b77 351 void randomiseBuffer();
el17m2h 0:40c03e733b77 352
el17m2h 0:40c03e733b77 353 /** Plot Array
el17m2h 0:40c03e733b77 354 *
el17m2h 0:40c03e733b77 355 * This function plots a one-dimensional array in the buffer.
el17m2h 0:40c03e733b77 356 * @param array[] - y values of the plot. Values should be normalised in the range 0.0 to 1.0. First 84 plotted.
el17m2h 0:40c03e733b77 357 */
el17m2h 0:40c03e733b77 358 void plotArray(float const array[]);
el17m2h 0:40c03e733b77 359
el17m2h 0:40c03e733b77 360 /** Draw Circle
el17m2h 0:40c03e733b77 361 *
el17m2h 0:40c03e733b77 362 * This function draws a circle at the specified origin with specified radius in the screen buffer
el17m2h 0:40c03e733b77 363 * Uses the midpoint circle algorithm.
el17m2h 0:40c03e733b77 364 * @see http://en.wikipedia.org/wiki/Midpoint_circle_algorithm
el17m2h 0:40c03e733b77 365 * @param x0 - x-coordinate of centre
el17m2h 0:40c03e733b77 366 * @param y0 - y-coordinate of centre
el17m2h 0:40c03e733b77 367 * @param radius - radius of circle in pixels
el17m2h 0:40c03e733b77 368 * @param fill - fill-type for the shape
el17m2h 0:40c03e733b77 369 */
el17m2h 0:40c03e733b77 370 void drawCircle(unsigned int const x0,
el17m2h 0:40c03e733b77 371 unsigned int const y0,
el17m2h 0:40c03e733b77 372 unsigned int const radius,
el17m2h 0:40c03e733b77 373 FillType const fill);
el17m2h 0:40c03e733b77 374
el17m2h 0:40c03e733b77 375 /** Draw Line
el17m2h 0:40c03e733b77 376 *
el17m2h 0:40c03e733b77 377 * This function draws a line between the specified points using linear interpolation.
el17m2h 0:40c03e733b77 378 * @param x0 - x-coordinate of first point
el17m2h 0:40c03e733b77 379 * @param y0 - y-coordinate of first point
el17m2h 0:40c03e733b77 380 * @param x1 - x-coordinate of last point
el17m2h 0:40c03e733b77 381 * @param y1 - y-coordinate of last point
el17m2h 0:40c03e733b77 382 * @param type - 0 white,1 black,2 dotted
el17m2h 0:40c03e733b77 383 */
el17m2h 0:40c03e733b77 384 void drawLine(unsigned int const x0,
el17m2h 0:40c03e733b77 385 unsigned int const y0,
el17m2h 0:40c03e733b77 386 unsigned int const x1,
el17m2h 0:40c03e733b77 387 unsigned int const y1,
el17m2h 0:40c03e733b77 388 unsigned int const type);
el17m2h 0:40c03e733b77 389
el17m2h 0:40c03e733b77 390 /** Draw Rectangle
el17m2h 0:40c03e733b77 391 *
el17m2h 0:40c03e733b77 392 * This function draws a rectangle.
el17m2h 0:40c03e733b77 393 * @param x0 - x-coordinate of origin (top-left)
el17m2h 0:40c03e733b77 394 * @param y0 - y-coordinate of origin (top-left)
el17m2h 0:40c03e733b77 395 * @param width - width of rectangle
el17m2h 0:40c03e733b77 396 * @param height - height of rectangle
el17m2h 0:40c03e733b77 397 * @param fill - fill-type for the shape
el17m2h 0:40c03e733b77 398 */
el17m2h 0:40c03e733b77 399 void drawRect(unsigned int const x0,
el17m2h 0:40c03e733b77 400 unsigned int const y0,
el17m2h 0:40c03e733b77 401 unsigned int const width,
el17m2h 0:40c03e733b77 402 unsigned int const height,
el17m2h 0:40c03e733b77 403 FillType const fill);
el17m2h 0:40c03e733b77 404
el17m2h 0:40c03e733b77 405 /** Draw Sprite
el17m2h 0:40c03e733b77 406 *
el17m2h 0:40c03e733b77 407 * This function draws a sprite as defined in a 2D array
el17m2h 0:40c03e733b77 408 * @param x0 - x-coordinate of origin (top-left)
el17m2h 0:40c03e733b77 409 * @param y0 - y-coordinate of origin (top-left)
el17m2h 0:40c03e733b77 410 * @param nrows - number of rows in sprite
el17m2h 0:40c03e733b77 411 * @param ncols - number of columns in sprite
el17m2h 0:40c03e733b77 412 * @param sprite - 2D array representing the sprite
el17m2h 0:40c03e733b77 413 */
el17m2h 0:40c03e733b77 414 void drawSprite(int x0,
el17m2h 0:40c03e733b77 415 int y0,
el17m2h 0:40c03e733b77 416 int nrows,
el17m2h 0:40c03e733b77 417 int ncols,
el17m2h 0:40c03e733b77 418 int *sprite);
el17m2h 0:40c03e733b77 419
el17m2h 0:40c03e733b77 420
el17m2h 0:40c03e733b77 421 private:
el17m2h 0:40c03e733b77 422 // methods
el17m2h 0:40c03e733b77 423 void setXYAddress(unsigned int const x,
el17m2h 0:40c03e733b77 424 unsigned int const y);
el17m2h 0:40c03e733b77 425 void initSPI();
el17m2h 0:40c03e733b77 426 void turnOn();
el17m2h 0:40c03e733b77 427 void reset();
el17m2h 0:40c03e733b77 428 void clearRAM();
el17m2h 0:40c03e733b77 429 void sendCommand(unsigned char command);
el17m2h 0:40c03e733b77 430 void sendData(unsigned char data);
el17m2h 0:40c03e733b77 431 void setTempCoefficient(char tc); // 0 to 3
el17m2h 0:40c03e733b77 432 void setBias(char bias); // 0 to 7
el17m2h 0:40c03e733b77 433 };
el17m2h 0:40c03e733b77 434
el17m2h 0:40c03e733b77 435 const unsigned char font5x7[480] = {
el17m2h 0:40c03e733b77 436 0x00, 0x00, 0x00, 0x00, 0x00,// (space)
el17m2h 0:40c03e733b77 437 0x00, 0x00, 0x5F, 0x00, 0x00,// !
el17m2h 0:40c03e733b77 438 0x00, 0x07, 0x00, 0x07, 0x00,// "
el17m2h 0:40c03e733b77 439 0x14, 0x7F, 0x14, 0x7F, 0x14,// #
el17m2h 0:40c03e733b77 440 0x24, 0x2A, 0x7F, 0x2A, 0x12,// $
el17m2h 0:40c03e733b77 441 0x23, 0x13, 0x08, 0x64, 0x62,// %
el17m2h 0:40c03e733b77 442 0x36, 0x49, 0x55, 0x22, 0x50,// &
el17m2h 0:40c03e733b77 443 0x00, 0x05, 0x03, 0x00, 0x00,// '
el17m2h 0:40c03e733b77 444 0x00, 0x1C, 0x22, 0x41, 0x00,// (
el17m2h 0:40c03e733b77 445 0x00, 0x41, 0x22, 0x1C, 0x00,// )
el17m2h 0:40c03e733b77 446 0x08, 0x2A, 0x1C, 0x2A, 0x08,// *
el17m2h 0:40c03e733b77 447 0x08, 0x08, 0x3E, 0x08, 0x08,// +
el17m2h 0:40c03e733b77 448 0x00, 0x50, 0x30, 0x00, 0x00,// ,
el17m2h 0:40c03e733b77 449 0x08, 0x08, 0x08, 0x08, 0x08,// -
el17m2h 0:40c03e733b77 450 0x00, 0x60, 0x60, 0x00, 0x00,// .
el17m2h 0:40c03e733b77 451 0x20, 0x10, 0x08, 0x04, 0x02,// /
el17m2h 0:40c03e733b77 452 0x3E, 0x51, 0x49, 0x45, 0x3E,// 0
el17m2h 0:40c03e733b77 453 0x00, 0x42, 0x7F, 0x40, 0x00,// 1
el17m2h 0:40c03e733b77 454 0x42, 0x61, 0x51, 0x49, 0x46,// 2
el17m2h 0:40c03e733b77 455 0x21, 0x41, 0x45, 0x4B, 0x31,// 3
el17m2h 0:40c03e733b77 456 0x18, 0x14, 0x12, 0x7F, 0x10,// 4
el17m2h 0:40c03e733b77 457 0x27, 0x45, 0x45, 0x45, 0x39,// 5
el17m2h 0:40c03e733b77 458 0x3C, 0x4A, 0x49, 0x49, 0x30,// 6
el17m2h 0:40c03e733b77 459 0x01, 0x71, 0x09, 0x05, 0x03,// 7
el17m2h 0:40c03e733b77 460 0x36, 0x49, 0x49, 0x49, 0x36,// 8
el17m2h 0:40c03e733b77 461 0x06, 0x49, 0x49, 0x29, 0x1E,// 9
el17m2h 0:40c03e733b77 462 0x00, 0x36, 0x36, 0x00, 0x00,// :
el17m2h 0:40c03e733b77 463 0x00, 0x56, 0x36, 0x00, 0x00,// ;
el17m2h 0:40c03e733b77 464 0x00, 0x08, 0x14, 0x22, 0x41,// <
el17m2h 0:40c03e733b77 465 0x14, 0x14, 0x14, 0x14, 0x14,// =
el17m2h 0:40c03e733b77 466 0x41, 0x22, 0x14, 0x08, 0x00,// >
el17m2h 0:40c03e733b77 467 0x02, 0x01, 0x51, 0x09, 0x06,// ?
el17m2h 0:40c03e733b77 468 0x32, 0x49, 0x79, 0x41, 0x3E,// @
el17m2h 0:40c03e733b77 469 0x7E, 0x11, 0x11, 0x11, 0x7E,// A
el17m2h 0:40c03e733b77 470 0x7F, 0x49, 0x49, 0x49, 0x36,// B
el17m2h 0:40c03e733b77 471 0x3E, 0x41, 0x41, 0x41, 0x22,// C
el17m2h 0:40c03e733b77 472 0x7F, 0x41, 0x41, 0x22, 0x1C,// D
el17m2h 0:40c03e733b77 473 0x7F, 0x49, 0x49, 0x49, 0x41,// E
el17m2h 0:40c03e733b77 474 0x7F, 0x09, 0x09, 0x01, 0x01,// F
el17m2h 0:40c03e733b77 475 0x3E, 0x41, 0x41, 0x51, 0x32,// G
el17m2h 0:40c03e733b77 476 0x7F, 0x08, 0x08, 0x08, 0x7F,// H
el17m2h 0:40c03e733b77 477 0x00, 0x41, 0x7F, 0x41, 0x00,// I
el17m2h 0:40c03e733b77 478 0x20, 0x40, 0x41, 0x3F, 0x01,// J
el17m2h 0:40c03e733b77 479 0x7F, 0x08, 0x14, 0x22, 0x41,// K
el17m2h 0:40c03e733b77 480 0x7F, 0x40, 0x40, 0x40, 0x40,// L
el17m2h 0:40c03e733b77 481 0x7F, 0x02, 0x04, 0x02, 0x7F,// M
el17m2h 0:40c03e733b77 482 0x7F, 0x04, 0x08, 0x10, 0x7F,// N
el17m2h 0:40c03e733b77 483 0x3E, 0x41, 0x41, 0x41, 0x3E,// O
el17m2h 0:40c03e733b77 484 0x7F, 0x09, 0x09, 0x09, 0x06,// P
el17m2h 0:40c03e733b77 485 0x3E, 0x41, 0x51, 0x21, 0x5E,// Q
el17m2h 0:40c03e733b77 486 0x7F, 0x09, 0x19, 0x29, 0x46,// R
el17m2h 0:40c03e733b77 487 0x46, 0x49, 0x49, 0x49, 0x31,// S
el17m2h 0:40c03e733b77 488 0x01, 0x01, 0x7F, 0x01, 0x01,// T
el17m2h 0:40c03e733b77 489 0x3F, 0x40, 0x40, 0x40, 0x3F,// U
el17m2h 0:40c03e733b77 490 0x1F, 0x20, 0x40, 0x20, 0x1F,// V
el17m2h 0:40c03e733b77 491 0x7F, 0x20, 0x18, 0x20, 0x7F,// W
el17m2h 0:40c03e733b77 492 0x63, 0x14, 0x08, 0x14, 0x63,// X
el17m2h 0:40c03e733b77 493 0x03, 0x04, 0x78, 0x04, 0x03,// Y
el17m2h 0:40c03e733b77 494 0x61, 0x51, 0x49, 0x45, 0x43,// Z
el17m2h 0:40c03e733b77 495 0x00, 0x00, 0x7F, 0x41, 0x41,// [
el17m2h 0:40c03e733b77 496 0x02, 0x04, 0x08, 0x10, 0x20,// "\"
el17m2h 0:40c03e733b77 497 0x41, 0x41, 0x7F, 0x00, 0x00,// ]
el17m2h 0:40c03e733b77 498 0x04, 0x02, 0x01, 0x02, 0x04,// ^
el17m2h 0:40c03e733b77 499 0x40, 0x40, 0x40, 0x40, 0x40,// _
el17m2h 0:40c03e733b77 500 0x00, 0x01, 0x02, 0x04, 0x00,// `
el17m2h 0:40c03e733b77 501 0x20, 0x54, 0x54, 0x54, 0x78,// a
el17m2h 0:40c03e733b77 502 0x7F, 0x48, 0x44, 0x44, 0x38,// b
el17m2h 0:40c03e733b77 503 0x38, 0x44, 0x44, 0x44, 0x20,// c
el17m2h 0:40c03e733b77 504 0x38, 0x44, 0x44, 0x48, 0x7F,// d
el17m2h 0:40c03e733b77 505 0x38, 0x54, 0x54, 0x54, 0x18,// e
el17m2h 0:40c03e733b77 506 0x08, 0x7E, 0x09, 0x01, 0x02,// f
el17m2h 0:40c03e733b77 507 0x08, 0x14, 0x54, 0x54, 0x3C,// g
el17m2h 0:40c03e733b77 508 0x7F, 0x08, 0x04, 0x04, 0x78,// h
el17m2h 0:40c03e733b77 509 0x00, 0x44, 0x7D, 0x40, 0x00,// i
el17m2h 0:40c03e733b77 510 0x20, 0x40, 0x44, 0x3D, 0x00,// j
el17m2h 0:40c03e733b77 511 0x00, 0x7F, 0x10, 0x28, 0x44,// k
el17m2h 0:40c03e733b77 512 0x00, 0x41, 0x7F, 0x40, 0x00,// l
el17m2h 0:40c03e733b77 513 0x7C, 0x04, 0x18, 0x04, 0x78,// m
el17m2h 0:40c03e733b77 514 0x7C, 0x08, 0x04, 0x04, 0x78,// n
el17m2h 0:40c03e733b77 515 0x38, 0x44, 0x44, 0x44, 0x38,// o
el17m2h 0:40c03e733b77 516 0x7C, 0x14, 0x14, 0x14, 0x08,// p
el17m2h 0:40c03e733b77 517 0x08, 0x14, 0x14, 0x18, 0x7C,// q
el17m2h 0:40c03e733b77 518 0x7C, 0x08, 0x04, 0x04, 0x08,// r
el17m2h 0:40c03e733b77 519 0x48, 0x54, 0x54, 0x54, 0x20,// s
el17m2h 0:40c03e733b77 520 0x04, 0x3F, 0x44, 0x40, 0x20,// t
el17m2h 0:40c03e733b77 521 0x3C, 0x40, 0x40, 0x20, 0x7C,// u
el17m2h 0:40c03e733b77 522 0x1C, 0x20, 0x40, 0x20, 0x1C,// v
el17m2h 0:40c03e733b77 523 0x3C, 0x40, 0x30, 0x40, 0x3C,// w
el17m2h 0:40c03e733b77 524 0x44, 0x28, 0x10, 0x28, 0x44,// x
el17m2h 0:40c03e733b77 525 0x0C, 0x50, 0x50, 0x50, 0x3C,// y
el17m2h 0:40c03e733b77 526 0x44, 0x64, 0x54, 0x4C, 0x44,// z
el17m2h 0:40c03e733b77 527 0x00, 0x08, 0x36, 0x41, 0x00,// {
el17m2h 0:40c03e733b77 528 0x00, 0x00, 0x7F, 0x00, 0x00,// |
el17m2h 0:40c03e733b77 529 0x00, 0x41, 0x36, 0x08, 0x00,// }
el17m2h 0:40c03e733b77 530 0x08, 0x08, 0x2A, 0x1C, 0x08,// ->
el17m2h 0:40c03e733b77 531 0x08, 0x1C, 0x2A, 0x08, 0x08 // <-
el17m2h 0:40c03e733b77 532 };
el17m2h 0:40c03e733b77 533
el17m2h 0:40c03e733b77 534 #endif