ELEC2645 (2019/20) / Mbed 2 deprecated ELEC2645_Project_el18jkeo

Joshua O'hara 201291390

Dependencies:   mbed

Gamepad2/N5110.h@44:3b904d25ee12, 2020-05-26 (annotated)

Committer:
josh_ohara
Date:
Tue May 26 15:15:46 2020 +0000
Revision:
44:3b904d25ee12
Parent:
1:9b659b3c092b 
Final Submission. I have read and agreed with Statement of Academic Integrity.

Who changed what in which revision?

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