ELEC2645 (2017/18) / Mbed 2 deprecated el16a2t

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

N5110/N5110.h@0:1a1863a687d3, 2018-04-17 (annotated)

Committer:
el16a2t
Date:
Tue Apr 17 08:33:39 2018 +0000
Revision:
0:1a1863a687d3
initial commit

Who changed what in which revision?

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