Initial publish

Dependencies:   mbed

Fork of el17dg by Dmitrijs Griskovs

Committer:
Noximilien
Date:
Tue May 07 15:22:35 2019 +0000
Revision:
40:e3bbda7444fa
Parent:
9:5ad5501c702e
The Final, Submission Version. I have read and agreed to the academic integrity. SID:201160286

Who changed what in which revision?

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