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
dfrorp.hpp
1 /*
2  * Author: Jon Trulson <jtrulson@ics.com>
3  * Copyright (c) 2016 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 <iostream>
28 
29 #include <stdlib.h>
30 #include <unistd.h>
31 #include <string.h>
32 
33 #include "dfrorp.h"
34 
35 namespace upm {
74  class DFRORP {
75  public:
76 
83  DFRORP(int apin, float a_ref=5.0);
84 
88  ~DFRORP();
89 
95  void update();
96 
103  void setOffset(float offset);
104 
111  void setScale(float scale);
112 
120  float getORP();
121 
138  void setCalibrationOffset(float offset);
139 
146  float getVolts();
147 
154  float getNormalized();
155 
156  protected:
157  // dfrorp device context
158  dfrorp_context m_dfrorp;
159 
160  private:
161  /* Disable implicit copy and assignment operators */
162  DFRORP(const DFRORP&) = delete;
163  DFRORP &operator=(const DFRORP&) = delete;
164  };
165 }
C API for the DFRobot ORP (Oxidation/Reduction Potential) Sensor.
void setCalibrationOffset(float offset)
Definition: dfrorp.cxx:68
float getNormalized()
Definition: dfrorp.cxx:83
void setOffset(float offset)
Definition: dfrorp.cxx:58
Definition: dfrorp.h:47
float getVolts()
Definition: dfrorp.cxx:78
void update()
Definition: dfrorp.cxx:46
~DFRORP()
Definition: dfrorp.cxx:41
API for the DFRobot ORP (Oxidation/Reduction Potential) Sensor.
Definition: dfrorp.hpp:74
void setScale(float scale)
Definition: dfrorp.cxx:63
DFRORP(int apin, float a_ref=5.0)
Definition: dfrorp.cxx:33
float getORP()
Definition: dfrorp.cxx:73