foxBMS  1.1.2
The foxBMS Battery Management System API Documentation
state_estimation.h
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2021, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V.
4  * All rights reserved.
5  *
6  * SPDX-License-Identifier: BSD-3-Clause
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright notice, this
12  * list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright notice,
15  * this list of conditions and the following disclaimer in the documentation
16  * and/or other materials provided with the distribution.
17  *
18  * 3. Neither the name of the copyright holder nor the names of its
19  * contributors may be used to endorse or promote products derived from
20  * this software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
23  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
28  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  *
33  * We kindly request you to use one or more of the following phrases to refer to
34  * foxBMS in your hardware, software, documentation or advertising materials:
35  *
36  * - ″This product uses parts of foxBMS®″
37  * - ″This product includes parts of foxBMS®″
38  * - ″This product is derived from foxBMS®″
39  *
40  */
41 
42 /**
43  * @file state_estimation.h
44  * @author foxBMS Team
45  * @date 2020-10-14 (date of creation)
46  * @updated 2021-05-21 (date of last update)
47  * @ingroup APPLICATION
48  * @prefix SE
49  *
50  * @brief Header for state-estimation module responsible for the estimation
51  * of state-of-charge (SOC), state-of-energy (SOE) and state-of-health
52  * (SOH). Functions as a wrapper for the individual state-estimation
53  * algorithms.
54  *
55  */
56 
57 #ifndef FOXBMS__STATE_ESTIMATION_H_
58 #define FOXBMS__STATE_ESTIMATION_H_
59 
60 /*========== Includes =======================================================*/
61 #include "general.h"
62 
63 #include "database.h"
64 
65 /*========== Macros and Definitions =========================================*/
66 
67 /*========== Extern Constant and Variable Declarations ======================*/
68 
69 /*========== Extern Function Prototypes =====================================*/
70 /**
71  * @brief initializes startup SOC-related values like lookup from nonvolatile
72  * ram at startup
73  * @param[out] pSocValues pointer to SOC database entry
74  * @param[in] cc_present true if current sensor present, false otherwise
75  * @param[in] stringNumber string addressed
76  */
77 extern void SOC_Init(DATA_BLOCK_SOX_s *pSocValues, bool cc_present, uint8_t stringNumber);
78 
79 /**
80  * @brief Wrapper for algorithm specific SOC initialization
81  * @param[in] cc_present true if current sensor present, false otherwise
82  * @param[in] stringNumber string addressed
83  */
84 extern void SE_SocInit(bool cc_present, uint8_t stringNumber);
85 
86 /**
87  * @brief periodically called algorithm to calculate state-of-charge (SOC)
88  * @param[out] pSocValues pointer to SOC values
89  */
90 extern void SOC_Calculation(DATA_BLOCK_SOX_s *pSocValues);
91 
92 /**
93  * @brief look-up table for SOC initialization
94  * @param[in] voltage_mV voltage in mV of battery cell
95  * @return returns SOC value in percentage from 0.0% to 100.0%
96  */
97 extern float SOC_GetFromVoltage(int16_t voltage_mV);
98 
99 /**
100  * @brief initializes startup state-of-energy (SOE) related values
101  * @param[out] pSoeValues pointer to SOE database entry
102  * @param[in] ec_present true if current sensor EC message received, false otherwise
103  * @param[in] stringNumber string addressed
104  */
105 extern void SOE_Init(DATA_BLOCK_SOX_s *pSoeValues, bool ec_present, uint8_t stringNumber);
106 
107 /**
108  * @brief Wrapper for algorithm specific SOE initialization
109  * @param[in] ec_present true if current sensor present, false otherwise
110  * @param[in] stringNumber string addressed
111  */
112 extern void SE_SoeInit(bool ec_present, uint8_t stringNumber);
113 
114 /**
115  * @brief periodically called algorithm to calculate state-of-energy (SOE)
116  * @param[out] pSoeValues pointer to SOE database entry
117  */
118 extern void SOE_Calculation(DATA_BLOCK_SOX_s *pSoeValues);
119 
120 /**
121  * @brief initializes startup state-of-health related values
122  */
123 extern void SOH_Init(void);
124 
125 /**
126  * @brief calculates state-of-health (SOH)
127  */
128 extern void SOH_Calculation(void);
129 
130 /**
131  * @brief Main function to perform state estimations
132  */
133 extern void SE_StateEstimations(void);
134 
135 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
136 
137 #endif /* FOXBMS__STATE_ESTIMATION_H_ */
Database module header.
General macros and definitions for the whole platform.
void SOH_Calculation(void)
calculates state-of-health (SOH)
void SOE_Init(DATA_BLOCK_SOX_s *pSoeValues, bool ec_present, uint8_t stringNumber)
initializes startup state-of-energy (SOE) related values
Definition: soe_counting.c:311
void SOH_Init(void)
initializes startup state-of-health related values
void SE_SoeInit(bool ec_present, uint8_t stringNumber)
Wrapper for algorithm specific SOE initialization.
float SOC_GetFromVoltage(int16_t voltage_mV)
look-up table for SOC initialization
Definition: soc_counting.c:368
void SOC_Init(DATA_BLOCK_SOX_s *pSocValues, bool cc_present, uint8_t stringNumber)
initializes startup SOC-related values like lookup from nonvolatile ram at startup
Definition: soc_counting.c:236
void SE_StateEstimations(void)
Main function to perform state estimations.
void SE_SocInit(bool cc_present, uint8_t stringNumber)
Wrapper for algorithm specific SOC initialization.
void SOC_Calculation(DATA_BLOCK_SOX_s *pSocValues)
periodically called algorithm to calculate state-of-charge (SOC)
Definition: soc_counting.c:278
void SOE_Calculation(DATA_BLOCK_SOX_s *pSoeValues)
periodically called algorithm to calculate state-of-energy (SOE)
Definition: soe_counting.c:355