foxBMS  1.0.0
The foxBMS Battery Management System API Documentation
mic_plausibility.h
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2021, Fraunhofer-Gesellschaft zur Foerderung der
4  * angewandten Forschung e.V. All rights reserved.
5  *
6  * BSD 3-Clause License
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  * 1. Redistributions of source code must retain the above copyright notice,
10  * this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the distribution.
14  * 3. Neither the name of the copyright holder nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  *
30  * We kindly request you to use one or more of the following phrases to refer
31  * to foxBMS in your hardware, software, documentation or advertising
32  * materials:
33  *
34  * ″This product uses parts of foxBMS®″
35  *
36  * ″This product includes parts of foxBMS®″
37  *
38  * ″This product is derived from foxBMS®″
39  *
40  */
41 
42 /**
43  * @file mic_plausibility.h
44  * @author foxBMS Team
45  * @date 2019-01-24 (date of creation)
46  * @updated 2021-01-15 (date of last update)
47  * @ingroup MODULES
48  * @prefix MIC
49  *
50  * @brief plausibility checks for cell voltage and cell temperatures
51  *
52  */
53 
54 #ifndef FOXBMS__MIC_PLAUSIBILITY_H_
55 #define FOXBMS__MIC_PLAUSIBILITY_H_
56 
57 /*========== Includes =======================================================*/
58 #include "general.h"
59 
60 /*========== Macros and Definitions =========================================*/
61 
62 /**
63  * @brief struct definition for plausibility values of a MIC
64  * @details This struct has to be implemented in a variable by each MIC and
65  * passed to #MIC_PlausibilityCheckVoltageMeasurementRange().
66  */
67 typedef struct MIC_PLAUSIBILITY_VALUES {
68  /** largest cell voltage value that is considered plausible in mV
69  *
70  * This value should be the maximum operating limit of the MIC.
71  */
72  const int16_t maximumPlausibleVoltage_mV;
73  /** smallest cell voltage value that is considered plausible in mV
74  *
75  * This value should be the minimum operating limit of the MIC.
76  */
77  const int16_t minimumPlausibleVoltage_mV;
78 } MIC_PLAUSIBILITY_VALUES_s;
79 
80 /*========== Extern Constant and Variable Declarations ======================*/
81 
82 /*========== Extern Function Prototypes =====================================*/
83 /**
84  * @brief Cell voltage measurement range plausibility check
85  *
86  * @param cellvoltage_mV cell voltage that is checked in mV
87  * @param plausibleValues struct of type #MIC_PLAUSIBILITY_VALUES_s with the
88  * plausible limits of cell voltages
89  *
90  * @return #STD_OK if no plausibility issue detected, otherwise #STD_NOT_OK
91  */
92 extern STD_RETURN_TYPE_e MIC_PlausibilityCheckVoltageMeasurementRange(
93  const int16_t cellvoltage_mV,
94  const MIC_PLAUSIBILITY_VALUES_s plausibleValues);
95 
96 /**
97  * @brief Cell temperature plausibility check
98  *
99  * @param celltemperature_ddegC cell temperature that is checked in deci °C
100  */
101 extern STD_RETURN_TYPE_e MIC_PlausibilityCheckTempMinMax(const int16_t celltemperature_ddegC);
102 
103 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
104 
105 #endif /* FOXBMS__MIC_PLAUSIBILITY_H_ */
general.h
TODO.
MIC_PLAUSIBILITY_VALUES_s
struct MIC_PLAUSIBILITY_VALUES MIC_PLAUSIBILITY_VALUES_s
struct definition for plausibility values of a MIC
STD_RETURN_TYPE_e
enum STD_RETURN_TYPE STD_RETURN_TYPE_e
MIC_PlausibilityCheckTempMinMax
STD_RETURN_TYPE_e MIC_PlausibilityCheckTempMinMax(const int16_t celltemperature_ddegC)
Cell temperature plausibility check.
Definition: mic_plausibility.c:86
MIC_PLAUSIBILITY_VALUES::maximumPlausibleVoltage_mV
const int16_t maximumPlausibleVoltage_mV
Definition: mic_plausibility.h:72
MIC_PlausibilityCheckVoltageMeasurementRange
STD_RETURN_TYPE_e MIC_PlausibilityCheckVoltageMeasurementRange(const int16_t cellvoltage_mV, const MIC_PLAUSIBILITY_VALUES_s plausibleValues)
Cell voltage measurement range plausibility check.
Definition: mic_plausibility.c:70
MIC_PLAUSIBILITY_VALUES::minimumPlausibleVoltage_mV
const int16_t minimumPlausibleVoltage_mV
Definition: mic_plausibility.h:77
MIC_PLAUSIBILITY_VALUES
struct definition for plausibility values of a MIC
Definition: mic_plausibility.h:67