2014-05-06 14:27:16 +01:00
|
|
|
/*
|
|
|
|
* Author: Brendan Le Foll <brendan.le.foll@intel.com>
|
|
|
|
* Copyright (c) 2014 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
|
|
|
|
|
|
|
|
#include <string>
|
2014-06-25 10:05:27 +01:00
|
|
|
#include <mraa/aio.h>
|
|
|
|
#include <mraa/gpio.h>
|
2014-05-06 14:27:16 +01:00
|
|
|
|
|
|
|
namespace upm {
|
|
|
|
|
2014-09-22 16:37:36 +01:00
|
|
|
/**
|
|
|
|
* @brief library for basic grove sensors
|
|
|
|
* @defgroup grove libupm-grove
|
|
|
|
*/
|
2014-05-06 14:27:16 +01:00
|
|
|
class Grove {
|
|
|
|
public:
|
|
|
|
virtual ~Grove() {}
|
|
|
|
std::string name()
|
|
|
|
{
|
|
|
|
return m_name;
|
|
|
|
}
|
|
|
|
protected:
|
|
|
|
std::string m_name;
|
|
|
|
};
|
|
|
|
|
2014-08-11 14:12:23 +01:00
|
|
|
/**
|
|
|
|
* @brief C++ API for Grove LED
|
|
|
|
*
|
|
|
|
* Very basic UPM module for grove LED, or any LED for that matter
|
|
|
|
*
|
2014-10-02 10:28:29 +01:00
|
|
|
* @ingroup grove gpio
|
2014-08-11 14:12:23 +01:00
|
|
|
* @snippet groveled.cxx Interesting
|
|
|
|
*/
|
2014-05-06 14:27:16 +01:00
|
|
|
class GroveLed: public Grove {
|
|
|
|
public:
|
|
|
|
GroveLed(int pin);
|
|
|
|
~GroveLed();
|
2014-06-25 10:05:27 +01:00
|
|
|
mraa_result_t write(int value);
|
|
|
|
mraa_result_t off();
|
|
|
|
mraa_result_t on();
|
2014-05-06 14:27:16 +01:00
|
|
|
private:
|
2014-06-25 10:05:27 +01:00
|
|
|
mraa_gpio_context m_gpio;
|
2014-05-06 15:58:48 +01:00
|
|
|
};
|
|
|
|
|
2014-08-11 14:12:23 +01:00
|
|
|
/**
|
|
|
|
* @brief C++ API for Grove Temperature sensor
|
|
|
|
*
|
|
|
|
* Very basic UPM module for grove temperature sensor on analog
|
|
|
|
*
|
2014-10-02 10:28:29 +01:00
|
|
|
* @ingroup grove analog
|
2014-08-11 14:12:23 +01:00
|
|
|
* @snippet grovetemp.cxx Interesting
|
|
|
|
*/
|
2014-05-06 15:58:48 +01:00
|
|
|
class GroveTemp: public Grove {
|
|
|
|
public:
|
2014-10-02 09:55:13 +01:00
|
|
|
/**
|
|
|
|
* Grove analog temperature sensor constructor
|
|
|
|
*
|
|
|
|
* @param analog pin to use
|
|
|
|
*/
|
2014-05-06 15:58:48 +01:00
|
|
|
GroveTemp(unsigned int pin);
|
2014-10-02 09:55:13 +01:00
|
|
|
/**
|
|
|
|
* GroveTemp destructor
|
|
|
|
*/
|
2014-05-06 15:58:48 +01:00
|
|
|
~GroveTemp();
|
2014-08-11 14:12:23 +01:00
|
|
|
/**
|
|
|
|
* Get raw value from AIO pin
|
|
|
|
*
|
|
|
|
* @return the raw value from the ADC
|
|
|
|
*/
|
2014-05-06 15:58:48 +01:00
|
|
|
float raw_value();
|
2014-08-11 14:12:23 +01:00
|
|
|
/**
|
|
|
|
* Get the temperature from the sensor
|
|
|
|
*
|
|
|
|
* @return the normalised temperature
|
|
|
|
*/
|
2014-05-06 15:58:48 +01:00
|
|
|
int value();
|
|
|
|
private:
|
2014-06-25 10:05:27 +01:00
|
|
|
mraa_aio_context m_aio;
|
2014-05-06 14:27:16 +01:00
|
|
|
};
|
|
|
|
|
2014-08-11 14:12:23 +01:00
|
|
|
/**
|
|
|
|
* @brief C++ API for Grove light sensor
|
|
|
|
*
|
|
|
|
* Very basic UPM module for grove Light sensor on analog
|
|
|
|
*
|
2014-10-02 10:28:29 +01:00
|
|
|
* @ingroup grove analog
|
2014-08-11 14:12:23 +01:00
|
|
|
* @snippet grovelight.cxx Interesting
|
|
|
|
*/
|
2014-05-07 15:40:39 +01:00
|
|
|
class GroveLight: public Grove {
|
|
|
|
public:
|
2014-10-02 09:55:13 +01:00
|
|
|
/**
|
|
|
|
* Grove analog light sensor constructor
|
|
|
|
*
|
|
|
|
* @param analog pin to use
|
|
|
|
*/
|
2014-05-07 15:40:39 +01:00
|
|
|
GroveLight(unsigned int pin);
|
2014-10-02 09:55:13 +01:00
|
|
|
/**
|
|
|
|
* GroveLight Destructor
|
|
|
|
*/
|
2014-05-07 15:40:39 +01:00
|
|
|
~GroveLight();
|
2014-08-11 14:12:23 +01:00
|
|
|
/**
|
|
|
|
* Get raw value from AIO pin
|
|
|
|
*
|
|
|
|
* @return the raw value from the ADC
|
|
|
|
*/
|
2014-05-07 15:40:39 +01:00
|
|
|
float raw_value();
|
2014-08-11 14:12:23 +01:00
|
|
|
/**
|
|
|
|
* Get the light value from the sensor
|
|
|
|
*
|
|
|
|
* @return the normalised light reading
|
|
|
|
*/
|
2014-05-07 15:40:39 +01:00
|
|
|
int value();
|
|
|
|
private:
|
2014-06-25 10:05:27 +01:00
|
|
|
mraa_aio_context m_aio;
|
2014-05-07 15:40:39 +01:00
|
|
|
};
|
|
|
|
|
2014-05-06 14:27:16 +01:00
|
|
|
}
|