Karl Zweimüller / mRotaryEncoder

Class mRotaryEncoder for mechanical incremental rotary encoders with pushbuttons. Use debouncing and callback-functions for rotation and pressing of button. This version is for old mbed. New version for mbed-os see https://os.mbed.com/users/charly/code/mRotaryEncoder-os/

Dependencies:   PinDetect

Dependents:   SimplePIDBot FinalProgram VS1053Player SPK-DVIMXR ... more

Diff: mRotaryEncoder.h

Revision:
8:41c44b127443
Parent:
7:ec80fd9c0c08
Child:
11:24b34deae975
--- a/mRotaryEncoder.h	Wed Mar 11 21:45:46 2015 +0000
+++ b/mRotaryEncoder.h	Wed Mar 11 21:51:10 2015 +0000
@@ -98,7 +98,7 @@
 
     /**  callback-System for rotation of shaft
     *
-    *  attach a function to be called when the shaft is rotaded
+    *  attach a function to be called when the shaft is rotated
     *  keep this function short, as no interrrupts can occour within
     *
     * @param fprt Pointer to callback-function
@@ -109,7 +109,7 @@
 
 
     template<typename T>
-    /** attach an object member function to be called when shaft is rotaded
+    /** attach an object member function to be called when shaft is rotated
     *
     * @param tptr pointer to object
     * @param mprt pointer ro member function
@@ -123,7 +123,7 @@
 
    /**  callback-System for rotation of shaft CW
     *
-    *  attach a function to be called when the shaft is rotaded clockwise
+    *  attach a function to be called when the shaft is rotated clockwise
     *  keep this function short, as no interrrupts can occour within
     *
     * @param fprt Pointer to callback-function
@@ -134,7 +134,7 @@
 
 
     template<typename T>
-    /** attach an object member function to be called when shaft is rotaded clockwise
+    /** attach an object member function to be called when shaft is rotated clockwise
     *
     * @param tptr pointer to object
     * @param mprt pointer ro member function
@@ -148,7 +148,7 @@
 
    /**  callback-System for rotation of shaft CCW
     *
-    *  attach a function to be called when the shaft is rotaded counterclockwise
+    *  attach a function to be called when the shaft is rotated counterclockwise
     *  keep this function short, as no interrrupts can occour within
     *
     * @param fprt Pointer to callback-function
@@ -159,7 +159,7 @@
 
 
     template<typename T>
-    /** attach an object member function to be called when shaft is rotaded CCW
+    /** attach an object member function to be called when shaft is rotated CCW
     *
     * @param tptr pointer to object
     * @param mprt pointer ro member function
@@ -189,11 +189,18 @@
       * Callback system.
       * @ingroup INTERNALS
       */
-    // rotated any direction
+    /**
+     * rotated any direction
+    */
     FunctionPointer rotIsr;
-    // clockwise rotated
+    /**
+     * clockwise rotated
+    */
     FunctionPointer rotCWIsr;
-    //counterclockwise rotated
+
+    /**
+     * counterclockwise rotated
+    */    
     FunctionPointer rotCCWIsr;