aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--CHANGELOG.md67
-rw-r--r--sensor/sensor.ino11
2 files changed, 67 insertions, 11 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..9761e84
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,67 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+
+## [Unreleased]
+
+### Added
+
+ * add non-library sketch sensor
+
+### Changed
+
+ * rename and describe bluetooth examples
+
+### Documentation
+
+ * update and add diagrams
+
+ * stop describe gape angle as a temperature
+ (it is just stored as such in Bluetooth)
+
+## [0.0.2] - 2025-04-08
+
+### Removed
+
+ * drop individual mussel sketches
+
+### Added
+
+ * add voting functions and example
+ * add function qualifyVote()
+ * add Bluetooth examples
+
+### Fixed
+
+ * fix PlantUML diagram code
+
+### Changed
+
+ * rewrite attitude #2 to also handle button press
+ * read sensor data as type int (not byte)
+
+### Documentation
+
+ * update install instruction
+ * reorder sections
+ * drop example code as appendix
+ * add section about gaping pace and sampling rate, with added citations
+ * include diagrams in appendices
+ * add library as appendix
+ * add diagrams to library
+ * document gape angle per second (CHIGA)
+ * extend diagram to cover more attitudes
+ * add notes about TODO annotations
+ * add component diagram
+
+## [0.0.1] - 2025-03-11
+
+### Added
+
+ * initial release to radicle
+
+[0.0.2]: https://app.radicle.xyz/nodes/seed.radicle.garden/rad:z2tFBF4gN7ziG9oXtUytVQNYe3VhQ/tree/4f510ef86f4a25d1d3a7010e1a638baab2b68b6e
+
+[0.0.1]: https://app.radicle.xyz/nodes/seed.radicle.garden/rad:z2tFBF4gN7ziG9oXtUytVQNYe3VhQ/tree/ce5106515a3a5fcbea7f366dd45a59188afea8d7
diff --git a/sensor/sensor.ino b/sensor/sensor.ino
index f144ef4..1bc10f0 100644
--- a/sensor/sensor.ino
+++ b/sensor/sensor.ino
@@ -7,17 +7,6 @@
/// Sensor mussel - an Arduino sketch to emulate a mussel biosensor
///
-/// * v0.0.3
-/// * rewrite sensor as sketch,
-/// using ESP32 LEDC, Touch sensor and Logging library
-///
-/// * v0.0.2
-/// * rewrite attitude #2 to also handle button press
-/// * add voting functions and example
-///
-/// * v0.0.1
-/// * initial release to radicle
-///
/// @version 0.0.3
/// @see <https://app.radicle.xyz/nodes/seed.radicle.garden/rad:z2tFBF4gN7ziG9oXtUytVQNYe3VhQ/tree/Mussel/README.md>
/// @see <https://moodle.ruc.dk/course/view.php?id=23504>