Jack Cripps / N5110

Library for interfacing to Nokia 5110 LCD display (as found on the SparkFun website).

Fork of N5110 by Craig Evans

N5110.h@42:596c207519de, 2017-03-21 (annotated)

Committer:
valavanisalex
Date:
Tue Mar 21 10:43:19 2017 +0000
Revision:
42:596c207519de
Parent:
40:c9262294f2e1
Child:
44:cd9bc22f656d
setPixel() now accepts a state parameter.  clearPixel() deprecated

Who changed what in which revision?

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