ELEC2645 (2018/19) / Mbed 2 deprecated el17st

Dependencies:   mbed FATFileSystem

Committer:
rottenegg
Date:
Wed May 08 00:30:09 2019 +0000
Revision:
17:7d4d8905b608
Parent:
N5110_Modded/N5110.h@1:0efd25071a6d
All Libraries: Huge Bug due to previous changes that causes unexpected crash.; WDplayer: Tuned to meet 20 lines per function criteria;

Who changed what in which revision?

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