Skip to content

Commit f5b201e

Browse files
DBS06danieldegrasse
authored andcommitted
doc: fuel_gauge: upate api documentation
removes outdated description and adds missing api call. Signed-off-by: Philipp Steiner <philipp.steiner1987@gmail.com>
1 parent 917bc51 commit f5b201e

File tree

1 file changed

+3
-6
lines changed

1 file changed

+3
-6
lines changed

doc/hardware/peripherals/fuel_gauge.rst

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,7 @@
33
Fuel Gauge
44
##########
55

6-
The fuel gauge subsystem exposes an API to uniformly access battery fuel gauge devices. Currently,
7-
only reading data is supported.
8-
9-
Note: This API is currently experimental and this doc will be significantly changed as new features
10-
are added to the API.
6+
The fuel gauge subsystem exposes an API to uniformly access battery fuel gauge devices.
117

128
Basic Operation
139
***************
@@ -21,7 +17,8 @@ Fuel gauges typically support multiple properties, such as temperature readings
2117
or present-time current/voltage.
2218

2319
Properties are fetched by the client one at a time using :c:func:`fuel_gauge_get_prop`, or fetched
24-
in a batch using :c:func:`fuel_gauge_get_props`.
20+
in a batch using :c:func:`fuel_gauge_get_props`. Buffer properties, e.g. device name, are fetched by
21+
using :c:func:`fuel_gauge_get_buffer_prop`.
2522

2623
Properties are set by the client one at a time using :c:func:`fuel_gauge_set_prop`, or set in a
2724
batch using :c:func:`fuel_gauge_set_props`.

0 commit comments

Comments
 (0)