Serial Wombat Arduino Library
src
SerialWombatAbstractButton.h
Go to the documentation of this file.
1
#pragma once
2
/*
3
Copyright 2021 Broadwell Consulting Inc.
4
5
"Serial Wombat" is a registered trademark of Broadwell Consulting Inc. in
6
the United States. See SerialWombat.com for usage guidance.
7
8
Permission is hereby granted, free of charge, to any person obtaining a
9
* copy of this software and associated documentation files (the "Software"),
10
* to deal in the Software without restriction, including without limitation
11
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
12
* and/or sell copies of the Software, and to permit persons to whom the
13
* Software is furnished to do so, subject to the following conditions:
14
15
The above copyright notice and this permission notice shall be included in
16
* all copies or substantial portions of the Software.
17
18
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
22
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
23
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
24
* OTHER DEALINGS IN THE SOFTWARE.
25
*/
26
27
#include "
SerialWombat.h
"
28
#include "limits.h"
29
34
class
SerialWombatAbstractButton
39
{
40
public
:
41
42
SerialWombatAbstractButton
();
47
virtual
bool
digitalRead
() = 0;
48
54
virtual
uint16_t
readDurationInTrueState_mS
() = 0;
60
virtual
uint16_t
readDurationInFalseState_mS
() = 0;
61
63
uint16_t
transitions
= 0;
64
72
virtual
bool
readTransitionsState
() = 0;
73
74
};
75
76
SerialWombatAbstractButton::readDurationInFalseState_mS
virtual uint16_t readDurationInFalseState_mS()=0
return the number of mS that the input has been in false state
SerialWombat.h
SerialWombatAbstractButton::transitions
uint16_t transitions
Number of transitions returned by last call to readTransitionsState()
Definition:
SerialWombatAbstractButton.h:63
SerialWombatAbstractButton::digitalRead
virtual bool digitalRead()=0
Returns the state of the input.
SerialWombatAbstractButton::readDurationInTrueState_mS
virtual uint16_t readDurationInTrueState_mS()=0
return the number of mS that the input has been in true state
SerialWombatAbstractButton::readTransitionsState
virtual bool readTransitionsState()=0
Queries the number of transistions that have occured on the debounced input.
SerialWombatAbstractButton::SerialWombatAbstractButton
SerialWombatAbstractButton()
Definition:
SerialWombatAbstractButton.cpp:3
SerialWombatAbstractButton
SerialWombat18CapTouch, SerialWombatDebouncedInput and SerialWombatMatrixButton inherit from this cla...
Definition:
SerialWombatAbstractButton.h:38
Generated by
1.8.17