grove: updated API changes and deprecated old Grove classes

Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>

docs/apichanges.md

@@ -4,6 +4,13 @@ API Changes                       {#apichanges}
 Here's a list of other API changes made to the library that break source/binary
 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
  implementation called nmea_gps.  This driver should handle all
  generic serial GPS devices that output NMEA data going forward.  This

src/grove/grovebase.hpp

@@ -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

src/grove/grovebutton.hpp

@@ -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
  *

src/grove/groveled.hpp

@@ -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
  *

src/grove/grovelight.hpp

@@ -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
  *

src/grove/groverelay.hpp

@@ -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,

src/grove/groverotary.hpp

@@ -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)
  *

src/grove/groveslide.hpp

@@ -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
  *

src/grove/grovetemp.hpp

@@ -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
  *