From db0ff2f64f36b131a9323cefb3bb2980b3422442 Mon Sep 17 00:00:00 2001
From: Rahix <rahix@rahix.de>
Date: Sun, 22 Sep 2019 11:51:01 +0200
Subject: [PATCH] chore: Update CHANGELOG and docs
---
CHANGELOG.md | 7 +++++++
Documentation/pycardium/bhi160.rst | 6 ++++--
Documentation/pycardium/os.rst | 2 ++
epicardium/epicardium.h | 4 ++++
pycardium/modules/py/display.py | 4 ++++
pycardium/modules/py/simple_menu.py | 3 +++
6 files changed, 24 insertions(+), 2 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 0bb64457..1c197543 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -16,9 +16,15 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
...
(gdb) task_backtrace ble_task_id
```
+- BHI160 magnetometer sensor
+- ESB API in Pycardium.
+- Monotonic clock API
### Changed
- `Display.print()` uses a transparent background when printing with `bg == fg`.
+- Try different crc16 module during build because different environments might
+ have different ones installed.
+- Refactored BHI160 app
### Fixed
- Fixed a regression which made it impossible to turn off the flashlight.
@@ -31,6 +37,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
- Added a workaround for BHI160 axis mapping not being applied in some cases.
- Added a critical-section in BLE stack initialization to prevent weird lock-ups.
- Fixed vibra module crashing when calling `vibra.vibrate()` while already running.
+- Fixed sensor-sample overflow leading to I2C bus lockup.
## [v1.10] - 2019-09-05 21:42 - [JerusalemArtichoke]
diff --git a/Documentation/pycardium/bhi160.rst b/Documentation/pycardium/bhi160.rst
index 3b7faa06..b57dc77f 100644
--- a/Documentation/pycardium/bhi160.rst
+++ b/Documentation/pycardium/bhi160.rst
@@ -12,7 +12,7 @@ Supports the BHI160 sensor on the card10 for accelerometer, gyroscope...
import bhi160
import utime
-
+
bhi = bhi160.BHI160Orientation()
while True:
@@ -47,7 +47,7 @@ Supports the BHI160 sensor on the card10 for accelerometer, gyroscope...
Close the connection to the sensor
-
+
.. class:: bhi160.BHI160Accelerometer
Accelerometer of the BHI160
@@ -116,6 +116,8 @@ Supports the BHI160 sensor on the card10 for accelerometer, gyroscope...
sample_buffer_len: int, optional
Length of sample buffer (default is 200)
+ .. versionadded:: 1.11
+
.. py:method:: read():
Read sensor values
diff --git a/Documentation/pycardium/os.rst b/Documentation/pycardium/os.rst
index c14e8c92..2447ccfe 100644
--- a/Documentation/pycardium/os.rst
+++ b/Documentation/pycardium/os.rst
@@ -86,6 +86,8 @@ Card10-Specific
values are :py:data:`os.USB_SERIAL`, :py:data:`os.USB_FLASH`,
or :py:data:`os.USB_NONE`.
+ .. versionadded:: 1.11
+
.. py:data:: USB_NONE
No USB device active.
diff --git a/epicardium/epicardium.h b/epicardium/epicardium.h
index 3ed02dab..63dca868 100644
--- a/epicardium/epicardium.h
+++ b/epicardium/epicardium.h
@@ -1739,6 +1739,8 @@ API(API_FILE_MKDIR, int epic_file_mkdir(const char *dirname));
* Get the monotonic time in seconds.
*
* :return: monotonic time in seconds
+ *
+ * .. versionadded:: 1.11
*/
API(API_RTC_GET_MONOTONIC_SECONDS,
uint32_t epic_rtc_get_monotonic_seconds(void)
@@ -1748,6 +1750,8 @@ API(API_RTC_GET_MONOTONIC_SECONDS,
* Get the monotonic time in ms.
*
* :return: monotonic time in milliseconds
+ *
+ * .. versionadded:: 1.11
*/
API(API_RTC_GET_MONOTONIC_MILLISECONDS,
uint64_t epic_rtc_get_monotonic_milliseconds(void)
diff --git a/pycardium/modules/py/display.py b/pycardium/modules/py/display.py
index 3811d55d..d7854aa3 100644
--- a/pycardium/modules/py/display.py
+++ b/pycardium/modules/py/display.py
@@ -95,6 +95,10 @@ class Display:
d.clear()
d.print('Hello Earth!', font=display.FONT24)
d.update()
+
+ .. versionchanged:: 1.11
+
+ Added transparent background printing.
"""
fg = fg or color.WHITE
bg = bg or fg
diff --git a/pycardium/modules/py/simple_menu.py b/pycardium/modules/py/simple_menu.py
index 34f0de45..18279db4 100644
--- a/pycardium/modules/py/simple_menu.py
+++ b/pycardium/modules/py/simple_menu.py
@@ -159,6 +159,9 @@ class Menu:
Exit the event-loop. This should be called from inside an ``on_*`` hook.
.. versionadded:: 1.9
+ .. versionchanged:: 1.11
+
+ Fixed this function not working properly.
"""
raise _ExitMenuException()
--
GitLab