foxBMS  1.4.1
The foxBMS Battery Management System API Documentation
afe_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 afe_plausibility.h
44  * @author foxBMS Team
45  * @date 2019-01-24 (date of creation)
46  * @updated 2022-10-27 (date of last update)
47  * @version v1.4.1
48  * @ingroup MODULES
49  * @prefix AFE
50  *
51  * @brief plausibility checks for cell voltage and cell temperatures
52  *
53  */
54 
55 #ifndef FOXBMS__AFE_PLAUSIBILITY_H_
56 #define FOXBMS__AFE_PLAUSIBILITY_H_
57 
58 /*========== Includes =======================================================*/
59 #include "general.h"
60 
61 /*========== Macros and Definitions =========================================*/
62 
63 /**
64  * @brief struct definition for plausibility values of an AFE
65  * @details This struct has to be implemented in a variable by each AFE and
66  * passed to #AFE_PlausibilityCheckVoltageMeasurementRange().
67  */
68 typedef struct {
69  /** largest cell voltage value that is considered plausible in mV
70  *
71  * This value should be the maximum operating limit of the AFE.
72  */
74  /** smallest cell voltage value that is considered plausible in mV
75  *
76  * This value should be the minimum operating limit of the AFE.
77  */
80 
81 /*========== Extern Constant and Variable Declarations ======================*/
82 
83 /*========== Extern Function Prototypes =====================================*/
84 /**
85  * @brief Cell voltage measurement range plausibility check
86  *
87  * @param cellVoltage_mV cell voltage that is checked in mV
88  * @param plausibleValues struct of type #AFE_PLAUSIBILITY_VALUES_s with the
89  * plausible limits of cell voltages
90  *
91  * @return #STD_OK if no plausibility issue detected, otherwise #STD_NOT_OK
92  */
94  const int16_t cellVoltage_mV,
95  const AFE_PLAUSIBILITY_VALUES_s plausibleValues);
96 
97 /**
98  * @brief Cell temperature plausibility check
99  *
100  * @param celltemperature_ddegC cell temperature that is checked in deci °C
101  */
102 extern STD_RETURN_TYPE_e AFE_PlausibilityCheckTempMinMax(const int16_t celltemperature_ddegC);
103 
104 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
105 
106 #endif /* FOXBMS__AFE_PLAUSIBILITY_H_ */
STD_RETURN_TYPE_e AFE_PlausibilityCheckTempMinMax(const int16_t celltemperature_ddegC)
Cell temperature plausibility check.
STD_RETURN_TYPE_e AFE_PlausibilityCheckVoltageMeasurementRange(const int16_t cellVoltage_mV, const AFE_PLAUSIBILITY_VALUES_s plausibleValues)
Cell voltage measurement range plausibility check.
STD_RETURN_TYPE_e
Definition: fstd_types.h:81
General macros and definitions for the whole platform.
struct definition for plausibility values of an AFE
const int16_t minimumPlausibleVoltage_mV
const int16_t maximumPlausibleVoltage_mV