Skip to content

Commit 71228e4

Browse files
committed
Make changelog adhere to Common Changelog
Signed-off-by: Sara Damiano <sdamiano@stroudcenter.org>
1 parent b7327bd commit 71228e4

File tree

2 files changed

+28
-27
lines changed

2 files changed

+28
-27
lines changed

ChangeLog.md

+27-26
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,9 @@
22

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

5-
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6-
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and its stricter, better defined, brother [Common Changelog](https://common-changelog.org/).
6+
7+
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
78

89
***
910

@@ -21,7 +22,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2122

2223
## [2.2.0] - 2024-08-14
2324

24-
CRC and SAMD51 Support
25+
_CRC and SAMD51 Support_
2526

2627
### Changed
2728

@@ -66,76 +67,76 @@ CRC and SAMD51 Support
6667

6768
## [2.1.4] - 2021-05-05
6869

69-
Revert wake delay to 0ms
70+
_Revert wake delay to 0ms_
7071

71-
### Possibly breaking changes
72+
### Changed
7273

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

7778
## [2.1.3] - 2021-03-24
7879

79-
Migrate to GitHub Actions
80+
_Migrate to GitHub Actions_
8081

81-
### Improvements
82+
### Changed
8283

8384
- Migrate from Travis to GitHub actions
8485

8586
## [2.1.1] - 2020-08-20
8687

87-
Patches for ATTiny
88+
_Patches for ATTiny_
8889

89-
### Bug Fixes
90+
### Fixed
9091

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

9394
## [2.1.0] - 2020-07-10
9495

95-
Library Rename and ESP support
96+
_Library Rename and ESP support_
9697

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

99100
**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.
100101

101-
### New Features
102+
### Changed
102103

103104
- Adds support for Espressif ESP8266 and ESP32
104105
- 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>
105106
- Adds Doxygen (Javadoc) style comments to **ALL** members of the library. The generated documentation is available at <https://envirodiy.github.io/Arduino-SDI-12/>.
106107

107108
## [1.3.6] - 2019-08-29
108109

109-
Fixed extra compiler warnings
110+
_Fixed extra compiler warnings_
110111

111-
### Bug Fixes
112+
### Fixed
112113

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

115116
## [1.3.5] - 2019-07-01
116117

117-
Removed SAMD Tone Conflict
118+
_Removed SAMD Tone Conflict_
118119

119-
### Improvements
120+
### Changed
120121

121122
- 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.
122123
- Examples were also updated and given platformio.ini files.
123124

124125
## [1.3.4] - 2019-10-29
125126

126-
Timer class
127+
_Timer class_
127128

128-
### Improvements
129+
### Changed
129130

130131
- Made the timer changes into a compiled class.
131-
132-
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.
132+
- NOTE: Maintaining interrupt control for SAMD processors as there are no interrupt vectors to be in conflict.
133+
Because the pin mode changes from input to output and back, allowing another library to control interrupts doesn't work.
133134

134135
## [1.3.3] - 2018-05-11
135136

136-
Unset prescalers
137+
_Unset prescalers_
137138

138-
### Improvements
139+
### Changed
139140

140141
- Now unsetting timer prescalers and setting the isActive pointer to NULL in both the end and the destructor functions.
141142
- Also some clean-up of the examples.
@@ -144,18 +145,18 @@ Unset prescalers
144145

145146
Added processor timer for greater stability
146147

147-
### New Features
148+
### Added
148149

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

151-
### Improvements
152+
### Changed
152153

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

156157
## [1.1.0] - 2018-03-15
157158

158-
Better integration inside other libraries
159+
_Better integration inside other libraries_
159160

160161
### Improvements
161162

@@ -171,7 +172,7 @@ Fixed timeout values
171172

172173
## [1.0.1] - 2017-05-16
173174

174-
Initial Release
175+
_Initial Release_
175176

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

VERSION

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
v2.2.0
1+
2.2.0

0 commit comments

Comments
 (0)