From 1a65950ab3cf67641454d16d942bda6a3d072ac1 Mon Sep 17 00:00:00 2001
From: Rahix <rahix@rahix.de>
Date: Thu, 22 Aug 2019 00:16:55 +0200
Subject: [PATCH] docs: Document os.read_battery()
Signed-off-by: Rahix <rahix@rahix.de>
---
Documentation/pycardium/os.rst | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/Documentation/pycardium/os.rst b/Documentation/pycardium/os.rst
index 7f7682833..e7e174ca3 100644
--- a/Documentation/pycardium/os.rst
+++ b/Documentation/pycardium/os.rst
@@ -53,6 +53,15 @@ Card10-Specific
:param str name: Path to new app/script/l0dable.
:return: This function never returns. It can, however raise an exception.
+.. py:function:: read_battery()
+
+ Read the current battery voltage in V. Please keep in mind that battery
+ voltage behaves exponentially when interpreting this value.
+
+ .. warning::
+
+ Card10 will hard-shutdown once the voltage drops below 3.4 V
+
.. py:function:: reset()
Reboot card10.
--
GitLab