Revision 1:03519229f093, committed 2014-05-06

Comitter:

k4zuki

Date:

Tue May 06 16:26:37 2014 +0000

Parent:

0:06927342f2f1

Commit message:

made Class reference

Changed in this revision

diff -r 06927342f2f1 -r 03519229f093 AkiSpiLcd.h
--- a/AkiSpiLcd.h	Tue May 06 14:44:56 2014 +0000
+++ b/AkiSpiLcd.h	Tue May 06 16:26:37 2014 +0000
@@ -7,11 +7,39 @@
 class AkiSpiLcd
 {
 public:
+    /* Constructor
+    @param mosi SPI data input
+    @param sck SPI clock input
+    @param cs HIGH-active chip enable input
+    @param disp HIGH-active display enable input
+    */
     AkiSpiLcd(PinName mosi,PinName sck, PinName cs, PinName disp);
+    
+    /*
+    Clear screen
+    */
     void cls();
+    
+    /*Writes single line(400 bits = 50 bytes)
+    @param line line number(1-240)
+    @param *data pointer to data
+    */
     void updateSingle(int line, uint8_t* data);
+
+    /*Writes multi lines(400 x N bits = 50 x N bytes)
+    @param line line number(1-240)
+    @param length number of line to write
+    @param *data pointer to data
+    */
     void updateMulti(int line, int length, uint8_t* data);
+    
+    /*inverting internal COM signal
+    */
     void cominvert();
+    
+    /*Enables/disables display. internal memory will not flushed
+    @param disp true = display is on / false = display is off
+    */
     void dispOn(bool disp);
 private:
     int comflag;