Jahanzeb Khan / Mbed 2 deprecated ELEC2645_Project_el19jak

Dependencies:   mbed

Committer:
jahanzebkhan
Date:
Sat May 30 21:10:30 2020 +0000
Revision:
1:0648f0052827
Innitial Commit

Who changed what in which revision?

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