This includes all known improvements from other people's spins on the Nokia library, including Alistair Popple's fix to the very poor contrast on newer LCD 6100 displays.

Fork of NokiaLCD by Iftekhar Choudhury

Files at this revision

API Documentation at this revision

Comitter:
simon
Date:
Fri Nov 19 22:12:28 2010 +0000
Parent:
1:8f005b0dcfa7
Child:
3:ea0c085881f3
Commit message:
Update to include doxygen documentation

Changed in this revision

NokiaLCD.h Show annotated file Show diff for this revision Revisions of this file
--- a/NokiaLCD.h	Fri Nov 19 22:07:46 2010 +0000
+++ b/NokiaLCD.h	Fri Nov 19 22:12:28 2010 +0000
@@ -31,11 +31,12 @@
  * #include "mbed.h"
  * #include "NokiaLCD.h"
  *
- * NokiaLCD lcd(p5, p7, p8, p9); // mosi, sclk, cs, rst
+ * NokiaLCD lcd(p5, p7, p8, p9, NokiaLCD::6610); // mosi, sclk, cs, rst, type
  *
  * int main() {
  *     lcd.printf("Hello World!");
  * }
+ * @endcode
  */
 class NokiaLCD : public Stream {
 
@@ -82,7 +83,22 @@
     /** Clear the screen and locate to 0,0 */
     void cls();
 
+    /** Set a pixel on te screen
+     * 
+     * @param x horizontal position from left
+     * @param y vertical position from top
+     * @param colour 24-bit colour in format 0x00RRGGBB
+     */
     void pixel(int x, int y, int colour);
+    
+    /** Fill an area of the screen
+     * 
+     * @param x horizontal position from left
+     * @param y vertical position from top
+     * @param width width in pixels
+     * @param height height in pixels
+     * @param colour 24-bit colour in format 0x00RRGGBB
+     */    
     void fill(int x, int y, int width, int height, int colour);
 
     void blit(int x, int y, int width, int height, const int* colour);
@@ -95,7 +111,16 @@
 
     void reset();
 
+    /** Set the foreground colour
+     * 
+     * @param c 24-bit colour
+     */
     void foreground(int c);
+
+    /** Set the background colour
+     * 
+     * @param c 24-bit colour
+     */
     void background(int c);
 
 protected: