Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
EncoderCounter Class Reference
This class implements a driver to read the quadrature encoder counter of the STM32 microcontroller. More...
#include <EncoderCounter.h>
Public Member Functions | |
| EncoderCounter (PinName a, PinName b) | |
| Creates and initialises the driver to read the quadrature encoder counter of the STM32 microcontroller. | |
| virtual | ~EncoderCounter () |
| Deletes this EncoderCounter object. | |
| void | reset () |
| Resets the counter value to zero. | |
| void | reset (short offset) |
| Resets the counter value to a given offset value. | |
| short | read () |
| Reads the quadrature encoder counter value. | |
| operator short () | |
The empty operator is a shorthand notation of the read() method. | |
Detailed Description
This class implements a driver to read the quadrature encoder counter of the STM32 microcontroller.
Definition at line 17 of file EncoderCounter.h.
Constructor & Destructor Documentation
| EncoderCounter | ( | PinName | a, |
| PinName | b | ||
| ) |
Creates and initialises the driver to read the quadrature encoder counter of the STM32 microcontroller.
- Parameters:
-
a the input pin for the channel A. b the input pin for the channel B.
Definition at line 17 of file EncoderCounter.cpp.
| ~EncoderCounter | ( | ) | [virtual] |
Deletes this EncoderCounter object.
Definition at line 147 of file EncoderCounter.cpp.
Member Function Documentation
| operator short | ( | ) |
The empty operator is a shorthand notation of the read() method.
Definition at line 178 of file EncoderCounter.cpp.
| short read | ( | ) |
Reads the quadrature encoder counter value.
- Returns:
- the quadrature encoder counter as a signed 16-bit integer value.
Definition at line 170 of file EncoderCounter.cpp.
| void reset | ( | ) |
Resets the counter value to zero.
Definition at line 152 of file EncoderCounter.cpp.
| void reset | ( | short | offset ) |
Resets the counter value to a given offset value.
- Parameters:
-
offset the offset value to reset the counter to.
Definition at line 161 of file EncoderCounter.cpp.
Generated on Sat Jul 23 2022 17:01:00 by
1.7.2