2022-11-19 04:59:37 +08:00
|
|
|
.. _fuel_gauge_api:
|
|
|
|
|
|
2023-03-30 15:47:14 +08:00
|
|
|
Fuel Gauge
|
|
|
|
|
##########
|
2022-11-19 04:59:37 +08:00
|
|
|
|
|
|
|
|
The fuel gauge subsystem exposes an API to uniformly access battery fuel gauge 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 quantity that a fuel gauge device can measure.
|
|
|
|
|
|
|
|
|
|
Fuel gauges 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:`fuel_gauge_get_property`. This
|
|
|
|
|
array is then populated by values as according to its `property_type` field.
|
|
|
|
|
|
|
|
|
|
Caching
|
|
|
|
|
=======
|
|
|
|
|
|
|
|
|
|
The Fuel Gauge API explicitly provides no caching for its clients.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
.. _fuel_gauge_api_reference:
|
|
|
|
|
|
|
|
|
|
API Reference
|
|
|
|
|
*************
|
|
|
|
|
|
|
|
|
|
.. doxygengroup:: fuel_gauge_interface
|
2023-05-27 04:25:59 +08:00
|
|
|
.. doxygengroup:: fuel_gauge_emulator_backend
|
