nRF Fuel Gauge library

Algorithm for battery state-of-charge estimation ("fuel gauge"). More...

Data Structures
struct	battery_model
	Secondary cell (rechargeable) battery model parameters. More...
struct	nrf_fuel_gauge_state_info
	Library state information. Useful for debugging. More...
struct	nrf_fuel_gauge_config_parameters
	Optional static configuration parameters. More...
struct	nrf_fuel_gauge_runtime_parameters
	Optional runtime configuration parameters. More...
struct	nrf_fuel_gauge_init_parameters
	Library init parameter struct. More...

Functions
void	nrf_fuel_gauge_opt_params_default_get (struct nrf_fuel_gauge_config_parameters *opt_params)
	Initialize optional configuration parameters to default values.
int	nrf_fuel_gauge_init (const struct nrf_fuel_gauge_init_parameters *parameters, float *v0)
	Initialize the nRF Fuel Gauge library.
float	nrf_fuel_gauge_process (float v, float i, float T, float t_delta, bool vbus_present, struct nrf_fuel_gauge_state_info *state)
	Process battery measurement values.
float	nrf_fuel_gauge_tte_get (void)
	Get predicted "time-to-empty" discharge duration.
float	nrf_fuel_gauge_ttf_get (bool cc_charging, float i_term)
	Get predicted "time-to-full" charging duration.
void	nrf_fuel_gauge_idle_set (float v, float T, float i_avg)
	Put library into the idle state.
void	nrf_fuel_gauge_param_adjust (const struct nrf_fuel_gauge_runtime_parameters *params)
	Update runtime parameters.
void	nrf_fuel_gauge_opt_params_adjust (const struct nrf_fuel_gauge_config_parameters *opt_params)
	Update optional parameters.

Variables
const char *	nrf_fuel_gauge_version
	Version number of nRF Fuel Gauge library in format "x.y.z".
const char *	nrf_fuel_gauge_build_date
	Build date of nRF Fuel Gauge library.

Detailed Description

Algorithm for battery state-of-charge estimation ("fuel gauge").

The algorithm determines the predicted state-of-charge (SOC) based on the following data: specific model of the battery type used in the application along with measurements of battery voltage, current, and temperature. The SOC is a value between 0% and 100%.

Note

Current and voltage measurements do not have to be made at a certain interval. However, the two values should be measured as closely as possible in time.