(DA) Internet of Things and Smart Electronics- ELE3006M2122 / Mbed 2 deprecated Project-Target-Localization

Resit Target Localisation Ciaran Kane 18689005

Dependencies:   mbed

N5110/N5110.h@7:acf82069b794, 23 months ago (annotated)

Committer:
ciarankane123
Date:
Thu Aug 25 13:50:39 2022 +0000
Revision:
7:acf82069b794
Final Code;

Who changed what in which revision?

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