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@45:97e54ea40dac, 2017-11-06 (annotated)

Committer:
eencae
Date:
Mon Nov 06 11:48:22 2017 +0000
Revision:
45:97e54ea40dac
Parent:
44:57f9d32fb521
Child:
46:6de3ebf5b195
Added example for new setContrast method. This can be used to set contrast in range of 0.0 to 1.0. 0.4 appears to be a decent default, but may need tweaking for different displays.; ; The init method also includes private methods that can be tweaked.

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