Craig Evans / N5110

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

Dependents:   LV7_LCDtest LV7_Grupa5_Tim003_Zadatak1 lv7_Grupa5_Tim008_zad1 LV7_PAI_Grupa5_tim10_Zadatak1 ... more

This library is designed to make it easy to interface an mbed with a Nokia 5110 LCD display.

These can be found at Sparkfun (https://www.sparkfun.com/products/10168) and Adafruit (http://www.adafruit.com/product/338).

The library uses the SPI peripheral on the mbed which means it is much faster sending data to the display than other libraries available on other platforms that use software SPI.

The library can print strings as well as controlling individual pixels, meaning that both text and primitive graphics can be displayed.

N5110.h@35:2d5931a66fba, 2017-03-07 (annotated)

Committer:
eencae
Date:
Tue Mar 07 16:46:13 2017 +0000
Revision:
35:2d5931a66fba
Parent:
33:d80e568a2e18
Child:
36:00ebd449b6f3
Added sprite support (untested).

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