mirror of
https://github.com/eclipse/upm.git
synced 2025-03-15 04:57:30 +03:00
grove: deprecated rest of grove libraries throughout documentation
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
parent
ddc9e067d2
commit
e092aab5ed
@ -4,27 +4,34 @@ API Changes {#apichanges}
|
||||
Here's a list of other API changes made to the library that break source/binary
|
||||
compatibility between releases:
|
||||
|
||||
* **grove<name>** Starting with UPM 1.0 the Grove libraries have been renamed
|
||||
from *upm-grove<name>* to simply *upm-<name>*. Class names also match this new
|
||||
format, with old classes marked as deprecated throughout the documentation.
|
||||
List of affected libraries: grovecollision, groveehr, groveeldriver,
|
||||
groveelectromagnet, groveemg, grovegprs, grovegsr, grovelinefinder, grovemd,
|
||||
grovemoisture, groveo2, grovescam, grovespeaker, groveultrasonic, grovevdiv,
|
||||
grovewater, grovewfs.
|
||||
* **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.
|
||||
* The **ublox6** driver has been replaced with a generic implementation called
|
||||
nmea_gps as of UPM 1.0. This driver should handle all generic serial GPS
|
||||
devices that output NMEA data going forward. This new driver has been tested
|
||||
with ublox6, DFRobot VK2828U7 (ublox7) and ublox LEA-6H GPS devices.
|
||||
* **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
|
||||
new driver has been tested with ublox6, DFRobot VK2828U7 (ublox7) and
|
||||
ublox LEA-6H GPS devices.
|
||||
v0.7.3. C++ code using this class has to be recompiled.
|
||||
* There were frequent misspellings of the word *Celsius* in the UPM
|
||||
code. In some cases, these were in method names, which will cause
|
||||
some API compatibility issues. These have all been corrected for UPM
|
||||
versions after v.0.7.2.
|
||||
* Our **C++ header files** changed their extension from *.h* to *.hpp* in
|
||||
version 0.7.0, Intel provided examples and code samples also reflect this
|
||||
change but you will need to modify your `#include` directives in existing code
|
||||
change but you will need to modify your `#include` directives in existing
|
||||
code.
|
||||
* **my9221**, **groveledbar** and **grovecircularled** are now all part of the
|
||||
same library (my9221) and new functionality was added going to v.0.5.1
|
||||
* **stepmotor** driver API was changed significantly from v.0.4.1 to v.0.5.0
|
||||
same library (my9221) and new functionality was added going to v.0.5.1.
|
||||
* **stepmotor** driver API was changed significantly from v.0.4.1 to v.0.5.0.
|
||||
* **eboled** library was greatly improved in version 0.4.0 and the `draw()`
|
||||
function was removed in favor of a more complete GFX library implementation
|
||||
function was removed in favor of a more complete GFX library implementation.
|
||||
|
@ -27,6 +27,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-collision
|
||||
* @brief Grove Collision Sensor library
|
||||
* @defgroup grovecollision libupm-grovecollision
|
||||
* @ingroup seeed gpio accelerometer
|
||||
@ -39,6 +40,7 @@ namespace upm {
|
||||
* @type accelerometer
|
||||
* @man seeed
|
||||
* @con gpio
|
||||
* @deprecated This class is being replaced by Collision
|
||||
*
|
||||
* @brief API for the Grove Collision Sensor
|
||||
*
|
||||
|
@ -30,6 +30,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-ehr
|
||||
* @brief Grove Ear-clip Heart Rate Sensor library
|
||||
* @defgroup groveehr libupm-groveehr
|
||||
* @ingroup seeed gpio medical
|
||||
@ -42,6 +43,7 @@ namespace upm {
|
||||
* @type medical
|
||||
* @man seeed
|
||||
* @con gpio
|
||||
* @deprecated This class is being replaced by EHR
|
||||
*
|
||||
* @brief API for the Grove Ear-clip Heart Rate Sensor
|
||||
*
|
||||
|
@ -30,6 +30,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-eldriver
|
||||
* @brief Grove EL Driver Module library
|
||||
* @defgroup groveeldriver libupm-groveeldriver
|
||||
* @ingroup seeed gpio electric
|
||||
@ -42,6 +43,7 @@ namespace upm {
|
||||
* @type electric
|
||||
* @man seeed
|
||||
* @con gpio
|
||||
* @deprecated This class is being replaced by ElDriver
|
||||
*
|
||||
* @brief API for the Grove EL Driver Module
|
||||
*
|
||||
|
@ -30,6 +30,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-electromagnet
|
||||
* @brief Grove Electromagnet library
|
||||
* @defgroup groveelectromagnet libupm-groveelectromagnet
|
||||
* @ingroup seeed gpio electric
|
||||
@ -42,6 +43,7 @@ namespace upm {
|
||||
* @type electric
|
||||
* @man seeed
|
||||
* @con gpio
|
||||
* @deprecated This class is being replaced by Electromagnet
|
||||
*
|
||||
* @brief API for the Grove Electromagnet
|
||||
*
|
||||
|
@ -28,6 +28,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-emg
|
||||
* @brief Grove EMG Muscle Signal Reader library
|
||||
* @defgroup groveemg libupm-groveemg
|
||||
* @ingroup seeed analog electric
|
||||
@ -40,6 +41,7 @@ namespace upm {
|
||||
* @type electric
|
||||
* @man seeed
|
||||
* @con analog
|
||||
* @deprecated This class is being replaced by EMG
|
||||
*
|
||||
* @brief API for the Grove EMG Muscle Signal Reader
|
||||
*
|
||||
|
@ -40,6 +40,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-gprs
|
||||
* @brief Grove GPRS Module library
|
||||
* @defgroup grovegprs libupm-grovegprs
|
||||
* @ingroup seeed uart wifi
|
||||
@ -53,6 +54,7 @@ namespace upm {
|
||||
* @man seeed
|
||||
* @con uart
|
||||
* @web http://www.seeedstudio.com/wiki/GPRS_Shield_V2.0
|
||||
* @deprecated This class is being replaced by GPRS
|
||||
*
|
||||
* @brief API for the Grove GPRS Module
|
||||
*
|
||||
|
@ -28,6 +28,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-gsr
|
||||
* @brief Grove GSR Galvanic Skin Response Sensor library
|
||||
* @defgroup grovegsr libupm-grovegsr
|
||||
* @ingroup seeed analog electric
|
||||
@ -40,6 +41,7 @@ namespace upm {
|
||||
* @type electric
|
||||
* @man seeed
|
||||
* @con analog
|
||||
* @deprecated This class is being replaced by GSR
|
||||
*
|
||||
* @brief API for the Grove GSR Galvanic Skin Response Sensor
|
||||
*
|
||||
|
@ -28,6 +28,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-linefinder
|
||||
* @brief Grove Line Finder Sensor library
|
||||
* @defgroup grovelinefinder libupm-grovelinefinder
|
||||
* @ingroup seeed gpio color robok
|
||||
@ -41,6 +42,7 @@ namespace upm {
|
||||
* @man seeed
|
||||
* @con gpio
|
||||
* @kit robok
|
||||
* @deprecated This class is being replaced by LineFinder
|
||||
*
|
||||
* @brief API for the Grove Line Finder Sensor
|
||||
*
|
||||
|
@ -34,6 +34,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-md
|
||||
* @brief Grove I2C Motor Driver library
|
||||
* @defgroup grovemd libupm-grovemd
|
||||
* @ingroup seeed i2c motor robok
|
||||
@ -47,6 +48,7 @@ namespace upm {
|
||||
* @man seeed
|
||||
* @con i2c
|
||||
* @kit robok
|
||||
* @deprecated This class is being replaced by MD
|
||||
*
|
||||
* @brief API for the Grove I2C Motor Driver
|
||||
*
|
||||
|
@ -28,6 +28,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-moisture
|
||||
* @brief Grove Moisture Sensor library
|
||||
* @defgroup grovemoisture libupm-grovemoisture
|
||||
* @ingroup seeed analog liquid eak hak
|
||||
@ -41,6 +42,7 @@ namespace upm {
|
||||
* @man seeed
|
||||
* @con analog
|
||||
* @kit eak hak
|
||||
* @deprecated This class is being replaced by Moisture
|
||||
*
|
||||
* @brief API for the Grove Moisture Sensor
|
||||
*
|
||||
|
@ -28,6 +28,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-o2
|
||||
* @brief Grove O2 Oxygen Gas Sensor library
|
||||
* @defgroup groveo2 libupm-groveo2
|
||||
* @ingroup seeed analog gaseous
|
||||
@ -40,6 +41,7 @@ namespace upm {
|
||||
* @type gaseous
|
||||
* @man seeed
|
||||
* @con analog
|
||||
* @deprecated This class is being replaced by O2
|
||||
*
|
||||
* @brief API for the Grove O2 Oxygen Gas Sensor
|
||||
*
|
||||
|
@ -48,6 +48,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-scam
|
||||
* @brief Grove Serial Camera library
|
||||
* @defgroup grovescam libupm-grovescam
|
||||
* @ingroup seeed uart other
|
||||
@ -61,6 +62,7 @@ namespace upm {
|
||||
* @man seeed
|
||||
* @con uart
|
||||
* @web http://www.seeedstudio.com/wiki/Grove_-_Serial_Camera_Kit
|
||||
* @deprecated This class is being replaced by SCAM
|
||||
*
|
||||
* @brief API for the Grove Serial Camera
|
||||
*
|
||||
|
@ -33,6 +33,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-speaker
|
||||
* @brief Grove Speaker library
|
||||
* @defgroup grovespeaker libupm-grovespeaker
|
||||
* @ingroup seeed gpio sound hak
|
||||
@ -54,6 +55,7 @@ typedef struct
|
||||
* @man seeed
|
||||
* @con gpio
|
||||
* @kit hak
|
||||
* @deprecated This class is being replaced by Speaker
|
||||
*
|
||||
* @brief API for the Grove Speaker
|
||||
*
|
||||
|
@ -36,6 +36,7 @@
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-ultrasonic
|
||||
* @brief Grove ultrasonic sensor library
|
||||
* @defgroup groveultrasonic libupm-groveultrasonic
|
||||
* @ingroup seeed gpio sound
|
||||
@ -48,6 +49,7 @@ namespace upm {
|
||||
* @type sound
|
||||
* @man seeed
|
||||
* @con gpio
|
||||
* @deprecated This class is being replaced by UltraSonic
|
||||
*
|
||||
* @brief API for Grove Ultrasonic Ranger
|
||||
*
|
||||
|
@ -36,6 +36,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-vdiv
|
||||
* @brief Grove Voltage Divider Sensor library
|
||||
* @defgroup grovevdiv libupm-grovevdiv
|
||||
* @ingroup seeed analog electric robok
|
||||
@ -49,6 +50,7 @@ namespace upm {
|
||||
* @man seeed
|
||||
* @con analog
|
||||
* @kit robok
|
||||
* @deprecated This class is being replaced by VDiv
|
||||
*
|
||||
* @brief API for the Grove Voltage Divider Sensor
|
||||
*
|
||||
|
@ -28,6 +28,7 @@
|
||||
|
||||
namespace upm {
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-water
|
||||
* @brief Grove Water Sensor library
|
||||
* @defgroup grovewater libupm-grovewater
|
||||
* @ingroup seeed gpio liquid eak
|
||||
@ -41,6 +42,7 @@ namespace upm {
|
||||
* @man seeed
|
||||
* @con gpio
|
||||
* @kit eak
|
||||
* @deprecated This class is being replaced by Water
|
||||
*
|
||||
* @brief API for the Grove Water Sensor
|
||||
*
|
||||
|
@ -31,6 +31,7 @@
|
||||
namespace upm {
|
||||
|
||||
/**
|
||||
* @deprecated This library is being replaced by libupm-wfs
|
||||
* @brief Grove Water Flow Sensor library
|
||||
* @defgroup grovewfs libupm-grovewfs
|
||||
* @ingroup seeed gpio liquid eak
|
||||
@ -45,7 +46,8 @@ namespace upm {
|
||||
* @web http://www.seeedstudio.com/wiki/index.php?title=G1/2_Water_Flow_sensor
|
||||
* @con gpio
|
||||
* @kit eak
|
||||
|
||||
* @deprecated This class is being replaced by WFS
|
||||
*
|
||||
* @brief API for the Grove Water Flow Sensor
|
||||
*
|
||||
* This sensor is used to measure water flow in liters per
|
||||
|
Loading…
x
Reference in New Issue
Block a user