Zephyr API Documentation 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
fuel_gauge_driver_api Struct Reference

Driver Operations Fuel Gauge driver operations More...

#include <zephyr/drivers/fuel_gauge.h>

Data Fields

fuel_gauge_get_property_t get_property
  OPT Fetch a battery fuel-gauge property.
fuel_gauge_set_property_t set_property
  OPT Set a battery fuel-gauge property.
fuel_gauge_get_buffer_property_t get_buffer_property
  OPT Fetch a battery fuel-gauge buffer property.
fuel_gauge_battery_cutoff_t battery_cutoff
  OPT Have fuel gauge cutoff its associated battery.

Detailed Description

Driver Operations Fuel Gauge driver operations

This is the driver API structure any Fuel Gauge driver needs to define. It contains function pointers to the operations the driver implements, as well as any other driver-specific constant data.

Members marked with REQ MUST be set by the driver, whereas those marked with OPT are optional.

See also
DEVICE_DT_INST_DEFINE()
DEVICE_DT_DEFINE()
DEVICE_API()

Field Documentation

◆ battery_cutoff

fuel_gauge_battery_cutoff_t fuel_gauge_driver_api::battery_cutoff

OPT Have fuel gauge cutoff its associated battery.

◆ get_buffer_property

fuel_gauge_get_buffer_property_t fuel_gauge_driver_api::get_buffer_property

OPT Fetch a battery fuel-gauge buffer property.

◆ get_property

fuel_gauge_get_property_t fuel_gauge_driver_api::get_property

OPT Fetch a battery fuel-gauge property.

◆ set_property

fuel_gauge_set_property_t fuel_gauge_driver_api::set_property

OPT Set a battery fuel-gauge property.


The documentation for this struct was generated from the following file: