modm API documentation
modm::ui::Pulse< T > Class Template Reference

#include <modm/ui/animation/pulse.hpp>

Public Member Functions

 Pulse (Animation< T > &animator)
 
void setPeriod (TimeType period, uint8_t dutyCycle=50)
 
void setRange (T minValue, T maxValue)
 
void start (uint8_t repeat=0)
 start indicating for ever
 
void stop ()
 Stops indicating after finishing the current cycle.
 
bool isAnimating () const
 
void update ()
 Must be called at least every ms.
 

Detailed Description

template<typename T = uint8_t>
class modm::ui::Pulse< T >

This class animates a value up and down during the period.

|--| duty cycle
/ /
/ /
/ /
/ / ...
|------| period
Author
Niklas Hauser

Member Function Documentation

template<typename T = uint8_t>
void modm::ui::Pulse< T >::setPeriod ( TimeType  period,
uint8_t  dutyCycle = 50 
)
inline
Parameters
periodin ms
dutyCyclein percent <= 100

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