Skip to content

Commit

Permalink
Reformat changelog
Browse files Browse the repository at this point in the history 
Signed-off-by: Sara Damiano <[email protected]>
  • Loading branch information
@SRGDamia1
SRGDamia1 committed Aug 14, 2024
1 parent 920997d commit b7327bd
Showing 1 changed file with 56 additions and 13 deletions.
69 changes: 56 additions & 13 deletions ChangeLog.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

***

## v2.2.0 (2024-08-14) [CRC and SAMD51 Support](https://github.com/EnviroDIY/Arduino-SDI-12/releases/tag/v2.2.0)
## [2.2.0] - 2024-08-14

CRC and SAMD51 Support

### Changed

Expand Down Expand Up @@ -62,27 +64,35 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

***

## v2.1.4 (2021-05-05) [Revert wake delay to 0ms](https://github.com/EnviroDIY/Arduino-SDI-12/releases/tag/v2.1.4)
## [2.1.4] - 2021-05-05

Revert wake delay to 0ms

### Possibly breaking changes

- 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=#`

## v2.1.3 (2021-03-24) [Migrate to GitHub Actions](https://github.com/EnviroDIY/Arduino-SDI-12/releases/tag/v2.1.3)
## [2.1.3] - 2021-03-24

Migrate to GitHub Actions

### Improvements

- Migrate from Travis to GitHub actions

## v2.1.1 (2020-08-20) [Patches for ATTiny](https://github.com/EnviroDIY/Arduino-SDI-12/releases/tag/v2.1.1)
## [2.1.1] - 2020-08-20

Patches for ATTiny

### Bug Fixes

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

## v2.1.0 (2020-07-10) [Library Rename and ESP support](https://github.com/EnviroDIY/Arduino-SDI-12/releases/tag/v2.1.0)
## [2.1.0] - 2020-07-10

Library Rename and ESP support

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3939731.svg)](https://doi.org/10.5281/zenodo.3939731)

Expand All @@ -94,35 +104,45 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Add option of adding a delay before sending a command to allow the sensor to wake. Take advantage of this by calling the function `sendCommand(command, extraWakeTime)`. This may resolve issues with some Campbell sensors that would not previous communicate with this library. See <https://www.envirodiy.org/topic/campbell-scientific-cs-215-sdi-12-communication-issues-w-mayfly/#post-14103>
- Adds Doxygen (Javadoc) style comments to **ALL** members of the library. The generated documentation is available at <https://envirodiy.github.io/Arduino-SDI-12/>.

## v1.3.6 (2019-08-29) [Fixed extra compiler warnings](https://github.com/EnviroDIY/Arduino-SDI-12/releases/tag/v1.3.6)
## [1.3.6] - 2019-08-29

Fixed extra compiler warnings

### Bug Fixes

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

## v1.3.5 (2019-07-01) [Removed SAMD Tone Conflict](https://github.com/EnviroDIY/Arduino-SDI-12/releases/tag/v1.3.5)
## [1.3.5] - 2019-07-01

Removed SAMD Tone Conflict

### Improvements

- 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.

## v1.3.4 (2019-10-29) [Timer class](https://github.com/EnviroDIY/Arduino-SDI-12/releases/tag/v1.3.4)
## [1.3.4] - 2019-10-29

Timer class

### Improvements

- Made the timer changes into a compiled class.

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.

## v1.3.3 (2018-05-11) [Unset prescalers](https://github.com/EnviroDIY/Arduino-SDI-12/releases/tag/v1.3.3)
## [1.3.3] - 2018-05-11

Unset prescalers

### Improvements

- 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.

## v1.3.1 (2018-04-06) [Added processor timer for greater stability](https://github.com/EnviroDIY/Arduino-SDI-12/releases/tag/v1.3.1)
## [1.3.1] - 2018-04-06

Added processor timer for greater stability

### New Features

Expand All @@ -133,18 +153,41 @@ Maintaining interrupt control for SAMD processors as there are no interrupt vect
- 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.

## v1.1.0 (2018-03-15) [Better integration inside other libraries](https://github.com/EnviroDIY/Arduino-SDI-12/releases/tag/v1.1.0)
## [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.

## v1.0.6 (2018-03-09) [Fixed timeout values](https://github.com/EnviroDIY/Arduino-SDI-12/releases/tag/v1.0.6)
## [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.

## v1.0.1 (2017-05-16) [Initial Release](https://github.com/EnviroDIY/Arduino-SDI-12/releases/tag/v1.0.1)
## [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.

***

[Unreleased]: https://github.com/EnviroDIY/Arduino-SDI-12/compare/v2.2.0...HEAD
[2.2.0]: https://github.com/EnviroDIY/Arduino-SDI-12/releases/tag/v2.2.0
[2.1.4]: https://github.com/EnviroDIY/Arduino-SDI-12/releases/tag/v2.1.4
[2.1.3]: https://github.com/EnviroDIY/Arduino-SDI-12/releases/tag/v2.1.3
[2.1.1]: https://github.com/EnviroDIY/Arduino-SDI-12/releases/tag/v2.1.1
[2.1.0]: https://github.com/EnviroDIY/Arduino-SDI-12/releases/tag/v2.1.0
[1.3.6]: https://github.com/EnviroDIY/Arduino-SDI-12/releases/tag/v1.3.6
[1.3.5]: https://github.com/EnviroDIY/Arduino-SDI-12/releases/tag/v1.3.5
[1.3.4]: https://github.com/EnviroDIY/Arduino-SDI-12/releases/tag/v1.3.4
[1.3.3]: https://github.com/EnviroDIY/Arduino-SDI-12/releases/tag/v1.3.3
[1.3.1]: https://github.com/EnviroDIY/Arduino-SDI-12/releases/tag/v1.3.1
[1.1.0]: https://github.com/EnviroDIY/Arduino-SDI-12/releases/tag/v1.1.0
[1.0.6]: https://github.com/EnviroDIY/Arduino-SDI-12/releases/tag/v1.0.6
[1.0.1]: https://github.com/EnviroDIY/Arduino-SDI-12/releases/tag/v1.0.1

0 comments on commit b7327bd

Please sign in to comment.