David Leaming / N5110v02

Library for interfacing to Nokia 5110 LCD display (as found on the SparkFun website). Used & amended by D.Leaming, University of Lincoln, December 2021 v01

N5110.h@53:200be703ee3b, 2021-12-17 (annotated)

Committer:
legstar85
Date:
Fri Dec 17 08:26:58 2021 +0000
Revision:
53:200be703ee3b
Parent:
52:09994ce3be7b 
Used & amended by D.Leaming, University of Lincoln, December 2021

Who changed what in which revision?

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