An interface for a simple, 1-track, incremental encoder.

Dependents:   AVC_20110423 incrementalencoder-pid-robot DataBus2018

IncrementalEncoder.h

Committer:
shimniok
Date:
11 months ago
Revision:
1:5011d894d5a7
Parent:
0:dea4a931b267

File content as of revision 1:5011d894d5a7:

#include "mbed.h"

/** An interface for a simple, 1-track, incremental encoder. If using a simple reflectance sensor, then a voltage comparator
 *  circuit will be required to generate the pulsetrain.  See: http://www.bot-thoughts.com/2011/03/avc-bot-wheel-encoders.html
 *
 */
class IncrementalEncoder
{
    public:
        /** Create an incremental encoder interface.  Increments counter at every rise and fall signal 
         *
         * @param pin -- the pin to which a digital pulsetrain is sent
         */
        IncrementalEncoder(PinName pin);

        /** Get ticks since last call
         *
         * @returns the number of ticks since the last call to this method
         */        
        unsigned int read();

        /** Get total tick count since last reset
         *
         * @returns total ticks since the last reset or instantiation
         */
        unsigned int readTotal();
       
        /** Reset the tick counter
         *
         */
        void reset();

    private:
        unsigned int _lastTicks;
        unsigned int _ticks;
        InterruptIn _interrupt;
        void _increment();
};