Skip to content

Latest commit

 

History

History
194 lines (120 loc) · 7.14 KB

ChangeLog.md

File metadata and controls

194 lines (120 loc) · 7.14 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and its stricter, better defined, brother Common Changelog.

This project adheres to Semantic Versioning.

Unreleased

Changed

Added

Removed

Fixed

2.2.0 - 2024-08-14

CRC and SAMD51 Support

Changed

  • Added python version to GitHub actions (for PlatformIO)
  • Switched to reusable workflows for GitHub actions
  • Consolidated timer prescaler math
  • Moved bitTimes and mul8x8to16 functions to the timers files
  • Replace c-style casts with c++ style casts
  • Do not disable interrupts during Tx for processors over 48MHz
  • Cast all timer values and math to the proper type for the processor timer being read
    • SAMD21 boards now use the full 16-bits of the timer rather than only the first 8-bits.
    • AVR xU4 boards (ie, 32u4/Leonardo) still use the 10-bit timer as an 8-bit timer.
  • Shortened name of espressif ISR access macro from ESPFAMILY_USE_INSTRUCTION_RAM to ISR_MEM_ACCESS
    • This does not change any functionality of the macro, just the name.
  • Moved defines to the top of the SDI12_boards.h file
  • Renamed the "tools" directory to "extras" in compliance with Arduino library standards.
  • Updated copyright and license texts
  • SAMD boards now partially revert clock and prescaler settings when an SDI-12 instance is ended.
    • Prescalers are reset to factory settings, the clock divisor is not reset

Added

  • Added CRC checking
  • Added support for SAMD51 processors using dedicated timers
  • Added parity checking on character reception
    • This can be disabled by defining the macro SDI12_IGNORE_PARITY
  • Allowing (without testing) processors over 48MHz to use micros() function
  • Added a 'yield' function within stream functions to allow the buffer to fill
    • The yield time can be modified using the macro SDI12_YIELD_MS

Removed

  • Offloaded some internal header file documentation to markdown files
  • Consolidated redundant READTIME and TCNTX macros, removing TCNTX
  • Removed documation m_span commands

Fixed

  • Added an extra addition/removal of interrupts for espressif boards in the begin function to properly initialize the interrupts and avoid a later error with the gpio_install_isr_service.

2.1.4 - 2021-05-05

Revert wake delay to 0ms

Changed

  • BREAKING Reverted the default wake delay to 0ms.
    • In 92055d377b26fa862c43d1429de1ccbef054af01 this was bumped up to 10ms, which caused problems for several people.
    • The delay can now also be set using the build flag -D SDI12_WAKE_DELAY=#

2.1.3 - 2021-03-24

Migrate to GitHub Actions

Changed

  • Migrate from Travis to GitHub actions

2.1.1 - 2020-08-20

Patches for ATTiny

Fixed

  • fixes for the timer and pre-scaler for the ATTiny, courtesy of @gabbas1

2.1.0 - 2020-07-10

Library Rename and ESP support

DOI

To comply with requirements for inclusion in the Arduino IDE, the word Arduino has been removed from the name of this library! The repository name is unchanged.

Changed

1.3.6 - 2019-08-29

Fixed extra compiler warnings

Fixed

  • A very minor update to fix compiler warnings found when using -Wextra in addition to -Wall.

1.3.5 - 2019-07-01

Removed SAMD Tone Conflict

Changed

  • SAMD boards will no longer have a conflict with the Tone functions in the Arduino core. AVR boards will still conflict. If you need to use Tone and SDI-12 together for some reason on an AVR boards, you must use the "delayBase" branch.
  • Examples were also updated and given platformio.ini files.

1.3.4 - 2019-10-29

Timer class

Changed

  • Made the timer changes into a compiled class.
  • NOTE: Maintaining interrupt control for SAMD processors as there are no interrupt vectors to be in conflict. Because the pin mode changes from input to output and back, allowing another library to control interrupts doesn't work.

1.3.3 - 2018-05-11

Unset prescalers

Changed

  • Now unsetting timer prescalers and setting the isActive pointer to NULL in both the end and the destructor functions.
  • Also some clean-up of the examples.

1.3.1 - 2018-04-06

Added processor timer for greater stability

Added

  • Changed the incoming data ISR to use a processor timer, this makes the reception more stable, especially when the ISR is controlled by an external library. This also creates some conflicts with other libraries that use Timer2.

Changed

  • Made changes to the write functions to use the timer to reduce the amount of time that all system interrupts are off.
  • Forcing all SDI-12 objects to use the same buffer to reduce ram usage.

1.1.0 - 2018-03-15

Better integration inside other libraries

Improvements

  • Added notes and an empty constructor/populated begin method to allow this library to be more easily called inside of other libraries.

1.0.6 - 2018-03-09

Fixed timeout values

Bug Fixes

  • Fixes the time-out values for the ParseInt and ParseFloat to be -9999. This was the intended behavior all along, but at some point those functions changed in the stream library and the identically named functions within SDI-12 intended to "hide" the stream functions ceased to be called.

1.0.1 - 2017-05-16

Initial Release

The first "official" release of this interrupt-based SDI-12 library for AVR and SAMD Arduino boards.