foxBMS-UnitTests  1.0.0
The foxBMS Unit Tests API Documentation
state_estimation.h
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2021, Fraunhofer-Gesellschaft zur Foerderung der
4  * angewandten Forschung e.V. All rights reserved.
5  *
6  * BSD 3-Clause License
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  * 1. Redistributions of source code must retain the above copyright notice,
10  * this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the distribution.
14  * 3. Neither the name of the copyright holder nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  *
30  * We kindly request you to use one or more of the following phrases to refer
31  * to foxBMS in your hardware, software, documentation or advertising
32  * materials:
33  *
34  * ″This product uses parts of foxBMS®″
35  *
36  * ″This product includes parts of foxBMS®″
37  *
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 2020-10-14 (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 /*========== Macros and Definitions =========================================*/
64 
65 /*========== Extern Constant and Variable Declarations ======================*/
66 
67 /*========== Extern Function Prototypes =====================================*/
68 /**
69  * @brief initializes startup SOC-related values like lookup from nonvolatile
70  * ram at startup
71  * @param[in] cc_present true if current sensor present, false otherwise
72  * @param[in] stringNumber string addressed
73  */
74 extern void SOC_Init(bool cc_present, uint8_t stringNumber);
75 
76 /**
77  * @brief integrates current over time to calculate SOC.
78  */
79 extern void SOC_Calculation(void);
80 
81 /**
82  * @brief look-up table for SOC initialization (average, min and max).
83  *
84  * @param[in] voltage_mV voltage of battery cell
85  *
86  * @return SOC value
87  */
88 extern float SOC_GetFromVoltage(int16_t voltage_mV);
89 
90 /**
91  * @brief initializes startup state-of-energy (SOE) related values
92  *
93  * @param[in] ec_present true if current sensor EC message received, false otherwise
94  * @param[in] stringNumber string addressed
95  */
96 extern void SOE_Init(bool ec_present, uint8_t stringNumber);
97 
98 /**
99  * @brief calculates state-of-energy (SOE)
100  */
101 extern void SOE_Calculation(void);
102 
103 /**
104  * @brief initializes startup state-of-health related values
105  */
106 extern void SOH_Init(void);
107 
108 /**
109  * @brief calculates state-of-health (SOH)
110  */
111 extern void SOH_Calculation(void);
112 
113 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
114 
115 #endif /* FOXBMS__STATE_ESTIMATION_H_ */
general.h
TODO.
SOC_Calculation
void SOC_Calculation(void)
integrates current over time to calculate SOC.
Definition: soc_counting.c:262
SOC_GetFromVoltage
float SOC_GetFromVoltage(int16_t voltage_mV)
look-up table for SOC initialization (average, min and max).
Definition: soc_counting.c:352
SOE_Calculation
void SOE_Calculation(void)
calculates state-of-energy (SOE)
Definition: soe_counting.c:331
SOH_Calculation
void SOH_Calculation(void)
calculates state-of-health (SOH)
SOE_Init
void SOE_Init(bool ec_present, uint8_t stringNumber)
initializes startup state-of-energy (SOE) related values
Definition: soe_counting.c:292
SOH_Init
void SOH_Init(void)
initializes startup state-of-health related values
SOC_Init
void SOC_Init(bool cc_present, uint8_t stringNumber)
initializes startup SOC-related values like lookup from nonvolatile ram at startup
Definition: soc_counting.c:226