Diff: button.h

Revision:

1:20c8438edaee

Parent:

0:f57033bb0e05

Child:

2:df827b705b98

--- a/button.h	Sun Jul 13 05:12:21 2014 +0000
+++ b/button.h	Wed Aug 06 23:44:39 2014 +0000
@@ -3,19 +3,43 @@
 
 #include "mbed.h"
 
-/** class to make 
- *   The class use 
+/** class to handle button input 
+ *   The class use DigitalIn and Ticker
+ *
+ * Refered to: http://elm-chan.org/docs/tec/te03.html
  *
  * Example:
  * @code
+ * // Button sample
+ * #include "mbed.h"
+ * #include "button.h"
+ * 
+ * BTN btn(dp13);
+ * 
+ * int main()
+ * {
+ *     int mode = 0;
+ *     int value;
+ * 
+ *     btn.CMD = 0;
+ *     while(1) {
+ *         if(btn.CMD) {
+ *             mode++;
+ *             btn.CMD = 0;
+ *             srand( time(NULL) );
+ *         }
+ *         if (mode % 2) value = rand();
+ *     }
+ * }
  * @endcode
  */
 
+#define BTN_SAMPLING_PERIOD 0.01
 
 namespace mbed {
 
 /* Class: BTN
- *  A class witch uses 
+ *  A class which uses DigitalIn and Ticker
  */
 class BTN {