foxBMS  1.4.0
The foxBMS Battery Management System API Documentation
state_estimation.h
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2022, 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 2022-07-28 (date of last update)
47  * @version v1.4.0
48  * @ingroup APPLICATION
49  * @prefix SE
50  *
51  * @brief Header for state-estimation module responsible for the estimation
52  * of state-of-charge (SOC), state-of-energy (SOE) and state-of-health
53  * (SOH). Functions as a wrapper for the individual state-estimation
54  * algorithms.
55  *
56  */
57 
58 #ifndef FOXBMS__STATE_ESTIMATION_H_
59 #define FOXBMS__STATE_ESTIMATION_H_
60 
61 /*========== Includes =======================================================*/
62 #include "general.h"
63 
64 #include "database.h"
65 
66 /*========== Macros and Definitions =========================================*/
67 
68 /*========== Extern Constant and Variable Declarations ======================*/
69 
70 /*========== Extern Function Prototypes =====================================*/
71 /**
72  * @brief Wrapper for algorithm specific SOC initialization
73  * @param[in] ccPresent true if current sensor present, false otherwise
74  * @param[in] stringNumber string addressed
75  */
76 extern void SE_InitializeSoc(bool ccPresent, uint8_t stringNumber);
77 
78 /**
79  * @brief Wrapper for algorithm specific SOE initialization
80  * @param[in] ec_present true if current sensor present, false otherwise
81  * @param[in] stringNumber string addressed
82  */
83 extern void SE_InitializeSoe(bool ec_present, uint8_t stringNumber);
84 
85 /**
86  * @brief Wrapper for algorithm specific SOH initialization
87  * @param[in] stringNumber string addressed
88  */
89 extern void SE_InitializeSoh(uint8_t stringNumber);
90 
91 /**
92  * @brief Main function to perform state estimations
93  */
94 extern void SE_RunStateEstimations(void);
95 
96 /** \defgroup state-estimation-api State Estimation API
97  * @details This API is implemented by the state estimation functions and
98  * called by the state estimation module.
99  * @{
100  * INCLUDE MARKER FOR THE DOCUMENTATION; DO NOT MOVE se-state-estimation-api-start-include */
101 /**
102  * @brief initializes startup SOC-related values like lookup from nonvolatile
103  * ram at startup
104  * @param[out] pSocValues pointer to SOC database entry
105  * @param[in] ccPresent true if current sensor present, false otherwise
106  * @param[in] stringNumber string addressed
107  */
108 extern void SE_InitializeStateOfCharge(DATA_BLOCK_SOX_s *pSocValues, bool ccPresent, uint8_t stringNumber);
109 
110 /**
111  * @brief periodically called algorithm to calculate state-of-charge (SOC)
112  * @param[out] pSocValues pointer to SOC values
113  */
114 extern void SE_CalculateStateOfCharge(DATA_BLOCK_SOX_s *pSocValues);
115 
116 /**
117  * @brief look-up table for SOC initialization
118  * @param[in] voltage_mV voltage in mV of battery cell
119  * @return returns SOC value in percentage from 0.0% to 100.0%
120  */
121 extern float SE_GetStateOfChargeFromVoltage(int16_t voltage_mV);
122 
123 /**
124  * @brief initializes startup state-of-energy (SOE) related values
125  * @param[out] pSoeValues pointer to SOE database entry
126  * @param[in] ec_present true if current sensor EC message received, false otherwise
127  * @param[in] stringNumber string addressed
128  */
129 extern void SE_InitializeStateOfEnergy(DATA_BLOCK_SOX_s *pSoeValues, bool ec_present, uint8_t stringNumber);
130 
131 /**
132  * @brief periodically called algorithm to calculate state-of-energy (SOE)
133  * @param[out] pSoeValues pointer to SOE database entry
134  */
135 extern void SE_CalculateStateOfEnergy(DATA_BLOCK_SOX_s *pSoeValues);
136 
137 /**
138  * @brief initializes startup state-of-health related values
139  * @param[out] pSohValues pointer to SOH database entry
140  * @param[in] stringNumber string addressed
141  */
142 extern void SE_InitializeStateOfHealth(DATA_BLOCK_SOX_s *pSohValues, uint8_t stringNumber);
143 
144 /**
145  * @brief calculates state-of-health (SOH)
146  * @param[out] pSohValues pointer to SOH database entry
147  */
148 extern void SE_CalculateStateOfHealth(DATA_BLOCK_SOX_s *pSohValues);
149 
150 /** INCLUDE MARKER FOR THE DOCUMENTATION; DO NOT MOVE se-state-estimation-api-stop-include
151  * @}
152  */
153 
154 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
155 
156 #endif /* FOXBMS__STATE_ESTIMATION_H_ */
Database module header.
General macros and definitions for the whole platform.
void SE_CalculateStateOfCharge(DATA_BLOCK_SOX_s *pSocValues)
periodically called algorithm to calculate state-of-charge (SOC)
Definition: soc_counting.c:280
void SE_InitializeStateOfCharge(DATA_BLOCK_SOX_s *pSocValues, bool ccPresent, uint8_t stringNumber)
initializes startup SOC-related values like lookup from nonvolatile ram at startup
Definition: soc_counting.c:238
float SE_GetStateOfChargeFromVoltage(int16_t voltage_mV)
look-up table for SOC initialization
Definition: soc_counting.c:359
void SE_CalculateStateOfHealth(DATA_BLOCK_SOX_s *pSohValues)
calculates state-of-health (SOH)
Definition: soh_debug.c:79
void SE_InitializeStateOfHealth(DATA_BLOCK_SOX_s *pSohValues, uint8_t stringNumber)
initializes startup state-of-health related values
Definition: soh_debug.c:69
void SE_InitializeStateOfEnergy(DATA_BLOCK_SOX_s *pSoeValues, bool ec_present, uint8_t stringNumber)
initializes startup state-of-energy (SOE) related values
Definition: soe_counting.c:312
void SE_CalculateStateOfEnergy(DATA_BLOCK_SOX_s *pSoeValues)
periodically called algorithm to calculate state-of-energy (SOE)
Definition: soe_counting.c:356
void SE_InitializeSoe(bool ec_present, uint8_t stringNumber)
Wrapper for algorithm specific SOE initialization.
void SE_InitializeSoc(bool ccPresent, uint8_t stringNumber)
Wrapper for algorithm specific SOC initialization.
void SE_InitializeSoh(uint8_t stringNumber)
Wrapper for algorithm specific SOH initialization.
void SE_RunStateEstimations(void)
Main function to perform state estimations.