ELEC2645 (2019/20) / Mbed 2 deprecated ELEC2645_Project_el17sdl_v2

Samuel Lashmar 201170334

Dependencies:   mbed

Gamepad2/N5110.h@15:3a65925ac561, 2020-05-24 (annotated)

Committer:
sdlashmar
Date:
Sun May 24 15:37:19 2020 +0000
Revision:
15:3a65925ac561
Parent:
1:5aba5e5a748b 
Final Submission. I have read and agreed with Statement of Academic Integrity

Who changed what in which revision?

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