grove: split code base for grove sensors into individual files
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
@@ -1,7 +1,8 @@
|
||||
/*
|
||||
* Place-holder Header for Documentation and future API change
|
||||
*
|
||||
* Copyright (c) 2014 Intel Corporation.
|
||||
* Authors: Brendan Le Foll <brendan.le.foll@intel.com>
|
||||
* Mihai Tudor Panu <mihai.tudor.panu@intel.com>
|
||||
* Sarah Knepper <sarah.knepper@intel.com>
|
||||
* Copyright (c) 2014 - 2016 Intel Corporation.
|
||||
*
|
||||
* Permission is hereby granted, free of charge, to any person obtaining
|
||||
* a copy of this software and associated documentation files (the
|
||||
@@ -22,7 +23,15 @@
|
||||
* 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>
|
||||
#include <mraa/gpio.hpp>
|
||||
#include "grovebase.hpp"
|
||||
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @library grove
|
||||
* @sensor groveled
|
||||
@@ -35,7 +44,7 @@
|
||||
* @brief API for the Grove LED
|
||||
*
|
||||
* UPM module for the Grove LED (or other similar light-emitting diodes).
|
||||
* An LED is a small lightbulb that emits light in
|
||||
* An LED is a small lightbulb that emits light in
|
||||
* response to a small current. The longer wire of an LED connects
|
||||
* to the positive seat (anode); the shorter wire connects to the
|
||||
* negative seat (cathode). The flat side of the bulb corresponds
|
||||
@@ -45,4 +54,43 @@
|
||||
* @snippet groveled.cxx Interesting
|
||||
* @snippet groveled-multi.cxx Interesting
|
||||
*/
|
||||
|
||||
class GroveLed: public Grove {
|
||||
public:
|
||||
/**
|
||||
* Grove LED constructor
|
||||
*
|
||||
* @param gpio Pin to use
|
||||
*/
|
||||
GroveLed(int pin);
|
||||
/**
|
||||
* Grove LED destructor
|
||||
*/
|
||||
~GroveLed();
|
||||
/**
|
||||
* Turns the LED on or off, depending on the value.
|
||||
* If the value is positive (greater than or equal
|
||||
* to 1), the LED is turned on. Otherwise, for 0
|
||||
* or negative values, the LED is turned off.
|
||||
*
|
||||
* @param value Tells the LED to turn on (for values >=1)
|
||||
* or off (for values <1)
|
||||
*
|
||||
* @return 0 if successful, non-zero otherwise
|
||||
*/
|
||||
mraa_result_t write(int value);
|
||||
/**
|
||||
* Turns the LED off
|
||||
*
|
||||
* @return 0 if successful, non-zero otherwise
|
||||
*/
|
||||
mraa_result_t off();
|
||||
/**
|
||||
* Turns the LED on
|
||||
*
|
||||
* @return 0 if successful, non-zero otherwise
|
||||
*/
|
||||
mraa_result_t on();
|
||||
private:
|
||||
mraa_gpio_context m_gpio;
|
||||
};
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user