Added iProximity interface

Signed-off-by: Stefan Andritoiu <stefan.andritoiu@gmail.com>
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Stefan Andritoiu 2018-06-20 18:27:11 +03:00 committed by Mihai Tudor Panu
parent 6d8e6d8a9f
commit 75c7bd8d12
5 changed files with 72 additions and 7 deletions

View File

@ -0,0 +1,39 @@
/*
* Author: Mihai Stefanescu <mihai.stefanescu@rinftech.com>
* Copyright (c) 2018 Intel Corporation.
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#pragma once
namespace upm
{
/**
* @brief Interface for Proximity sensors
*/
class iProximity
{
public:
virtual ~iProximity() {}
virtual float getValue() = 0;
};
}

View File

@ -67,3 +67,8 @@ float GP2Y0A::value(float aref, uint8_t samples)
return volts;
}
float GP2Y0A::getValue()
{
return GP2Y0A::value(5.0, (uint8_t) 1);
}

View File

@ -26,6 +26,7 @@
#include <iostream>
#include <string>
#include <mraa/aio.h>
#include <interfaces/iProximity.hpp>
namespace upm {
/**
@ -46,15 +47,15 @@ namespace upm {
*
* @brief API for the GP2Y0A family of IR Proximity Sensors
*
* Sensors of this family return an analog voltage corresponding to the distance
* Sensors of this family return an analog voltage corresponding to the distance
* of an object from the sensor. The voltage is lower when objects
* are far away; the voltage increases as objects get closer
* to the sensor.
* to the sensor.
*
* @image html gp2y0a.jpg
* @snippet gp2y0a.cxx Interesting
*/
class GP2Y0A {
class GP2Y0A : virtual public iProximity {
public:
/**
@ -78,11 +79,19 @@ namespace upm {
*/
float value(float aref, uint8_t samples);
/**
* Gets the voltage value from the sensor from a single sample
* A refernce voltage of 5.0V is used for the reading.
*
* @return Voltage reading from a single sample
*/
virtual float getValue();
private:
mraa_aio_context m_aio;
// ADC resolution
int m_aRes;
};
}

View File

@ -58,6 +58,11 @@ MAX44000::getProximity () {
return data;
}
float
MAX44000::getValue() {
return (float) MAX44000::getProximity();
}
uint16_t
MAX44000::getAmbient () {
uint16_t data = 0;

View File

@ -25,6 +25,7 @@
#include <string>
#include <mraa/i2c.hpp>
#include <interfaces/iProximity.hpp>
#define ADDR 0x4A // device address
@ -71,14 +72,14 @@ namespace upm {
* Maxim Integrated*
* [MAX44000](http://datasheets.maximintegrated.com/en/ds/MAX44000.pdf)
* is an ambient and infrared proximity sensor. This module was tested on the
* Maxim Integrated
* Maxim Integrated
* [MAX44000PMB1 PMOD module]
* (http://datasheets.maximintegrated.com/en/ds/MAX44000PMB1.pdf) from the
* analog PMOD kit.
*
* @snippet max44000.cxx Interesting
*/
class MAX44000 {
class MAX44000 : virtual public iProximity {
public:
/**
* Instantiates an MAX44000 object
@ -99,6 +100,12 @@ class MAX44000 {
* Reads the proximity value from the sensor (based on ambient data).
*/
uint16_t getProximity ();
/**
* Reads the proximity value from the sensor.
*/
virtual float getValue ();
/**
* Reads the ambient value from the sensor (based on ambient data).
*/