From 1d21f7c120e75320185b6f62001e7e91bd8e8cea Mon Sep 17 00:00:00 2001
From: Rahix <rahix@rahix.de>
Date: Mon, 26 Aug 2019 12:59:29 +0200
Subject: [PATCH] chore: Update CHANGELOG
Signed-off-by: Rahix <rahix@rahix.de>
---
CHANGELOG.md | 7 +++++++
Documentation/pycardium/light-sensor.rst | 10 ++++++++++
epicardium/epicardium.h | 8 +++++++-
3 files changed, 24 insertions(+), 1 deletion(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 1951bda2c..c01bcb47f 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,13 @@ 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.0.0/).
## [Unreleased]
+### Added
+- Pause mode in ECG-App
+- `bin` field in metatdata for an alternate entrypoint
+- API-call for direct light-sensor readout: `epic_light_sensor_read`
+
+### Changed
+- No longer require locking the display for setting the backlight.
## [v1.7] - 2019-08-24 21:48 - [Garlic]
diff --git a/Documentation/pycardium/light-sensor.rst b/Documentation/pycardium/light-sensor.rst
index 6ffcb05c8..57c6d1b94 100644
--- a/Documentation/pycardium/light-sensor.rst
+++ b/Documentation/pycardium/light-sensor.rst
@@ -25,3 +25,13 @@ be fairly stable.
.. py:function:: stop()
Stop the ADC.
+
+.. py:function:: read()
+
+ Direct readout of the light-sensor.
+
+ Use this function for low latency readout. The time between polls can have
+ an effect on the values measures. If you do not need low latency, prefer
+ :py:func:`light_sensor.get_reading`.
+
+ .. versionadded:: 1.8
diff --git a/epicardium/epicardium.h b/epicardium/epicardium.h
index 2ec722b97..52c02b9f4 100644
--- a/epicardium/epicardium.h
+++ b/epicardium/epicardium.h
@@ -1401,9 +1401,15 @@ API(API_LIGHT_SENSOR_GET, int epic_light_sensor_get(uint16_t* value));
API(API_LIGHT_SENSOR_STOP, int epic_light_sensor_stop());
/**
- * Get the light level directly. Each call has an intrinsic delay of about 240us, I recommend another 100-300us delay via utime.sleep_ms() between calls. Whether or not the IR LED is fast enough is another issue.
+ * Get the light level directly.
+ *
+ * Each call has an intrinsic delay of about 240us, I recommend another
+ * 100-300us delay between calls. Whether or not the IR LED is fast enough is
+ * another issue.
*
* :return: Light level
+ *
+ * .. versionadded:: 1.8
*/
API(API_LIGHT_SENSOR_READ, uint16_t epic_light_sensor_read(void));
--
GitLab