Embedded Template Library 1.0
etl::debounce< VALID_COUNT, HOLD_COUNT, 0 > Class Template Reference

#include <debounce.h>

Public Member Functions

 debounce (bool initial_state=false)
 Constructor.
 
bool add (bool sample)
 
- Public Member Functions inherited from etl::private_debounce::debounce_base
void add_sample (bool sample)
 
bool has_changed () const
 
bool is_set () const
 
bool is_held () const
 
bool is_repeating () const
 

Additional Inherited Members

- Public Types inherited from etl::private_debounce::debounce_base
typedef uint_least8_t flags_t
 
typedef uint16_t count_t
 
- Protected Types inherited from etl::private_debounce::debounce_base
enum  states {
  Off = 0 , On = 1 , Held = 2 , Repeating = 3 ,
  State = 0x03U , Sample = 4 , Change = 8
}
 
- Protected Member Functions inherited from etl::private_debounce::debounce3
 debounce3 (bool initial_state)
 
 ~debounce3 ()
 Destructor.
 
void set_state (bool sample, bool condition_set, bool condition_clear)
 
bool process (bool sample, count_t valid_count, count_t hold_count)
 
- Protected Member Functions inherited from etl::private_debounce::debounce_base
 debounce_base (bool initial_state)
 Constructor.
 
 ~debounce_base ()
 Destructor.
 
void get_next (bool sample, bool condition_set, bool condition_clear, const uint_least8_t state_table[][2])
 Gets the next state based on the inputs.
 
- Protected Attributes inherited from etl::private_debounce::debounce_base
flags_t flags
 
count_t count
 

Detailed Description

template<const uint16_t VALID_COUNT, const uint16_t HOLD_COUNT>
class etl::debounce< VALID_COUNT, HOLD_COUNT, 0 >

A class to debounce signals. Fixed Valid/Hold values.

Member Function Documentation

◆ add()

template<const uint16_t VALID_COUNT, const uint16_t HOLD_COUNT>
bool etl::debounce< VALID_COUNT, HOLD_COUNT, 0 >::add ( bool  sample)
inline

Adds a new sample. Returns 'true' if the debouncer changes state from...

  1. Clear to Set.
  2. Set to Clear.
  3. Not Held to Held.
    Parameters
    sampleThe new sample.
    Returns
    'true' if the debouncer changed state.

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