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

@ -4,6 +4,13 @@ API Changes {#apichanges}
Here's a list of other API changes made to the library that break source/binary Here's a list of other API changes made to the library that break source/binary
compatibility between releases: compatibility between releases:
* **grove** As of UPM 1.0 the Grove classes for sensors in the starter kit are
being separated into individual libraries. The old classes will be deprecated
over time and eventually removed. Corresponding libraries have the grove
prefix removed. Affected classes are GroveButton, GroveLed, GroveLight,
GroveRelay, GroveRotary, GroveSlide and GroveTemp.
* **grove** Binary compatibility was broken for the GroveTemp class as of UPM
v0.7.3. C++ samples and code using this class has to be recompiled.
* The Ublox6 driver has been removed and replaced with a generic * The Ublox6 driver has been removed and replaced with a generic
implementation called nmea_gps. This driver should handle all implementation called nmea_gps. This driver should handle all
generic serial GPS devices that output NMEA data going forward. This generic serial GPS devices that output NMEA data going forward. This

View File

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

View File

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

View File

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

View File

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

View File

@ -40,9 +40,11 @@ namespace upm {
* @man seeed * @man seeed
* @con gpio * @con gpio
* @kit gsk eak hak * @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 * @brief API for the Grove Relay
* *
* UPM module for the Grove relay switch. The Grove relay is a * UPM module for the Grove relay switch. The Grove relay is a
* digital normally-open switch that uses low voltage or current to * digital normally-open switch that uses low voltage or current to
* control a higher voltage and/or higher current. When closed, * control a higher voltage and/or higher current. When closed,

View File

@ -41,6 +41,8 @@ namespace upm {
* @man seeed * @man seeed
* @con analog * @con analog
* @kit gsk * @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) * @brief API for the Grove Rotary Angle Sensor (Knob)
* *

View File

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

View File

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