Classes
class	QuiesceDebouncer
	This debouncer will update state if for N consecutive attempts the input value is the same. More...

class	CountingDebouncer
	This debouncer will count the ON values and if the number of ON values in a given window exceeds a threshold, then triggers. More...

struct	CountingDebouncer::Options
	Static parameters for the CountingDebouncer. More...

class	ToggleDebouncer< Debouncer >
	This class acts as a debouncer that uses one momentary input button, and switches the event state at every rising edge of that input button. More...

Detailed Description

Copyright: Copyright (c) 2014, Balazs Racz All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Strategy classes for debouncing inputs.

A Debouncer is a class that input object will use as a template. The debouncer class may have arbitrary class-local state, and there will be one object of it per input bit. The debouncer will be periodically updated when polling the input state. For each update the debouncer has to decide whether the state has changed (and the new update should be published) or the state has not changed or the update shold be ignored.

A debouncer class has to have the following public methods:

// A structure that captures the parameters. typedef ... Options;

// Constructor from the parameters. explicit Debouncer(const Options& opts);

// returns the last known state bool current_state();

// called once after construction void initialize(bool state);

// called when an on-network event comes to change the state void override(bool new_state);

// returns true if measurement should be published as the new state. bool update_state(bool measurement);

Author: Balazs Racz

Date: 13 Jul 2014

Definition in file Debouncer.hxx.

Classes

Detailed Description