sbl::components::control::EncoderStep Class Reference

#include <encoder_step.hpp>

Collaboration diagram for sbl::components::control::EncoderStep:

Public Member Functions
	EncoderStep (int8_t divisor=4)
int8_t	process (int32_t raw_delta)
	Feed raw encoder delta, returns step (-1, 0, or +1).
int8_t	accumulator () const
	Current accumulator value.
void	reset ()
	Reset accumulator to zero.

Detailed Description

Definition at line 23 of file encoder_step.hpp.

Constructor & Destructor Documentation

EncoderStep()

sbl::components::control::EncoderStep::EncoderStep ( int8_t  divisor = 4 )

inlineexplicit

Parameters

divisor

Pulses per detent (e.g., 4 for EC11). Must be >= 1.

Definition at line 26 of file encoder_step.hpp.

Member Function Documentation

accumulator()

int8_t sbl::components::control::EncoderStep::accumulator ( ) const

inline

Current accumulator value.

Definition at line 44 of file encoder_step.hpp.

process()

int8_t sbl::components::control::EncoderStep::process ( int32_t  raw_delta )

inline

Feed raw encoder delta, returns step (-1, 0, or +1).

Definition at line 30 of file encoder_step.hpp.

reset()

void sbl::components::control::EncoderStep::reset ( )

inline

Reset accumulator to zero.

Definition at line 47 of file encoder_step.hpp.

---

The documentation for this class was generated from the following file:

• src/sbl/components/control/encoder_step.hpp