ELEC2645 (2018/19) / Mbed 2 deprecated el17lw

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@29:bdc4138b5171, 2019-05-07 (annotated)

Committer:
lewisgw
Date:
Tue May 07 17:21:00 2019 +0000
Revision:
29:bdc4138b5171
Parent:
0:d74302f8f847 
Final Submission. I have read and agreed with the Statement of Academic Integrity.

Who changed what in which revision?

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