ELEC2645 (2019/20) / Mbed 2 deprecated ELEC2645_Project_el19my

Dependencies:   mbed ELEC2645_Project_el17my

Committer:
yumaowei
Date:
Sat May 09 06:53:41 2020 +0000
Revision:
1:df66be0b5b8b
initial commit

Who changed what in which revision?

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