2016-04-05 17:02:31 -07:00
|
|
|
API Changes {#apichanges}
|
|
|
|
===============
|
|
|
|
|
|
|
|
Here's a list of other API changes made to the library that break source/binary
|
|
|
|
compatibility between releases:
|
|
|
|
|
2017-01-31 13:06:26 -07:00
|
|
|
* **nunchuck** This driver no longer supports the init() function.
|
|
|
|
All initialization is now done in the C nunchuck_init() function,
|
|
|
|
or the C++ constructor. In addition, the *NUNCHUCK_I2C_ADDR*
|
|
|
|
define is no longer exposed, as it is not possible to use any other
|
|
|
|
I2C address than *0x52*. The readBytes() and writeByte() functions
|
|
|
|
are also no longer exposed, since aside from what the driver does
|
|
|
|
to initialize and read data, there are no other options available.
|
|
|
|
|
2017-01-27 17:58:35 -07:00
|
|
|
* **enc03r** This driver no longer supports the value() function. In
|
|
|
|
addition, an update() function has been added. This function must be
|
|
|
|
called prior to calling angularVelocity(). angularVelocity() no
|
|
|
|
longer accepts an argument. Additional functions have been added,
|
|
|
|
however they do not affect compatibility with previous versions.
|
|
|
|
|
2017-01-18 13:09:51 -07:00
|
|
|
* **ds18b20** The C++ interface init() function has been deprecated.
|
|
|
|
It is still present, but currently does nothing. It will be removed
|
|
|
|
in a future release.
|
2017-01-27 17:58:35 -07:00
|
|
|
|
2016-10-27 16:46:35 -07:00
|
|
|
* **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.
|
2017-01-27 17:58:35 -07:00
|
|
|
|
2016-10-26 17:58:41 -07:00
|
|
|
* **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.
|
2017-01-27 17:58:35 -07:00
|
|
|
|
2016-10-27 16:46:35 -07:00
|
|
|
* 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.
|
2017-01-27 17:58:35 -07:00
|
|
|
|
2016-10-26 17:58:41 -07:00
|
|
|
* **grove** Binary compatibility was broken for the GroveTemp class as of UPM
|
2016-10-27 16:46:35 -07:00
|
|
|
v0.7.3. C++ code using this class has to be recompiled.
|
2017-01-27 17:58:35 -07:00
|
|
|
|
2016-07-12 16:50:39 -06:00
|
|
|
* 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.
|
2017-01-27 17:58:35 -07:00
|
|
|
|
2016-05-12 17:07:29 -07:00
|
|
|
* 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
|
2016-10-27 16:46:35 -07:00
|
|
|
change but you will need to modify your `#include` directives in existing
|
|
|
|
code.
|
2017-01-27 17:58:35 -07:00
|
|
|
|
2016-04-05 17:02:31 -07:00
|
|
|
* **my9221**, **groveledbar** and **grovecircularled** are now all part of the
|
2016-10-27 16:46:35 -07:00
|
|
|
same library (my9221) and new functionality was added going to v.0.5.1.
|
2017-01-27 17:58:35 -07:00
|
|
|
|
2016-10-27 16:46:35 -07:00
|
|
|
* **stepmotor** driver API was changed significantly from v.0.4.1 to v.0.5.0.
|
2017-01-27 17:58:35 -07:00
|
|
|
|
2016-04-05 17:02:31 -07:00
|
|
|
* **eboled** library was greatly improved in version 0.4.0 and the `draw()`
|
2016-10-27 16:46:35 -07:00
|
|
|
function was removed in favor of a more complete GFX library implementation.
|