foxBMS - Unit Tests  1.2.1
The foxBMS Unit Tests API Documentation
test_soa_cfg.c
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 test_soa_cfg.c
44  * @author foxBMS Team
45  * @date 2020-04-01 (date of creation)
46  * @updated 2020-04-01 (date of last update)
47  * @ingroup UNIT_TEST_IMPLEMENTATION
48  * @prefix TEST
49  *
50  * @brief Test for the configuration for SOX
51  *
52  */
53 
54 /*========== Includes =======================================================*/
55 #include "unity.h"
56 #include "Mockbattery_cell_cfg.h"
57 #include "Mockbms.h"
58 
59 #include "soa_cfg.h"
60 
61 /*========== Definitions and Implementations for Unit Test ==================*/
62 
63 /*========== Setup and Teardown =============================================*/
64 void setUp(void) {
65 }
66 
67 void tearDown(void) {
68 }
69 
70 /*========== Test Cases =====================================================*/
71 
72 void testDummy(void) {
73 }
74 
75 void testSOA_IsPackCurrentLimitViolated(void) {
76  TEST_ASSERT_EQUAL(false, SOA_IsPackCurrentLimitViolated(0u, BMS_CHARGING));
77  TEST_ASSERT_EQUAL(false, SOA_IsPackCurrentLimitViolated(0u, BMS_DISCHARGING));
78  TEST_ASSERT_EQUAL(false, SOA_IsPackCurrentLimitViolated(0u, BMS_RELAXATION));
79  TEST_ASSERT_EQUAL(false, SOA_IsPackCurrentLimitViolated(0u, BMS_AT_REST));
80 
81  TEST_ASSERT_EQUAL(false, SOA_IsPackCurrentLimitViolated(BS_MAXIMUM_PACK_CURRENT_mA, BMS_CHARGING));
82  TEST_ASSERT_EQUAL(false, SOA_IsPackCurrentLimitViolated(BS_MAXIMUM_PACK_CURRENT_mA, BMS_DISCHARGING));
83  TEST_ASSERT_EQUAL(false, SOA_IsPackCurrentLimitViolated(BS_MAXIMUM_PACK_CURRENT_mA, BMS_RELAXATION));
84  TEST_ASSERT_EQUAL(false, SOA_IsPackCurrentLimitViolated(BS_MAXIMUM_PACK_CURRENT_mA, BMS_AT_REST));
85 
86  TEST_ASSERT_EQUAL(true, SOA_IsPackCurrentLimitViolated(BS_MAXIMUM_PACK_CURRENT_mA + 1u, BMS_CHARGING));
87  TEST_ASSERT_EQUAL(true, SOA_IsPackCurrentLimitViolated(BS_MAXIMUM_PACK_CURRENT_mA + 1u, BMS_DISCHARGING));
88  TEST_ASSERT_EQUAL(false, SOA_IsPackCurrentLimitViolated(BS_MAXIMUM_PACK_CURRENT_mA + 1u, BMS_RELAXATION));
89  TEST_ASSERT_EQUAL(false, SOA_IsPackCurrentLimitViolated(BS_MAXIMUM_PACK_CURRENT_mA + 1u, BMS_AT_REST));
90 
91  TEST_ASSERT_EQUAL(true, SOA_IsPackCurrentLimitViolated(UINT32_MAX, BMS_CHARGING));
92  TEST_ASSERT_EQUAL(true, SOA_IsPackCurrentLimitViolated(UINT32_MAX, BMS_DISCHARGING));
93  TEST_ASSERT_EQUAL(false, SOA_IsPackCurrentLimitViolated(UINT32_MAX, BMS_RELAXATION));
94  TEST_ASSERT_EQUAL(false, SOA_IsPackCurrentLimitViolated(UINT32_MAX, BMS_AT_REST));
95 }
96 
97 void testSOA_IsStringCurrentLimitViolated(void) {
98  TEST_ASSERT_EQUAL(false, SOA_IsStringCurrentLimitViolated(0u, BMS_CHARGING));
99  TEST_ASSERT_EQUAL(false, SOA_IsStringCurrentLimitViolated(0u, BMS_DISCHARGING));
100  TEST_ASSERT_EQUAL(false, SOA_IsStringCurrentLimitViolated(0u, BMS_RELAXATION));
101  TEST_ASSERT_EQUAL(false, SOA_IsStringCurrentLimitViolated(0u, BMS_AT_REST));
102 
103  TEST_ASSERT_EQUAL(false, SOA_IsStringCurrentLimitViolated(BS_MAXIMUM_STRING_CURRENT_mA, BMS_CHARGING));
104  TEST_ASSERT_EQUAL(false, SOA_IsStringCurrentLimitViolated(BS_MAXIMUM_STRING_CURRENT_mA, BMS_DISCHARGING));
105  TEST_ASSERT_EQUAL(false, SOA_IsStringCurrentLimitViolated(BS_MAXIMUM_STRING_CURRENT_mA, BMS_RELAXATION));
106  TEST_ASSERT_EQUAL(false, SOA_IsStringCurrentLimitViolated(BS_MAXIMUM_STRING_CURRENT_mA, BMS_AT_REST));
107 
108  TEST_ASSERT_EQUAL(true, SOA_IsStringCurrentLimitViolated(BS_MAXIMUM_STRING_CURRENT_mA + 1u, BMS_CHARGING));
109  TEST_ASSERT_EQUAL(true, SOA_IsStringCurrentLimitViolated(BS_MAXIMUM_STRING_CURRENT_mA + 1u, BMS_DISCHARGING));
110  TEST_ASSERT_EQUAL(false, SOA_IsStringCurrentLimitViolated(BS_MAXIMUM_STRING_CURRENT_mA + 1u, BMS_RELAXATION));
111  TEST_ASSERT_EQUAL(false, SOA_IsStringCurrentLimitViolated(BS_MAXIMUM_STRING_CURRENT_mA + 1u, BMS_AT_REST));
112 
113  TEST_ASSERT_EQUAL(true, SOA_IsStringCurrentLimitViolated(UINT32_MAX, BMS_CHARGING));
114  TEST_ASSERT_EQUAL(true, SOA_IsStringCurrentLimitViolated(UINT32_MAX, BMS_DISCHARGING));
115  TEST_ASSERT_EQUAL(false, SOA_IsStringCurrentLimitViolated(UINT32_MAX, BMS_RELAXATION));
116  TEST_ASSERT_EQUAL(false, SOA_IsStringCurrentLimitViolated(UINT32_MAX, BMS_AT_REST));
117 }
118 
119 void testSOA_IsCellCurrentLimitViolated(void) {
120  TEST_ASSERT_EQUAL(false, SOA_IsCellCurrentLimitViolated(0u, BMS_CHARGING));
121  TEST_ASSERT_EQUAL(false, SOA_IsCellCurrentLimitViolated(0u, BMS_DISCHARGING));
122  TEST_ASSERT_EQUAL(false, SOA_IsCellCurrentLimitViolated(0u, BMS_RELAXATION));
123  TEST_ASSERT_EQUAL(false, SOA_IsCellCurrentLimitViolated(0u, BMS_AT_REST));
124 
125  uint32_t chargeLimit = BS_NR_OF_PARALLEL_CELLS_PER_MODULE * BC_CURRENT_MAX_CHARGE_MSL_mA;
126  uint32_t dischargeLimit = BS_NR_OF_PARALLEL_CELLS_PER_MODULE * BC_CURRENT_MAX_DISCHARGE_MSL_mA;
127 
128  TEST_ASSERT_EQUAL(false, SOA_IsCellCurrentLimitViolated(chargeLimit, BMS_CHARGING));
129  TEST_ASSERT_EQUAL(false, SOA_IsCellCurrentLimitViolated(dischargeLimit, BMS_DISCHARGING));
130  TEST_ASSERT_EQUAL(false, SOA_IsCellCurrentLimitViolated(chargeLimit, BMS_RELAXATION));
131  TEST_ASSERT_EQUAL(false, SOA_IsCellCurrentLimitViolated(chargeLimit, BMS_AT_REST));
132  TEST_ASSERT_EQUAL(false, SOA_IsCellCurrentLimitViolated(dischargeLimit, BMS_RELAXATION));
133  TEST_ASSERT_EQUAL(false, SOA_IsCellCurrentLimitViolated(dischargeLimit, BMS_AT_REST));
134 
135  TEST_ASSERT_EQUAL(true, SOA_IsCellCurrentLimitViolated(chargeLimit + 1u, BMS_CHARGING));
136  TEST_ASSERT_EQUAL(true, SOA_IsCellCurrentLimitViolated(dischargeLimit + 1u, BMS_DISCHARGING));
137  TEST_ASSERT_EQUAL(false, SOA_IsCellCurrentLimitViolated(chargeLimit + 1u, BMS_RELAXATION));
138  TEST_ASSERT_EQUAL(false, SOA_IsCellCurrentLimitViolated(chargeLimit + 1u, BMS_AT_REST));
139  TEST_ASSERT_EQUAL(false, SOA_IsCellCurrentLimitViolated(dischargeLimit + 1u, BMS_RELAXATION));
140  TEST_ASSERT_EQUAL(false, SOA_IsCellCurrentLimitViolated(dischargeLimit + 1u, BMS_AT_REST));
141 
142  TEST_ASSERT_EQUAL(true, SOA_IsCellCurrentLimitViolated(UINT32_MAX, BMS_CHARGING));
143  TEST_ASSERT_EQUAL(true, SOA_IsCellCurrentLimitViolated(UINT32_MAX, BMS_DISCHARGING));
144  TEST_ASSERT_EQUAL(false, SOA_IsCellCurrentLimitViolated(UINT32_MAX, BMS_RELAXATION));
145  TEST_ASSERT_EQUAL(false, SOA_IsCellCurrentLimitViolated(UINT32_MAX, BMS_AT_REST));
146 }
147 
148 void testSOA_IsCurrentOnOpenString(void) {
149  BMS_IsStringClosed_ExpectAndReturn(0u, false);
150  BMS_IsStringPrecharging_ExpectAndReturn(0u, false);
151  TEST_ASSERT_EQUAL(true, SOA_IsCurrentOnOpenString(BMS_CHARGING, 0u));
152 
153  /* the following test can not be used as long as side-effects in if-clause are not resolved
154  BMS_IsStringClosed_ExpectAndReturn(0u, true);
155  BMS_IsStringPrecharging_ExpectAndReturn(0u, false);
156  TEST_ASSERT_EQUAL(false, SOA_IsCurrentOnOpenString(BMS_CHARGING, 0u));
157 
158  BMS_IsStringClosed_ExpectAndReturn(0u, false);
159  BMS_IsStringPrecharging_ExpectAndReturn(0u, true);
160  TEST_ASSERT_EQUAL(false, SOA_IsCurrentOnOpenString(BMS_CHARGING, 0u));
161  */
162 }
BC_CURRENT_MAX_DISCHARGE_MSL_mA
#define BC_CURRENT_MAX_DISCHARGE_MSL_mA
Maximum discharge current limit.
Definition: battery_cell_cfg.h:194
BC_CURRENT_MAX_CHARGE_MSL_mA
#define BC_CURRENT_MAX_CHARGE_MSL_mA
Maximum charge current limit.
Definition: battery_cell_cfg.h:210
BS_MAXIMUM_PACK_CURRENT_mA
#define BS_MAXIMUM_PACK_CURRENT_mA
Maximum pack current limit in mA that is used in the SOA module to check for pack overcurrent.
Definition: battery_system_cfg.h:213
BS_MAXIMUM_STRING_CURRENT_mA
#define BS_MAXIMUM_STRING_CURRENT_mA
Maximum string current limit in mA that is used in the SOA module to check for string overcurrent.
Definition: battery_system_cfg.h:205
BS_NR_OF_PARALLEL_CELLS_PER_MODULE
#define BS_NR_OF_PARALLEL_CELLS_PER_MODULE
number of battery cells in a parallel cell connection per battery module
Definition: battery_system_cfg.h:117
BMS_AT_REST
@ BMS_AT_REST
Definition: bms.h:69
BMS_DISCHARGING
@ BMS_DISCHARGING
Definition: bms.h:67
BMS_CHARGING
@ BMS_CHARGING
Definition: bms.h:66
BMS_RELAXATION
@ BMS_RELAXATION
Definition: bms.h:68
SOA_IsCurrentOnOpenString
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:111
SOA_IsPackCurrentLimitViolated
bool SOA_IsPackCurrentLimitViolated(uint32_t current_mA, BMS_CURRENT_FLOW_STATE_e currentDirection)
Checks if pack current limit is violated.
Definition: soa_cfg.c:71
SOA_IsStringCurrentLimitViolated
bool SOA_IsStringCurrentLimitViolated(uint32_t current_mA, BMS_CURRENT_FLOW_STATE_e currentDirection)
Checks if string current limit is violated.
Definition: soa_cfg.c:82
SOA_IsCellCurrentLimitViolated
bool SOA_IsCellCurrentLimitViolated(uint32_t current_mA, BMS_CURRENT_FLOW_STATE_e currentDirection)
Checks if cell current limit is violated.
Definition: soa_cfg.c:93
soa_cfg.h
Configuration header for SOA.
testSOA_IsCellCurrentLimitViolated
void testSOA_IsCellCurrentLimitViolated(void)
Definition: test_soa_cfg.c:119
testSOA_IsCurrentOnOpenString
void testSOA_IsCurrentOnOpenString(void)
Definition: test_soa_cfg.c:148
testDummy
void testDummy(void)
Definition: test_soa_cfg.c:72
setUp
void setUp(void)
Definition: test_soa_cfg.c:64
tearDown
void tearDown(void)
Definition: test_soa_cfg.c:67
testSOA_IsStringCurrentLimitViolated
void testSOA_IsStringCurrentLimitViolated(void)
Definition: test_soa_cfg.c:97
testSOA_IsPackCurrentLimitViolated
void testSOA_IsPackCurrentLimitViolated(void)
Definition: test_soa_cfg.c:75