foxBMS  1.4.1
The foxBMS Battery Management System API Documentation
soh_debug.c
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 soh_debug.c
44  * @author foxBMS Team
45  * @date 2020-10-14 (date of creation)
46  * @updated 2022-10-27 (date of last update)
47  * @version v1.4.1
48  * @ingroup APPLICATION
49  * @prefix SOH
50  *
51  * @brief SOH module responsible for calculation of state-of-health (SOH)
52  *
53  */
54 
55 /*========== Includes =======================================================*/
56 #include "soh_debug.h"
57 
58 /*========== Macros and Definitions =========================================*/
59 
60 /*========== Static Constant and Variable Definitions =======================*/
61 
62 /*========== Extern Constant and Variable Definitions =======================*/
63 
64 /*========== Static Function Prototypes =====================================*/
65 
66 /*========== Static Function Implementations ================================*/
67 
68 /*========== Extern Function Implementations ================================*/
69 extern void SE_InitializeStateOfHealth(DATA_BLOCK_SOX_s *pSohValues, uint8_t stringNumber) {
70  FAS_ASSERT(pSohValues != NULL_PTR);
71  FAS_ASSERT(stringNumber < BS_NR_OF_STRINGS);
72  if (stringNumber < BS_NR_OF_STRINGS) {
73  pSohValues->averageSoh_perc[stringNumber] = 0u;
74  pSohValues->minimumSoh_perc[stringNumber] = 0u;
75  pSohValues->maximumSoh_perc[stringNumber] = 0u;
76  }
77 }
78 
79 extern void SE_CalculateStateOfHealth(DATA_BLOCK_SOX_s *pSohValues) {
80  FAS_ASSERT(pSohValues != NULL_PTR);
81 
82  pSohValues->averageSoh_perc[0u] = 50.0f;
83  pSohValues->minimumSoh_perc[0u] = 49.9f;
84  pSohValues->maximumSoh_perc[0u] = 50.1f;
85 }
86 
87 /*========== Externalized Static Function Implementations (Unit Test) =======*/
#define BS_NR_OF_STRINGS
Number of parallel strings in the battery pack.
#define FAS_ASSERT(x)
Assertion macro that asserts that x is true.
Definition: fassert.h:252
#define NULL_PTR
Null pointer.
Definition: fstd_types.h:76
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
Header for SOH module, responsible for calculation state-of-health.
float maximumSoh_perc[BS_NR_OF_STRINGS]
Definition: database_cfg.h:511
float averageSoh_perc[BS_NR_OF_STRINGS]
Definition: database_cfg.h:509
float minimumSoh_perc[BS_NR_OF_STRINGS]
Definition: database_cfg.h:510