Skip to content

Commit

Permalink
charger: Adds basic stub API doc
Browse files Browse the repository at this point in the history
Adds a short stub doc as a placeholder for future documentation in the
charger API.

Signed-off-by: Ricardo Rivera-Matos <rriveram@opensource.cirrus.com>
  • Loading branch information
rriveramcrus committed Aug 18, 2023
1 parent 3528945 commit c27e6cc
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 0 deletions.
4 changes: 4 additions & 0 deletions doc/develop/api/overview.rst
Expand Up @@ -53,6 +53,10 @@ between major releases are available in the :ref:`zephyr_release_notes`.
- Stable
- 1.14

* - :ref:`charger_api`
- Experimental
- 3.5

* - :ref:`counter_api`
- Unstable
- 1.14
Expand Down
29 changes: 29 additions & 0 deletions doc/hardware/peripherals/charger.rst
@@ -0,0 +1,29 @@
.. _charger_api:

Chargers
########

The charger subsystem exposes an API to uniformly access battery charger devices. Currently,
only reading data is supported.

Basic Operation
***************

Properties
==========

Fundamentally, a property is a configurable setting, state, or quantity that a charger device can
measure.

Chargers typically support multiple properties, such as temperature readings of the battery-pack
or present-time current/voltage.

Properties are fetched using a client allocated array of :c:struct:`charger_get_property`. This
array is then populated by values as according to its `property_type` field.

.. _charger_api_reference:

API Reference
*************

.. doxygengroup:: charger_interface
1 change: 1 addition & 0 deletions doc/hardware/peripherals/index.rst
Expand Up @@ -17,6 +17,7 @@ Peripherals
bc12.rst
clock_control.rst
canbus/index.rst
charger.rst
coredump.rst
counter.rst
dac.rst
Expand Down

0 comments on commit c27e6cc

Please sign in to comment.