foxBMS  1.6.0
The foxBMS Battery Management System API Documentation
soa_cfg.c
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2023, 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 soa_cfg.c
44  * @author foxBMS Team
45  * @date 2020-10-14 (date of creation)
46  * @updated 2023-10-12 (date of last update)
47  * @version v1.6.0
48  * @ingroup APPLICATION_CONFIGURATION
49  * @prefix SOA
50  *
51  * @brief Configuration for safe-operating area check
52  *
53  */
54 
55 /*========== Includes =======================================================*/
56 #include "soa_cfg.h"
57 
58 #include "battery_cell_cfg.h"
59 #include "battery_system_cfg.h"
60 
61 #include <stdbool.h>
62 #include <stdint.h>
63 
64 /*========== Macros and Definitions =========================================*/
65 
66 /*========== Static Constant and Variable Definitions =======================*/
67 
68 /*========== Extern Constant and Variable Definitions =======================*/
69 
70 /*========== Static Function Prototypes =====================================*/
71 
72 /*========== Static Function Implementations ================================*/
73 
74 /*========== Extern Function Implementations ================================*/
75 bool SOA_IsPackCurrentLimitViolated(uint32_t current_mA, BMS_CURRENT_FLOW_STATE_e currentDirection) {
76  bool currentLimitViolated = false;
77  /* Only check if battery is not at rest. No overcurrent possible if battery is resting */
78  if ((currentDirection == BMS_CHARGING) || (currentDirection == BMS_DISCHARGING)) {
79  if (current_mA > BS_MAXIMUM_PACK_CURRENT_mA) {
80  currentLimitViolated = true;
81  }
82  }
83  return currentLimitViolated;
84 }
85 
86 bool SOA_IsStringCurrentLimitViolated(uint32_t current_mA, BMS_CURRENT_FLOW_STATE_e currentDirection) {
87  bool currentLimitViolated = false;
88  /* Only check if battery is not at rest. No overcurrent possible if battery is resting */
89  if ((currentDirection == BMS_CHARGING) || (currentDirection == BMS_DISCHARGING)) {
90  if (current_mA > BS_MAXIMUM_STRING_CURRENT_mA) {
91  currentLimitViolated = true;
92  }
93  }
94  return currentLimitViolated;
95 }
96 
97 bool SOA_IsCellCurrentLimitViolated(uint32_t current_mA, BMS_CURRENT_FLOW_STATE_e currentDirection) {
98  bool currentLimitViolated = false;
99  /* Only check if battery is not at rest. No overcurrent possible if battery is resting */
100  if (currentDirection == BMS_CHARGING) {
102  currentLimitViolated = true;
103  }
104  } else if (currentDirection == BMS_DISCHARGING) {
106  currentLimitViolated = true;
107  }
108  } else {
109  /* BMS_RELAXATION or BMS_AT_REST */
110  currentLimitViolated = false;
111  }
112  return currentLimitViolated;
113 }
114 
115 bool SOA_IsCurrentOnOpenString(BMS_CURRENT_FLOW_STATE_e currentDirection, uint8_t stringNumber) {
116  FAS_ASSERT(stringNumber < BS_NR_OF_STRINGS);
117  bool currentOnOpenString = false;
118  /* Current is flowing as soon as a current direction detected */
119  if ((currentDirection == BMS_CHARGING) || (currentDirection == BMS_DISCHARGING)) {
120  const bool stringClosed = BMS_IsStringClosed(stringNumber);
121  const bool stringPrecharging = BMS_IsStringPrecharging(stringNumber);
122  /* String appears to be open */
123  if ((stringClosed == false) && (stringPrecharging == false)) {
124  currentOnOpenString = true;
125  }
126  }
127  return currentOnOpenString;
128 }
129 
130 /*========== Externalized Static Function Implementations (Unit Test) =======*/
131 #ifdef UNITY_UNIT_TEST
132 #endif
Configuration of the battery cell (e.g., minimum and maximum cell voltage)
#define BC_CURRENT_MAX_DISCHARGE_MSL_mA
Maximum discharge current limit.
#define BC_CURRENT_MAX_CHARGE_MSL_mA
Maximum charge current limit.
Configuration of the battery system (e.g., number of battery modules, battery cells,...
#define BS_NR_OF_PARALLEL_CELLS_PER_CELL_BLOCK
number of parallel connected battery cells in a cell block
#define BS_NR_OF_STRINGS
Number of parallel strings in the battery pack.
#define BS_MAXIMUM_PACK_CURRENT_mA
Maximum pack current limit in mA that is used in the SOA module to check for pack overcurrent.
#define BS_MAXIMUM_STRING_CURRENT_mA
Maximum string current limit in mA that is used in the SOA module to check for string overcurrent.
bool BMS_IsStringPrecharging(uint8_t stringNumber)
Returns if string is currently precharging or not.
Definition: bms.c:1623
bool BMS_IsStringClosed(uint8_t stringNumber)
Returns string state (closed or open)
Definition: bms.c:1614
BMS_CURRENT_FLOW_STATE_e
Definition: bms.h:72
@ BMS_DISCHARGING
Definition: bms.h:74
@ BMS_CHARGING
Definition: bms.h:73
#define FAS_ASSERT(x)
Assertion macro that asserts that x is true.
Definition: fassert.h:255
bool SOA_IsCurrentOnOpenString(BMS_CURRENT_FLOW_STATE_e currentDirection, uint8_t stringNumber)
Checks if string current is floating while contactors are open.
Definition: soa_cfg.c:115
bool SOA_IsPackCurrentLimitViolated(uint32_t current_mA, BMS_CURRENT_FLOW_STATE_e currentDirection)
Checks if pack current limit is violated.
Definition: soa_cfg.c:75
bool SOA_IsStringCurrentLimitViolated(uint32_t current_mA, BMS_CURRENT_FLOW_STATE_e currentDirection)
Checks if string current limit is violated.
Definition: soa_cfg.c:86
bool SOA_IsCellCurrentLimitViolated(uint32_t current_mA, BMS_CURRENT_FLOW_STATE_e currentDirection)
Checks if cell current limit is violated.
Definition: soa_cfg.c:97
Configuration header for SOA.