upm  1.7.1
Sensor/Actuator repository for libmraa (v2.0.0)
wfs.hpp
1 /*
2  * Author: Jon Trulson <jtrulson@ics.com>
3  * Copyright (c) 2015-2017 Intel Corporation.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining
6  * a copy of this software and associated documentation files (the
7  * "Software"), to deal in the Software without restriction, including
8  * without limitation the rights to use, copy, modify, merge, publish,
9  * distribute, sublicense, and/or sell copies of the Software, and to
10  * permit persons to whom the Software is furnished to do so, subject to
11  * the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 #pragma once
25 
26 #include "wfs.h"
27 
28 namespace upm {
29 
65 class WFS {
66  public:
72  WFS(int pin);
76  ~WFS();
77 
84  uint32_t getMillis();
85 
90  void initClock();
91 
98 
103  void startFlowCounter();
104 
109  void stopFlowCounter();
110 
116  uint32_t flowCounter() { return wfs_flow_counter(m_wfs); };
117 
126  float flowRate();
127 
128  protected:
129  wfs_context m_wfs;
130 
131  private:
132  /* Disable implicit copy and assignment operators */
133  WFS(const WFS&) = delete;
134  WFS &operator=(const WFS&) = delete;
135 };
136 }
uint32_t flowCounter()
Definition: wfs.hpp:116
void clearFlowCounter()
Definition: wfs.hpp:97
void wfs_clear_flow_counter(const wfs_context dev)
Definition: wfs.c:101
uint32_t getMillis()
Definition: wfs.cxx:52
uint32_t wfs_flow_counter(const wfs_context dev)
Definition: wfs.c:136
void stopFlowCounter()
Definition: wfs.cxx:64
void initClock()
Definition: wfs.cxx:47
C++ API wrapper for the bh1749 driver.
Definition: a110x.hpp:29
WFS (Water Flow Sensor)
API for the Water Flow Sensor.
Definition: wfs.hpp:65
void startFlowCounter()
Definition: wfs.cxx:57
float flowRate()
Definition: wfs.cxx:69
Definition: wfs.h:49
~WFS()
Definition: wfs.cxx:42
WFS(int pin)
Definition: wfs.cxx:34