nrf_fuel_gauge.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef __NRF_FUEL_GAUGE_H__
#define __NRF_FUEL_GAUGE_H__
 
#include <stdbool.h>
#include <stddef.h>
 
 
#ifdef __cplusplus
extern "C" {
#endif
 
extern const char *nrf_fuel_gauge_version;
 
extern const char *nrf_fuel_gauge_build_date;
 
struct battery_model {
        float param_1[201];
        float temps[3];
        float param_2[122];
        float param_3[201];
        float param_4[201];
        float param_5[201];
        float param_6[201];
        float param_7[122];
        float param_8[122];
        float param_9[3];
        float param_10[6];
        float param_11[6];
        float param_12[3];
        char name[64];
};
 
struct nrf_fuel_gauge_state_info {
        float yhat;
        float r0;
        float T_truncated;
};
 
struct nrf_fuel_gauge_config_parameters {
        float tau1;
        float tau2;
        float neta1;
        float neta2;
        float neta3;
        float beta1;
        float beta2;
        float tte_min_time;
        float tte_reset_threshold;
};
 
struct nrf_fuel_gauge_runtime_parameters {
        float a;
        float b;
        float c;
        float d;
        bool discard_positive_deltaz;
};
 
struct nrf_fuel_gauge_init_parameters {
        float v0;
        float i0;
        float t0;
        const struct battery_model *model;
        const struct nrf_fuel_gauge_config_parameters *opt_params;
};
 
void nrf_fuel_gauge_opt_params_default_get(struct nrf_fuel_gauge_config_parameters *opt_params);
 
int nrf_fuel_gauge_init(const struct nrf_fuel_gauge_init_parameters *parameters, float *v0);
 
float nrf_fuel_gauge_process(float v, float i, float T, float t_delta, bool vbus_present,
                             struct nrf_fuel_gauge_state_info *state);
 
float nrf_fuel_gauge_tte_get(void);
 
float nrf_fuel_gauge_ttf_get(bool cc_charging, float i_term);
 
void nrf_fuel_gauge_idle_set(float v, float T, float i_avg);
 
void nrf_fuel_gauge_param_adjust(const struct nrf_fuel_gauge_runtime_parameters *params);
 
void nrf_fuel_gauge_opt_params_adjust(const struct nrf_fuel_gauge_config_parameters *opt_params);
 
#ifdef __cplusplus
}
#endif
 
#endif /* __NRF_FUEL_GAUGE_H__ */