foxBMS - Unit Tests  1.3.0
The foxBMS Unit Tests API Documentation
plausibility_cfg.h
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 plausibility_cfg.h
44  * @author foxBMS Team
45  * @date 2020-02-24 (date of creation)
46  * @updated 2022-05-30 (date of last update)
47  * @version v1.3.0
48  * @ingroup APPLICATION_CONFIGURATION
49  * @prefix PL
50  *
51  * @brief plausibility checks for cell voltage and cell temperatures
52  *
53  */
54 
55 #ifndef FOXBMS__PLAUSIBILITY_CFG_H_
56 #define FOXBMS__PLAUSIBILITY_CFG_H_
57 
58 /*========== Includes =======================================================*/
59 #include "battery_cell_cfg.h"
60 
61 /*========== Macros and Definitions =========================================*/
62 /**
63  * @ingroup CONFIG_PLAUSIBILITY
64  * @brief Maximum difference between pack voltage measurement from
65  * AFE and current sensor
66  * @ptype int
67  * \par Range:
68  * [0, 10000]
69  */
70 #define PL_STRING_VOLTAGE_TOLERANCE_mV (3000)
71 
72 /**
73  * @ingroup CONFIG_PLAUSIBILITY
74  * @brief Maximum difference between redundant cell voltage measurement
75  * @ptype int
76  * \par Range:
77  * [0, 10000]
78  */
79 #define PL_CELL_VOLTAGE_TOLERANCE_mV (10)
80 
81 /**
82  * @ingroup CONFIG_PLAUSIBILITY
83  * @brief Maximum difference between redundant cell temperature measurements
84  * in deci kelvin
85  * @ptype int
86  * \par Range:
87  * [0, 100]
88  */
89 #define PL_CELL_TEMPERATURE_TOLERANCE_dK (50)
90 
91 /**
92  * @ingroup CONFIG_PLAUSIBILITY
93  * @brief Maximum deviation between a single cell voltage measurement and the
94  * average cell voltage
95  * @ptype int
96  * \par Range:
97  * [0, 10000]
98  */
99 #define PL_CELL_VOLTAGE_SPREAD_TOLERANCE_mV (300)
100 
101 /**
102  * @ingroup CONFIG_PLAUSIBILITY
103  * @brief Maximum deviation between a single cell temperature measurement and
104  * the average cell temperature in deci kelvin
105  * @ptype int
106  * \par Range:
107  * [0, 100]
108  */
109 #define PL_CELL_TEMPERATURE_SPREAD_TOLERANCE_dK (100)
110 
111 /*========== Extern Constant and Variable Declarations ======================*/
112 
113 /*========== Extern Function Prototypes =====================================*/
114 
115 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
116 
117 #endif /* FOXBMS__PLAUSIBILITY_CFG_H_ */
battery_cell_cfg.h
Configuration of the battery cell (e.g., minimum and maximum cell voltage)