Owen Cavender 201159294

Dependencies:   mbed

Committer:
el17oc
Date:
Sat May 30 06:12:09 2020 +0000
Revision:
2:ffbfd3f53ee2
Parent:
1:897160a1a3ae
Final Submission. I have read and agreed with Statement of Academic Integrity

Who changed what in which revision?

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