upm  0.4.1
Sensor/Actuator repository for libmraa (v0.8.0)
wheelencoder.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.hpp>
30 
31 namespace upm {
32 
64  class WheelEncoder {
65  public:
66 
72  WheelEncoder(int pin);
73 
77  ~WheelEncoder();
78 
85  uint32_t getMillis();
86 
91  void initClock();
92 
98  void clearCounter() { m_counter = 0; };
99 
105  void startCounter();
106 
111  void stopCounter();
112 
118  uint32_t counter() { return m_counter; };
119 
120  protected:
121  mraa::Gpio m_gpio;
122  static void wheelISR(void *ctx);
123 
124  private:
125  volatile uint32_t m_counter;
126  struct timeval m_startTime;
127  bool m_isrInstalled;
128  };
129 }
130 
131 
uint32_t getMillis()
Definition: wheelencoder.cxx:52
API for the DFRobot Wheel Encoder.
Definition: wheelencoder.h:64
Definition: a110x.h:33
uint32_t counter()
Definition: wheelencoder.h:118
void startCounter()
Definition: wheelencoder.cxx:80
void stopCounter()
Definition: wheelencoder.cxx:92
WheelEncoder(int pin)
Definition: wheelencoder.cxx:32
void initClock()
Definition: wheelencoder.cxx:47
void clearCounter()
Definition: wheelencoder.h:98
~WheelEncoder()
Definition: wheelencoder.cxx:42