Skip to content

Commit 49c1f97

Browse files
rriveramcrushenrikbrixandersen
authored andcommitted
samples: charger: Adds additional context to README
Adds useful context to the charger sample README to help readers understand what the sample application is doing. Signed-off-by: Ricardo Rivera-Matos <ricardo.rivera-matos@cirrus.com>
1 parent d929fc5 commit 49c1f97

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

samples/drivers/charger/README.rst

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,18 @@
77
Overview
88
********
99

10-
This sample demonstrates how to use the :ref:`charger_api`.
10+
This sample demonstrates how to use the :ref:`charger_api` API.
11+
12+
The sample application performs a simple charging task loop.
13+
14+
- The application will first poll for external power provided to the charger device.
15+
- If power is provided to the charger, then the sample application will attempt to enable the charge
16+
cycle.
17+
- After the charge cycle is initiated, the sample application will check the status property of the
18+
charger device and report any relevant information to the log.
19+
- Once the charger device reports that the charge cycle has completed, the application returns.
20+
21+
Note that this sample terminates once the charge cycle completes and does not attempt to "top-off"
22+
the battery pack. Additionally, the sample intentionally does not respond to the reported charger
23+
health state and the implications the environment may have on the charge cycle execution. The
24+
responsibility of responding to these events falls on the user or the charger device implementation.

0 commit comments

Comments
 (0)