Diff: EPD_GDE021A1.h

Revision:

1:6ee9c1afd6ec

Parent:

0:5d8241e6bd3b

--- a/EPD_GDE021A1.h	Tue Apr 28 11:37:05 2015 +0000
+++ b/EPD_GDE021A1.h	Tue Apr 28 12:02:43 2015 +0000
@@ -42,6 +42,38 @@
 
 /**
  * ePaperDisplay on SPI
+ *
+ * Example:
+ * @code
+ * #include "mbed.h"
+ * #include "EPD_GDE021A1.h"
+ *
+ * #define EPD_CS       PA_15
+ * #define EPD_DC       PB_11
+ * #define EPD_RESET    PB_2
+ * #define EPD_BUSY     PA_8
+ * #define EPD_POWER    PB_10
+ * #define EPD_SPI_MOSI PB_5
+ * #define EPD_SPI_MISO PB_4
+ * #define EPD_SPI_SCK  PB_3
+ * 
+ * EPD_GDE021A1 epd(EPD_CS, EPD_DC, EPD_RESET, EPD_BUSY, EPD_POWER, EPD_SPI_MOSI, EPD_SPI_MISO, EPD_SPI_SCK);
+ * 
+ * int main()
+ * {
+ *   epd.Clear(EPD_COLOR_WHITE);  
+ *   epd.DisplayStringAtLine(5, (uint8_t*)"MBED", CENTER_MODE);
+ *   epd.DisplayStringAtLine(3, (uint8_t*)"Epaper display", LEFT_MODE);
+ *   epd.DisplayStringAtLine(2, (uint8_t*)"demo", LEFT_MODE);
+ *   epd.RefreshDisplay();
+ *   wait(2);
+ *  
+ *   while(1) {
+ *     led1 = !led1;
+ *     wait(1);
+ *   }
+ * }
+ * @endcode
  */
 class EPD_GDE021A1
 {