Skip to content

Latest commit

 

History

History
37 lines (35 loc) · 2.26 KB

apichanges.md

File metadata and controls

37 lines (35 loc) · 2.26 KB
Raw

API Changes {#apichanges}

Here's a list of other API changes made to the library that break source/binary compatibility between releases:

  • grove Starting with UPM 1.0 the Grove libraries have been renamed from upm-grove to simply upm-. 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++ 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.
  • 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.
  • 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.