OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/doc/hardware/peripherals/fuel_gauge.rst

51 lines
1.5 KiB
ReStructuredText
Raw Normal View History

fuel_gauge: Add basic stub API doc. Add a short stub doc as a placeholder for future documentation on the fuel gauge API. Signed-off-by: Aaron Massey <aaronmassey@google.com>
2022-11-19 04:59:37 +08:00
.. _fuel_gauge_api:
doc: peripherals: fuel_gauge: align title with the rest of the docs Align the title for the fuel gauge peripheral API with the rest of the documentation. Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2023-03-30 15:47:14 +08:00
Fuel Gauge
##########
fuel_gauge: Add basic stub API doc. Add a short stub doc as a placeholder for future documentation on the fuel gauge API. Signed-off-by: Aaron Massey <aaronmassey@google.com>
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.
fuel_gauge: Repl property struct w/ union Based on review of the similar charger driver API, it's been demonstrated from the community that embedding a per value property type when fetching properties. Separating off the property types from the property values themselves also allow an array of property types to declared as static const. Break up fuel_gauge_property struct into a fuel_gauge_prop_val union and a fuel_gauge_prop_t property type as inputs into fuel gauge API functions. Signed-off-by: Aaron Massey <aaronmassey@google.com>
2023-09-23 02:17:27 +08:00
Properties are fetched by the client one at a time using :c:func:`fuel_gauge_get_prop`, or fetched
in a batch using :c:func:`fuel_gauge_get_props`.
Properties are set by the client one at a time using :c:func:`fuel_gauge_set_prop`, or set in a
batch using :c:func:`fuel_gauge_set_props`.
fuel_gauge: Add basic stub API doc. Add a short stub doc as a placeholder for future documentation on the fuel gauge API. Signed-off-by: Aaron Massey <aaronmassey@google.com>
2022-11-19 04:59:37 +08:00
fuel_gauge: Add battery cutoff support Many fuel gauge ICs offer a battery cutoff/shipping mode functionality that cutoff charge from the battery. This is often useful for preserving battery charge on devices while in storage. Add battery cutoff support to the fuel gauge API with a generic default SBS driver showing an example of support in tests. Signed-off-by: Aaron Massey <aaronmassey@google.com>
2023-08-17 04:39:38 +08:00
Battery Cutoff
==============
Many fuel gauges embedded within battery packs expose a register address that when written to with a
specific payload will do a battery cutoff. This battery cutoff is often referred to as ship, shelf,
or sleep mode due to its utility in reducing battery drain while devices are stored or shipped.
The fuel gauge API exposes battery cutoff with the :c:func:`fuel_gauge_battery_cutoff` function.
fuel_gauge: Add basic stub API doc. Add a short stub doc as a placeholder for future documentation on the fuel gauge API. Signed-off-by: Aaron Massey <aaronmassey@google.com>
2022-11-19 04:59:37 +08:00
Caching
=======
The Fuel Gauge API explicitly provides no caching for its clients.
.. _fuel_gauge_api_reference:
API Reference
*************
.. doxygengroup:: fuel_gauge_interface
emul: Add SBS Gauge emulator backend_api In order to support easier setup of test scenarios with fuel gauge emulators, we should expose an API that can change internal emulator state. Add a minimal fuel gauge emulator backend API for setting the charging current and voltage with a sample implementation in the emul_sbs_gauge with an associated driver test. Signed-off-by: Aaron Massey <aaronmassey@google.com>
2023-05-27 04:25:59 +08:00
.. doxygengroup:: fuel_gauge_emulator_backend