ELEC2645 (2017/18) / Mbed 2 deprecated ll14zs

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

Fork of ll14zs by Zeshaan Saeed

N5110/N5110.h@3:1231a3961984, 2018-05-24 (annotated)

Committer:
ll14zs
Date:
Thu May 24 17:37:17 2018 +0000
Revision:
3:1231a3961984
Parent:
0:2211174dee1c 
Final Submission. I have read and agreed with Statement of Academic Integrity

Who changed what in which revision?

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