Library to handle a quadrature encoder with interrupts
Encoder.h@0:d510e8063ad1, 2016-03-15 (annotated)
- Committer:
- wolfsberger
- Date:
- Tue Mar 15 08:30:32 2016 +0000
- Revision:
- 0:d510e8063ad1
Imported lib into MBED
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
wolfsberger | 0:d510e8063ad1 | 1 | #ifndef ENCODER_H_INCLUDED |
wolfsberger | 0:d510e8063ad1 | 2 | #define ENCODER_H_INCLUDED |
wolfsberger | 0:d510e8063ad1 | 3 | |
wolfsberger | 0:d510e8063ad1 | 4 | /** Class to handle a rotary encoder |
wolfsberger | 0:d510e8063ad1 | 5 | * The lib is interrupt based, therefore no update functions have to be called. |
wolfsberger | 0:d510e8063ad1 | 6 | * Example usage: |
wolfsberger | 0:d510e8063ad1 | 7 | * @code |
wolfsberger | 0:d510e8063ad1 | 8 | * |
wolfsberger | 0:d510e8063ad1 | 9 | * #include "mbed.h" |
wolfsberger | 0:d510e8063ad1 | 10 | * #include "Encoder.h" |
wolfsberger | 0:d510e8063ad1 | 11 | * |
wolfsberger | 0:d510e8063ad1 | 12 | * RotaryEncoder encoder(D3, D4); |
wolfsberger | 0:d510e8063ad1 | 13 | * |
wolfsberger | 0:d510e8063ad1 | 14 | * int main() |
wolfsberger | 0:d510e8063ad1 | 15 | * { |
wolfsberger | 0:d510e8063ad1 | 16 | * while(1) |
wolfsberger | 0:d510e8063ad1 | 17 | * { |
wolfsberger | 0:d510e8063ad1 | 18 | * int pos = encoder.position(); |
wolfsberger | 0:d510e8063ad1 | 19 | * wait(1.0f); |
wolfsberger | 0:d510e8063ad1 | 20 | * } |
wolfsberger | 0:d510e8063ad1 | 21 | * } |
wolfsberger | 0:d510e8063ad1 | 22 | * @endcode |
wolfsberger | 0:d510e8063ad1 | 23 | */ |
wolfsberger | 0:d510e8063ad1 | 24 | class RotaryEncoder { |
wolfsberger | 0:d510e8063ad1 | 25 | public: |
wolfsberger | 0:d510e8063ad1 | 26 | RotaryEncoder(PinName outa, PinName outb) |
wolfsberger | 0:d510e8063ad1 | 27 | : position_(0), delta_(0), |
wolfsberger | 0:d510e8063ad1 | 28 | inta_(outa), intb_(outb), outa_(outa), outb_(outb) { |
wolfsberger | 0:d510e8063ad1 | 29 | outa_.mode(PullUp); |
wolfsberger | 0:d510e8063ad1 | 30 | outb_.mode(PullUp); |
wolfsberger | 0:d510e8063ad1 | 31 | inta_.rise(this, &RotaryEncoder::handleIntA); |
wolfsberger | 0:d510e8063ad1 | 32 | inta_.fall(this, &RotaryEncoder::handleIntA); |
wolfsberger | 0:d510e8063ad1 | 33 | intb_.rise(this, &RotaryEncoder::handleIntB); |
wolfsberger | 0:d510e8063ad1 | 34 | intb_.fall(this, &RotaryEncoder::handleIntB); |
wolfsberger | 0:d510e8063ad1 | 35 | } |
wolfsberger | 0:d510e8063ad1 | 36 | |
wolfsberger | 0:d510e8063ad1 | 37 | /** Returns the overall position of the encoder |
wolfsberger | 0:d510e8063ad1 | 38 | */ |
wolfsberger | 0:d510e8063ad1 | 39 | int position() { |
wolfsberger | 0:d510e8063ad1 | 40 | return position_; |
wolfsberger | 0:d510e8063ad1 | 41 | } |
wolfsberger | 0:d510e8063ad1 | 42 | |
wolfsberger | 0:d510e8063ad1 | 43 | /** Returns the encoders change since the last call to this function |
wolfsberger | 0:d510e8063ad1 | 44 | */ |
wolfsberger | 0:d510e8063ad1 | 45 | int delta() { |
wolfsberger | 0:d510e8063ad1 | 46 | int d = delta_; |
wolfsberger | 0:d510e8063ad1 | 47 | delta_ = 0; |
wolfsberger | 0:d510e8063ad1 | 48 | return d; |
wolfsberger | 0:d510e8063ad1 | 49 | } |
wolfsberger | 0:d510e8063ad1 | 50 | |
wolfsberger | 0:d510e8063ad1 | 51 | private: |
wolfsberger | 0:d510e8063ad1 | 52 | |
wolfsberger | 0:d510e8063ad1 | 53 | // A = B --> Clockwise |
wolfsberger | 0:d510e8063ad1 | 54 | // A /= B --> Counter clockwise |
wolfsberger | 0:d510e8063ad1 | 55 | void handleIntA() { |
wolfsberger | 0:d510e8063ad1 | 56 | if (outa_ == outb_) { |
wolfsberger | 0:d510e8063ad1 | 57 | increment(1); |
wolfsberger | 0:d510e8063ad1 | 58 | } else { |
wolfsberger | 0:d510e8063ad1 | 59 | increment(-1); |
wolfsberger | 0:d510e8063ad1 | 60 | } |
wolfsberger | 0:d510e8063ad1 | 61 | } |
wolfsberger | 0:d510e8063ad1 | 62 | |
wolfsberger | 0:d510e8063ad1 | 63 | // A = B --> Counter clockwise |
wolfsberger | 0:d510e8063ad1 | 64 | // A /= B --> Clockwise |
wolfsberger | 0:d510e8063ad1 | 65 | void handleIntB() { |
wolfsberger | 0:d510e8063ad1 | 66 | if (outa_ == outb_) { |
wolfsberger | 0:d510e8063ad1 | 67 | increment(-1); |
wolfsberger | 0:d510e8063ad1 | 68 | } else { |
wolfsberger | 0:d510e8063ad1 | 69 | increment(1); |
wolfsberger | 0:d510e8063ad1 | 70 | } |
wolfsberger | 0:d510e8063ad1 | 71 | } |
wolfsberger | 0:d510e8063ad1 | 72 | |
wolfsberger | 0:d510e8063ad1 | 73 | void increment(int i) { |
wolfsberger | 0:d510e8063ad1 | 74 | position_ += i; |
wolfsberger | 0:d510e8063ad1 | 75 | delta_ += i; |
wolfsberger | 0:d510e8063ad1 | 76 | } |
wolfsberger | 0:d510e8063ad1 | 77 | |
wolfsberger | 0:d510e8063ad1 | 78 | int position_; |
wolfsberger | 0:d510e8063ad1 | 79 | int delta_; |
wolfsberger | 0:d510e8063ad1 | 80 | |
wolfsberger | 0:d510e8063ad1 | 81 | InterruptIn inta_; |
wolfsberger | 0:d510e8063ad1 | 82 | InterruptIn intb_; |
wolfsberger | 0:d510e8063ad1 | 83 | DigitalIn outa_; |
wolfsberger | 0:d510e8063ad1 | 84 | DigitalIn outb_; |
wolfsberger | 0:d510e8063ad1 | 85 | }; |
wolfsberger | 0:d510e8063ad1 | 86 | |
wolfsberger | 0:d510e8063ad1 | 87 | #endif /* ENCODER_H_INCLUDED */ |