foxBMS  1.4.0
The foxBMS Battery Management System API Documentation
plausibility.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.h
44  * @author foxBMS Team
45  * @date 2020-02-24 (date of creation)
46  * @updated 2022-07-28 (date of last update)
47  * @version v1.4.0
48  * @ingroup APPLICATION
49  * @prefix PL
50  *
51  * @brief plausibility checks for cell voltage and cell temperatures
52  *
53  */
54 
55 #ifndef FOXBMS__PLAUSIBILITY_H_
56 #define FOXBMS__PLAUSIBILITY_H_
57 
58 /*========== Includes =======================================================*/
59 #include "plausibility_cfg.h"
60 
61 #include "database.h"
62 
63 /*========== Macros and Definitions =========================================*/
64 
65 /*========== Extern Constant and Variable Declarations ======================*/
66 
67 /*========== Extern Function Prototypes =====================================*/
68 /**
69  * @brief Pack voltage plausibility check between LTC and current sensor values
70  *
71  * @param voltageAfe_mV pack voltage measured by AFE
72  * @param voltageCurrentSensor_mV pack voltage measured by current sensor
73  *
74  * @return #STD_OK if pack voltage valid, otherwise #STD_NOT_OK
75  */
76 extern STD_RETURN_TYPE_e PL_CheckStringVoltage(int32_t voltageAfe_mV, int32_t voltageCurrentSensor_mV);
77 
78 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
79 
80 /**
81  * @brief Cell voltage plausibility check between two redundant cell voltage measurement values
82  *
83  * @param[in] baseCellVoltage cell voltage from base measurement
84  * @param[in] redundancy0CellVoltage cell voltage from redundant measurement
85  * @param[out] pCellVoltage output cell voltage after plausibility check
86  *
87  * @return #STD_OK if cell voltage valid, otherwise #STD_NOT_OK
88  */
90  int16_t baseCellVoltage,
91  int16_t redundancy0CellVoltage,
92  int16_t *pCellVoltage);
93 
94 /**
95  * @brief Cell temperature plausibility check between two redundant cell temperature measurement values
96  *
97  * @param[in] baseCelltemperature cell temperature from base measurement
98  * @param[in] redundancy0Celltemperature cell temperature from redundant measurement
99  * @param[out] pCelltemperature output cell temperature after plausibility check
100  *
101  * @return #STD_OK if cell voltage valid, otherwise #STD_NOT_OK
102  */
104  int16_t baseCelltemperature,
105  int16_t redundancy0Celltemperature,
106  int16_t *pCelltemperature);
107 
108 /**
109  * @brief Cell voltage spread plausibility check
110  *
111  * @param[in,out] pCellVoltages pointer to cell voltage database entry
112  * @param[in] pMinMaxAverageValues pointer to minimum/maximum/average database entry
113  *
114  * @return #STD_OK if no issue detected, otherwise #STD_NOT_OK
115  */
117  DATA_BLOCK_CELL_VOLTAGE_s *pCellVoltages,
118  DATA_BLOCK_MIN_MAX_s *pMinMaxAverageValues);
119 
120 /**
121  * @brief Cell temperature spread plausibility check
122  *
123  * @param[in,out] pCellTemperatures pointer to cell temperature database entry
124  * @param[in] pMinMaxAverageValues pointer to minimum/maximum/average database entry
125  *
126  * @return #STD_OK if no issue detected, otherwise #STD_NOT_OK
127  */
129  DATA_BLOCK_CELL_TEMPERATURE_s *pCellTemperatures,
130  DATA_BLOCK_MIN_MAX_s *pMinMaxAverageValues);
131 
132 #endif /* FOXBMS__PLAUSIBILITY_H_ */
Database module header.
STD_RETURN_TYPE_e
Definition: fstd_types.h:81
STD_RETURN_TYPE_e PL_CheckTemperatureSpread(DATA_BLOCK_CELL_TEMPERATURE_s *pCellTemperatures, DATA_BLOCK_MIN_MAX_s *pMinMaxAverageValues)
Cell temperature spread plausibility check.
Definition: plausibility.c:155
STD_RETURN_TYPE_e PL_CheckCelltemperature(int16_t baseCelltemperature, int16_t redundancy0Celltemperature, int16_t *pCelltemperature)
Cell temperature plausibility check between two redundant cell temperature measurement values.
Definition: plausibility.c:104
STD_RETURN_TYPE_e PL_CheckStringVoltage(int32_t voltageAfe_mV, int32_t voltageCurrentSensor_mV)
Pack voltage plausibility check between LTC and current sensor values.
Definition: plausibility.c:74
STD_RETURN_TYPE_e PL_CheckCellVoltage(int16_t baseCellVoltage, int16_t redundancy0CellVoltage, int16_t *pCellVoltage)
Cell voltage plausibility check between two redundant cell voltage measurement values.
Definition: plausibility.c:86
STD_RETURN_TYPE_e PL_CheckVoltageSpread(DATA_BLOCK_CELL_VOLTAGE_s *pCellVoltages, DATA_BLOCK_MIN_MAX_s *pMinMaxAverageValues)
Cell voltage spread plausibility check.
Definition: plausibility.c:123
plausibility checks for cell voltage and cell temperatures