diff --git a/docs/apichanges.md b/docs/apichanges.md index e4ab2d10..d3106cd4 100644 --- a/docs/apichanges.md +++ b/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 diff --git a/src/grove/grovebase.hpp b/src/grove/grovebase.hpp index 67fe6318..dfa2e679 100644 --- a/src/grove/grovebase.hpp +++ b/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 diff --git a/src/grove/grovebutton.hpp b/src/grove/grovebutton.hpp index 72eb4734..ec6d2cfd 100644 --- a/src/grove/grovebutton.hpp +++ b/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 * diff --git a/src/grove/groveled.hpp b/src/grove/groveled.hpp index 83d32eec..665078cb 100644 --- a/src/grove/groveled.hpp +++ b/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 * diff --git a/src/grove/grovelight.hpp b/src/grove/grovelight.hpp index 10e45f72..154671af 100644 --- a/src/grove/grovelight.hpp +++ b/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 * diff --git a/src/grove/groverelay.hpp b/src/grove/groverelay.hpp index 325e1ac0..3a45c6f8 100644 --- a/src/grove/groverelay.hpp +++ b/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, diff --git a/src/grove/groverotary.hpp b/src/grove/groverotary.hpp index 86c8ad6c..31407cc8 100644 --- a/src/grove/groverotary.hpp +++ b/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) * diff --git a/src/grove/groveslide.hpp b/src/grove/groveslide.hpp index 7fa35f61..b583d199 100644 --- a/src/grove/groveslide.hpp +++ b/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 * diff --git a/src/grove/grovetemp.hpp b/src/grove/grovetemp.hpp index db38080d..f786791e 100644 --- a/src/grove/grovetemp.hpp +++ b/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 *