(DA) Internet of Things and Smart Electronics- ELE3006M2122 / Mbed 2 deprecated IOTProject_LC1

legionella detector

Dependencies:   mbed

N5110/N5110.h@0:089b4c4f2b6f, 23 months ago (annotated)

Committer:
lewiscameron
Date:
Tue Aug 23 08:47:11 2022 +0000
Revision:
0:089b4c4f2b6f
h

Who changed what in which revision?

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