battery APIs

battery API More...

Macros
#define	BATTERY_OCV_TABLE_LEN   11
#define	BATTERY_CHEMISTRY_DT_GET(node_id)    UTIL_CAT(BATTERY_CHEMISTRY_, DT_STRING_UPPER_TOKEN_OR(node_id, device_chemistry, UNKNOWN))
	Get the battery chemistry enum value.
#define	BATTERY_OCV_TABLE_DT_GET(node_id, table)
	Get the OCV curve for a given table.

Enumerations
enum	battery_chemistry {   BATTERY_CHEMISTRY_UNKNOWN = 0 , BATTERY_CHEMISTRY_NICKEL_CADMIUM , BATTERY_CHEMISTRY_NICKEL_METAL_HYDRIDE , BATTERY_CHEMISTRY_LITHIUM_ION ,   BATTERY_CHEMISTRY_LITHIUM_ION_POLYMER , BATTERY_CHEMISTRY_LITHIUM_ION_IRON_PHOSPHATE , BATTERY_CHEMISTRY_LITHIUM_ION_MANGANESE_OXIDE }

Functions
static int32_t	battery_soc_lookup (const int32_t ocv_table[11], uint32_t voltage_uv)
	Convert an OCV table and battery voltage to a charge percentage.

Detailed Description

battery API

Macro Definition Documentation

BATTERY_CHEMISTRY_DT_GET

#define BATTERY_CHEMISTRY_DT_GET

(

node_id

)

UTIL_CAT(BATTERY_CHEMISTRY_, DT_STRING_UPPER_TOKEN_OR(node_id, device_chemistry, UNKNOWN))

#include <include/zephyr/drivers/sensor/battery.h>

Get the battery chemistry enum value.

Parameters

node_id

node identifier

BATTERY_OCV_TABLE_DT_GET

#define BATTERY_OCV_TABLE_DT_GET	(		node_id,
			table
	)

#include <include/zephyr/drivers/sensor/battery.h>

Value:

        COND_CODE_1(DT_NODE_HAS_PROP(node_id, table),                                              \
                    ({DT_FOREACH_PROP_ELEM_SEP(node_id, table, DT_PROP_BY_IDX, (,))}), ({-1}))

Get the OCV curve for a given table.

Parameters

node_id	node identifier
table	table to retrieve

BATTERY_OCV_TABLE_LEN

#define BATTERY_OCV_TABLE_LEN   11

#include <include/zephyr/drivers/sensor/battery.h>

Enumeration Type Documentation

battery_chemistry

enum battery_chemistry

#include <include/zephyr/drivers/sensor/battery.h>

Enumerator
BATTERY_CHEMISTRY_UNKNOWN
BATTERY_CHEMISTRY_NICKEL_CADMIUM
BATTERY_CHEMISTRY_NICKEL_METAL_HYDRIDE
BATTERY_CHEMISTRY_LITHIUM_ION
BATTERY_CHEMISTRY_LITHIUM_ION_POLYMER
BATTERY_CHEMISTRY_LITHIUM_ION_IRON_PHOSPHATE
BATTERY_CHEMISTRY_LITHIUM_ION_MANGANESE_OXIDE

Function Documentation

battery_soc_lookup()

static int32_t battery_soc_lookup ( const int32_t  ocv_table[11], uint32_t  voltage_uv  )

inlinestatic

#include <include/zephyr/drivers/sensor/battery.h>

Convert an OCV table and battery voltage to a charge percentage.

Parameters

ocv_table	Open circuit voltage curve
voltage_uv	Battery voltage in microVolts

Returns

Battery state of charge in milliPercent