Chen Zirui / Mbed 2 deprecated el18zc

Dependencies:   mbed

Committer:
ChenZirui
Date:
Sun May 03 10:29:54 2020 +0000
Revision:
1:86da5130732b
initial commit

Who changed what in which revision?

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