Basic library to interface a 2 channel quadrature encoder with mBed

Embed: (wiki syntax)

« Back to documentation index

QuadratureEncoder Class Reference

QuadratureEncoder Class Reference

QuadrtureEncoder class. More...

#include <QuadratureEncoder.h>

Public Member Functions

 QuadratureEncoder (PinName pinA, PinName pinB)
 Create QuadratureEncode instance.
int getTicks ()
 Return the total number of pulses sent by the encoder.
void reset ()
 Set the total number of ticks back to 0.

Detailed Description

QuadrtureEncoder class.

Used to interface with quadrature encoder.

Definition at line 14 of file QuadratureEncoder.h.


Constructor & Destructor Documentation

QuadratureEncoder ( PinName  pinA,
PinName  pinB 
)

Create QuadratureEncode instance.

Parameters:
pinAPin to which is connected channel A of the encoder
pinBPin to which is connected channel Bof the encoder

Definition at line 3 of file QuadratureEncoder.cpp.


Member Function Documentation

int getTicks (  )

Return the total number of pulses sent by the encoder.

Definition at line 10 of file QuadratureEncoder.cpp.

void reset (  )

Set the total number of ticks back to 0.

Definition at line 15 of file QuadratureEncoder.cpp.