foxBMS - Unit Tests  1.2.1
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 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-11-08 (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 Wrapper for algorithm specific SOC initialization
72  * @param[in] cc_present true if current sensor present, false otherwise
73  * @param[in] stringNumber string addressed
74  */
75 extern void SE_SocInit(bool cc_present, uint8_t stringNumber);
76 
77 /**
78  * @brief Wrapper for algorithm specific SOE initialization
79  * @param[in] ec_present true if current sensor present, false otherwise
80  * @param[in] stringNumber string addressed
81  */
82 extern void SE_SoeInit(bool ec_present, uint8_t stringNumber);
83 
84 /**
85  * @brief Main function to perform state estimations
86  */
87 extern void SE_StateEstimations(void);
88 
89 /** \defgroup state-estimation-api State Estimation API
90  * @details This API is implemented by the state estimation functions and
91  * called by the state estimation module.
92  * @{
93  * INCLUDE MARKER FOR THE DOCUMENTATION; DO NOT MOVE se-state-estimation-api-start-include */
94 /**
95  * @brief initializes startup SOC-related values like lookup from nonvolatile
96  * ram at startup
97  * @param[out] pSocValues pointer to SOC database entry
98  * @param[in] cc_present true if current sensor present, false otherwise
99  * @param[in] stringNumber string addressed
100  */
101 extern void SOC_Init(DATA_BLOCK_SOX_s *pSocValues, bool cc_present, uint8_t stringNumber);
102 
103 /**
104  * @brief periodically called algorithm to calculate state-of-charge (SOC)
105  * @param[out] pSocValues pointer to SOC values
106  */
107 extern void SOC_Calculation(DATA_BLOCK_SOX_s *pSocValues);
108 
109 /**
110  * @brief look-up table for SOC initialization
111  * @param[in] voltage_mV voltage in mV of battery cell
112  * @return returns SOC value in percentage from 0.0% to 100.0%
113  */
114 extern float SOC_GetFromVoltage(int16_t voltage_mV);
115 
116 /**
117  * @brief initializes startup state-of-energy (SOE) related values
118  * @param[out] pSoeValues pointer to SOE database entry
119  * @param[in] ec_present true if current sensor EC message received, false otherwise
120  * @param[in] stringNumber string addressed
121  */
122 extern void SOE_Init(DATA_BLOCK_SOX_s *pSoeValues, bool ec_present, uint8_t stringNumber);
123 
124 /**
125  * @brief periodically called algorithm to calculate state-of-energy (SOE)
126  * @param[out] pSoeValues pointer to SOE database entry
127  */
128 extern void SOE_Calculation(DATA_BLOCK_SOX_s *pSoeValues);
129 
130 /**
131  * @brief initializes startup state-of-health related values
132  */
133 extern void SOH_Init(void);
134 
135 /**
136  * @brief calculates state-of-health (SOH)
137  */
138 extern void SOH_Calculation(void);
139 
140 /** INCLUDE MARKER FOR THE DOCUMENTATION; DO NOT MOVE se-state-estimation-api-stop-include
141  * @}
142  */
143 
144 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
145 
146 #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
float SOC_GetFromVoltage(int16_t voltage_mV)
look-up table for SOC initialization
Definition: soc_counting.c:370
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 SOC_Calculation(DATA_BLOCK_SOX_s *pSocValues)
periodically called algorithm to calculate state-of-charge (SOC)
Definition: soc_counting.c:279
void SOE_Calculation(DATA_BLOCK_SOX_s *pSoeValues)
periodically called algorithm to calculate state-of-energy (SOE)
Definition: soe_counting.c:355
void SE_SoeInit(bool ec_present, uint8_t stringNumber)
Wrapper for algorithm specific SOE initialization.
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.