upm  1.3.0
Sensor/Actuator repository for libmraa (v1.7.0)
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
enc03r.hpp
1 /*
2  * Author: Jon Trulson <jtrulson@ics.com>
3  * Copyright (c) 2014-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 <string>
27 #include "enc03r.h"
28 
29 namespace upm {
57 class ENC03R {
58  public:
65  ENC03R(int pin, float aref=5.0);
66 
70  ~ENC03R();
71 
79  void calibrate(unsigned int samples);
80 
88  void update();
89 
95  float calibrationValue() { return enc03r_calibration_value(m_enc03r); };
96 
104  float angularVelocity();
105 
112  void setOffset(float offset);
113 
120  void setScale(float scale);
121 
130  float getNormalized();
131 
132  protected:
133  enc03r_context m_enc03r;
134 
135  private:
136  /* Disable implicit copy and assignment operators */
137  ENC03R(const ENC03R&) = delete;
138  ENC03R &operator=(const ENC03R&) = delete;
139 };
140 }
void calibrate(unsigned int samples)
Definition: enc03r.cxx:47
float enc03r_calibration_value(const enc03r_context dev)
Definition: enc03r.c:126
~ENC03R()
Definition: enc03r.cxx:42
API for the ENC03R Single Axis Analog Gyro.
Definition: enc03r.hpp:57
Generic API for AT command based UART devices.
ENC03R(int pin, float aref=5.0)
Definition: enc03r.cxx:34
float angularVelocity()
Definition: enc03r.cxx:61
void setScale(float scale)
Definition: enc03r.cxx:71
float calibrationValue()
Definition: enc03r.hpp:95
void update()
Definition: enc03r.cxx:54
void setOffset(float offset)
Definition: enc03r.cxx:66
float getNormalized()
Definition: enc03r.cxx:76
Definition: enc03r.h:47