Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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
1 parent
e667c0a
commit 7ea3e77
Showing
3 changed files
with
43 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
.. _charger_api: | ||
|
||
Chargers (Experimental API Stub Doc) | ||
####################################### | ||
|
||
The charger subsystem exposes an API to uniformly access battery charger devices. Currently, | ||
only reading data is supported. | ||
|
||
Note: This API is currently experimental and this doc will be significantly changed as new features | ||
are added to the API. | ||
|
||
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. | ||
|
||
Caching | ||
======= | ||
|
||
The Charger API explicitly provides no caching for its clients. | ||
|
||
|
||
.. _charger_api_reference: | ||
|
||
API Reference | ||
************* | ||
|
||
.. doxygengroup:: charger_interface |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters