Easyuino  1.2.0
WaterFlowMeter.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 WaterFlowMeter.h
26 */
27 #ifndef _EASYUINO_WATER_FLOW_METER_h
28 #define _EASYUINO_WATER_FLOW_METER_h
29 
30 #include "Utilities.h"
31 #include "WaterFlowSensor.h"
32 
36 #define MIN_TIME_BETWEEN_UPDATES 1000
37 
38 namespace Easyuino {
39 
47 
48  private:
50  float _sensorCalibrationFactor;
51 
53  float _cachedFlowRate;
55  volatile bool _isDirtyFlowRate;
56 
58  volatile unsigned long _previousMeasurementPulses;
60  volatile unsigned long _previousMeasurementDuration;
61 
63  volatile unsigned long _currentMeasurementPulseCounter;
65  volatile unsigned long _currentMeasurementInitialTimestamp;
66 
67  public:
73  WaterFlowMeter(IN uint8_t sensorPin, IN float sensorCalibrationFactor);
74 
77 
78  bool begin();
79 
80  void end();
81 
85  float getFlowRateLitersMin();
86 
87  protected:
88  void pulseHandler(IN unsigned long callTimestamp);
89 
90  };
91 
92 };
93 
94 #endif
void end()
Used to stop the device API.
float getFlowRateLitersMin()
Returns the current flow rate that is passing through the flow meter.
WaterFlowMeter(IN uint8_t sensorPin, IN float sensorCalibrationFactor)
Constructor.
Definition: Button.h:38
~WaterFlowMeter()
Destructor.
bool begin()
Used to put the device ready to receive requests.
WaterFlowMeter API extends the WaterFlowSensor API adding the possiblity to know how much water is fl...
Definition: WaterFlowMeter.h:46
void pulseHandler(IN unsigned long callTimestamp)
Called by the interruption ISR for each pulse.
WaterFlowSensor is an API offers the ability to know if it is flowing something through the sensor or...
Definition: WaterFlowSensor.h:43