grove: updated API changes and deprecated old Grove classes

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
Mihai Tudor Panu
2016-10-26 17:58:41 -07:00
parent 2b05efa4ba
commit ddc9e067d2
9 changed files with 24 additions and 1 deletions

View File

@ -30,6 +30,8 @@
namespace upm {
/**
* @deprecated This library is now deprecated and replaced by individual
* libraries for every sensor.
* @brief Generic library for basic Grove sensors
* @defgroup grove libupm-grove
* @ingroup seeed gpio pwm ainput button led light relay temp touch gsk eak hak

View File

@ -41,6 +41,8 @@ namespace upm {
* @man seeed
* @con gpio
* @kit gsk
* @deprecated This class is being replaced by the upm-button library and the
* Button class.
*
* @brief API for the Grove Button
*

View File

@ -40,6 +40,8 @@ namespace upm {
* @man seeed
* @con gpio
* @kit gsk
* @deprecated This class is being replaced by the upm-led library and the
* Led class.
*
* @brief API for the Grove LED
*

View File

@ -40,6 +40,8 @@ namespace upm {
* @man seeed
* @con analog
* @kit gsk
* @deprecated This class is being replaced by the upm-light library and the
* Light class.
*
* @brief API for the Grove Light Sensor
*

View File

@ -40,9 +40,11 @@ namespace upm {
* @man seeed
* @con gpio
* @kit gsk eak hak
* @deprecated This class is being replaced by the upm-relay library and the
* Relay class.
*
* @brief API for the Grove Relay
*
*
* UPM module for the Grove relay switch. The Grove relay is a
* digital normally-open switch that uses low voltage or current to
* control a higher voltage and/or higher current. When closed,

View File

@ -41,6 +41,8 @@ namespace upm {
* @man seeed
* @con analog
* @kit gsk
* @deprecated This class is being replaced by the upm-rotary library and the
* Rotary class.
*
* @brief API for the Grove Rotary Angle Sensor (Knob)
*

View File

@ -39,6 +39,8 @@ namespace upm {
* @type ainput
* @man seeed
* @con analog
* @deprecated This class is being replaced by the upm-slide library and the
* Slide class.
*
* @brief API for the Grove Slide Potentiometer
*

View File

@ -40,6 +40,8 @@ namespace upm {
* @man seeed
* @con analog
* @kit gsk
* @deprecated This class is being replaced by the upm-temperature library and
* the Temperature class.
*
* @brief API for the Grove Temperature Sensor
*