Skip to content
Snippets Groups Projects
Verified Commit 3e9ff447 authored by rahix's avatar rahix
Browse files

docs: Fix power module docs


Signed-off-by: default avatarRahix <rahix@rahix.de>
parent bbc26e65
No related branches found
No related tags found
No related merge requests found
...@@ -31,6 +31,7 @@ Last but not least, if you want to start hacking the lower-level firmware, the ...@@ -31,6 +31,7 @@ Last but not least, if you want to start hacking the lower-level firmware, the
pycardium/light-sensor pycardium/light-sensor
pycardium/os pycardium/os
pycardium/personal_state pycardium/personal_state
pycardium/power
pycardium/simple_menu pycardium/simple_menu
pycardium/utime pycardium/utime
pycardium/vibra pycardium/vibra
......
.. py:module:: Power .. py:module:: power
``power`` - PMIC power module handling ``power`` - PMIC power module handling
====================================== ======================================
.. versionadded:: 1.4
The :py:mod:`power` module allows you to read the card10's power status The :py:mod:`power` module allows you to read the card10's power status
in your scripts. in your scripts.
...@@ -22,22 +24,32 @@ in your scripts. ...@@ -22,22 +24,32 @@ in your scripts.
Card10 will hard-shutdown once the voltage drops below 3.4 V Card10 will hard-shutdown once the voltage drops below 3.4 V
.. versionadded:: 1.4
.. py:function:: read_battery_current() .. py:function:: read_battery_current()
Read the battery-side current flow in A. Read the battery-side current flow in A.
.. versionadded:: 1.4
.. py:function:: read_chargin_voltage() .. py:function:: read_chargin_voltage()
Read the charge voltage in V. Read the charge voltage in V.
.. versionadded:: 1.4
.. py:function:: read_chargin_current() .. py:function:: read_chargin_current()
Read the charge current in A. Read the charge current in A.
.. versionadded:: 1.4
.. py:function:: read_system_voltage() .. py:function:: read_system_voltage()
Read the system-side voltate in V. Read the system-side voltate in V.
.. versionadded:: 1.4
.. py:function:: read_thermistor_voltage() .. py:function:: read_thermistor_voltage()
Read the thermistor voltage in V. Read the thermistor voltage in V.
...@@ -45,3 +57,5 @@ in your scripts. ...@@ -45,3 +57,5 @@ in your scripts.
There is a resistor network from GND over a thermistor There is a resistor network from GND over a thermistor
(10K at room temperature) over 10K to the Thermistor Bias voltage. (10K at room temperature) over 10K to the Thermistor Bias voltage.
This reads the voltage between thermistor and resistor. This reads the voltage between thermistor and resistor.
.. versionadded:: 1.4
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment