Easyuino  1.2.0
WaterFlowSensor.h
1 /*
2 MIT License
3 
4 Copyright (c) 2017 André Pires
5 
6 Permission is hereby granted, free of charge, to any person obtaining a copy
7 of this software and associated documentation files (the "Software"), to deal
8 in the Software without restriction, including without limitation the rights
9 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 copies of the Software, and to permit persons to whom the Software is
11 furnished to do so, subject to the following conditions:
12 
13 The above copyright notice and this permission notice shall be included in all
14 copies or substantial portions of the Software.
15 
16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 SOFTWARE.
23 */
24 /*
25 WaterFlowSensor.h
26 */
27 #ifndef _EASYUINO_WATER_FLOW_SENSOR_h
28 #define _EASYUINO_WATER_FLOW_SENSOR_h
29 
30 #include "Utilities.h"
31 #include "Device.h"
32 
33 #define PULSE_TIMEOUT 500
34 
35 namespace Easyuino {
36 
43  class WaterFlowSensor : public Device {
44 
45  private:
47  static WaterFlowSensor* Singleton;
48 
49  protected:
51  uint8_t _sensorPin;
52 
54  volatile unsigned long _lastPulseTimestamp;
55 
56  public:
60  WaterFlowSensor(IN uint8_t sensorPin);
61 
64 
65  bool begin();
66 
67  void end();
68 
72  bool isFlowing() const;
73 
74  protected:
76  virtual void pulseHandler(IN unsigned long callTimestamp);
77 
78  private:
80  static void InterruptCaller();
81 
82  };
83 
84 };
85 
86 #endif
bool begin()
Used to put the device ready to receive requests.
bool isFlowing() const
Checks if there there are flow in the sensor.
~WaterFlowSensor()
Destructor.
uint8_t _sensorPin
Arduino pin connected to the sensor pulse pin.
Definition: WaterFlowSensor.h:51
Definition: Button.h:38
virtual void pulseHandler(IN unsigned long callTimestamp)
Called by the interruption ISR for each pulse.
General class that provides the common API behaviour for all the devices/sensors. ...
Definition: Device.h:42
WaterFlowSensor(IN uint8_t sensorPin)
Constructor.
void end()
Used to stop the device API.
volatile unsigned long _lastPulseTimestamp
Timestamp with the last time a pulse was detected.
Definition: WaterFlowSensor.h:54
WaterFlowSensor is an API offers the ability to know if it is flowing something through the sensor or...
Definition: WaterFlowSensor.h:43