ELEC2645 (2016/17) / Mbed 2 deprecated 2645_Project_el15as

Dependencies:   mbed

Committer:
el15as
Date:
Fri May 05 12:14:48 2017 +0000
Revision:
15:e3fc18eb519e
Final version

Who changed what in which revision?

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