upm  1.6.0
Sensor/Actuator repository for libmraa (v1.9.0)
grovewfs.hpp
1 /*
2  * Author: Jon Trulson <jtrulson@ics.com>
3  * Copyright (c) 2015 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 <string>
27 #include <stdint.h>
28 #include <sys/time.h>
29 #include <mraa/gpio.h>
30 
31 namespace upm {
32 
69  class GroveWFS {
70  public:
76  GroveWFS(int pin);
80  ~GroveWFS();
87  uint32_t getMillis();
88 
93  void initClock();
94 
100  void clearFlowCounter() { m_flowCounter = 0; };
101 
106  void startFlowCounter();
107 
112  void stopFlowCounter();
113 
119  uint32_t flowCounter() { return m_flowCounter; };
120 
126  float flowRate();
127 
128  private:
133  static void flowISR(void *ctx);
134 
135  volatile uint32_t m_flowCounter;
136  struct timeval m_startTime;
137  mraa_gpio_context m_gpio;
138  bool m_isrInstalled;
139  };
140 }
141 
142 
void initClock()
Definition: grovewfs.cxx:58
float flowRate()
Definition: grovewfs.cxx:115
C++ API for the kxtj3 driver.
Definition: a110x.hpp:29
void startFlowCounter()
Definition: grovewfs.cxx:91
void stopFlowCounter()
Definition: grovewfs.cxx:101
void clearFlowCounter()
Definition: grovewfs.hpp:100
GroveWFS(int pin)
Definition: grovewfs.cxx:34
~GroveWFS()
Definition: grovewfs.cxx:50
uint32_t flowCounter()
Definition: grovewfs.hpp:119
API for the Grove Water Flow Sensor.
Definition: grovewfs.hpp:69
uint32_t getMillis()
Definition: grovewfs.cxx:63