modm API documentation
Public Typedefs | Public Member Functions | List of all members
modm::BitBangEncoderInput< SignalA, SignalB, PRESCALER, DeltaType > Class Template Reference
External Device Drivers » Quadrature Encoder Input

This driver decodes a AB (incremental) encoder signal. More...

#include <modm/driver/encoder/bitbang_encoder_input.hpp>

Public Typedefs

using InputType = modm::platform::Gpio::InputType
 

Public Member Functions

void initialize (const modm::platform::Gpio::InputType inputType=modm::platform::Gpio::InputType::PullUp)
 
void update ()
 
DeltaType getDelta ()
 

Detailed Description

template<typename SignalA, typename SignalB, uint8_t PRESCALER = 4, std::signed_integral DeltaType = int8_t>
class modm::BitBangEncoderInput< SignalA, SignalB, PRESCALER, DeltaType >

This driver decodes a AB (incremental) encoder signal.

Author
Thomas Sommer
Template Parameters
SignalAFirst modm::platform::Gpio pin to input the encoder signal.
SignalBSecond modm::platform::Gpio pin to input the encoder signal.
PRESCALERn_cycles to count as one in-/decrement.
DeltaTypeMust be signed integral and fit at least PRESCALER. The Bigger DeltaType, the more inc-/decrements can be stored temporarily.
ValueTypeMust be unsigned integral.
The documentation for this class was generated from the following file: