upm  0.5.1
Sensor/Actuator repository for libmraa (v0.9.1)
 All Data Structures Files Functions Variables Enumerations Enumerator Macros Groups Pages
grovewfs.h
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 
67  class GroveWFS {
68  public:
74  GroveWFS(int pin);
78  ~GroveWFS();
85  uint32_t getMillis();
86 
91  void initClock();
92 
98  void clearFlowCounter() { m_flowCounter = 0; };
99 
104  void startFlowCounter();
105 
110  void stopFlowCounter();
111 
117  uint32_t flowCounter() { return m_flowCounter; };
118 
124  float flowRate();
125 
126  private:
131  static void flowISR(void *ctx);
132 
133  volatile uint32_t m_flowCounter;
134  struct timeval m_startTime;
135  mraa_gpio_context m_gpio;
136  bool m_isrInstalled;
137  };
138 }
139 
140 
void initClock()
Definition: grovewfs.cxx:58
float flowRate()
Definition: grovewfs.cxx:115
void startFlowCounter()
Definition: grovewfs.cxx:91
void stopFlowCounter()
Definition: grovewfs.cxx:101
void clearFlowCounter()
Definition: grovewfs.h:98
GroveWFS(int pin)
Definition: grovewfs.cxx:34
~GroveWFS()
Definition: grovewfs.cxx:50
uint32_t flowCounter()
Definition: grovewfs.h:117
API for the Grove Water Flow Sensor.
Definition: grovewfs.h:67
uint32_t getMillis()
Definition: grovewfs.cxx:63