diff --git a/CHANGELOG.md b/CHANGELOG.md index 1951bda2c6af8670d8bd6ff2b1fa18407c6f311c..c01bcb47f2ea897d82314bc7e1d641c82234ac58 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 6ffcb05c866a6d8a6f2d20c1412173e69ace5bf8..57c6d1b949eeacd0baeee571dfce23fd131aded6 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 2ec722b97ea21cf9752c5986a9a2f6362f5458bf..52c02b9f426e5c07b0499f24478dffcfb53e8271 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));