upm  0.5.1
Sensor/Actuator repository for libmraa (v0.9.1)
 All Data Structures Files Functions Variables Enumerations Enumerator Macros Groups Pages
enc03r.h
1 /*
2  * Author: Jon Trulson <jtrulson@ics.com>
3  * Copyright (c) 2014 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 <mraa/aio.h>
28 
29 namespace upm {
30 
57  class ENC03R {
58  public:
59 
66  ENC03R(int pin, float vref=5.0);
67 
71  ~ENC03R();
72 
80  void calibrate(unsigned int samples);
81 
87  unsigned int value();
88 
94  float calibrationValue() { return m_calibrationValue; };
95 
103  double angularVelocity(unsigned int val);
104 
105  private:
106  // determined by calibrate();
107  float m_calibrationValue;
108 
109  // reference voltage
110  float m_vref;
111  mraa_aio_context m_aio;
112  };
113 }
114 
115 
void calibrate(unsigned int samples)
Definition: enc03r.cxx:57
unsigned int value()
Definition: enc03r.cxx:52
~ENC03R()
Definition: enc03r.cxx:47
API for the ENC03R Single Axis Analog Gyro.
Definition: enc03r.h:57
double angularVelocity(unsigned int val)
Definition: enc03r.cxx:72
ENC03R(int pin, float vref=5.0)
Definition: enc03r.cxx:34
float calibrationValue()
Definition: enc03r.h:94