foxBMS  1.4.0
The foxBMS Battery Management System API Documentation
afe_plausibility.c
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.c
44  * @author foxBMS Team
45  * @date 2019-01-24 (date of creation)
46  * @updated 2022-07-28 (date of last update)
47  * @version v1.4.0
48  * @ingroup MODULES
49  * @prefix AFE
50  *
51  * @brief AFE plausibility checks for cell voltage and cell temperatures
52  *
53  */
54 
55 /*========== Includes =======================================================*/
56 #include "afe_plausibility.h"
57 
58 #include "tsi.h"
59 
60 /*========== Macros and Definitions =========================================*/
61 
62 /*========== Static Constant and Variable Definitions =======================*/
63 
64 /*========== Extern Constant and Variable Definitions =======================*/
65 
66 /*========== Static Function Prototypes =====================================*/
67 
68 /*========== Static Function Implementations ================================*/
69 
70 /*========== Extern Function Implementations ================================*/
72  const int16_t cellVoltage_mV,
73  const AFE_PLAUSIBILITY_VALUES_s plausibleValues) {
74  STD_RETURN_TYPE_e retval = STD_OK;
75 
76  /* sanity-check: limits have to be ascending and not equal */
77  FAS_ASSERT(plausibleValues.maximumPlausibleVoltage_mV > plausibleValues.minimumPlausibleVoltage_mV);
78 
79  if ((cellVoltage_mV > plausibleValues.maximumPlausibleVoltage_mV) ||
80  (cellVoltage_mV < plausibleValues.minimumPlausibleVoltage_mV)) {
81  /* Cell voltage measurement value out of measurement range */
82  retval = STD_NOT_OK;
83  }
84  return retval;
85 }
86 
87 extern STD_RETURN_TYPE_e AFE_PlausibilityCheckTempMinMax(const int16_t celltemperature_ddegC) {
88  STD_RETURN_TYPE_e retval = STD_OK;
89 
90  const int16_t plausibleMaximumTemperature_ddegC = TSI_GetMaximumPlausibleTemperature();
91  const int16_t plausibleMinimumTemperature_ddegC = TSI_GetMinimumPlausibleTemperature();
92 
93  /* General plausibility check: Maximum temperature may not be smaller than minimum */
94  FAS_ASSERT(plausibleMaximumTemperature_ddegC >= plausibleMinimumTemperature_ddegC);
95 
96  if ((celltemperature_ddegC > plausibleMaximumTemperature_ddegC) ||
97  (celltemperature_ddegC < plausibleMinimumTemperature_ddegC)) {
98  /* Cell voltage measurement value out of measurement range */
99  retval = STD_NOT_OK;
100  }
101  return retval;
102 }
103 
104 /*========== Extern Function Prototypes =====================================*/
105 
106 /*========== Externalized Static Function Implementations (Unit Test) =======*/
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.
plausibility checks for cell voltage and cell temperatures
#define FAS_ASSERT(x)
Assertion macro that asserts that x is true.
Definition: fassert.h:252
STD_RETURN_TYPE_e
Definition: fstd_types.h:81
@ STD_NOT_OK
Definition: fstd_types.h:83
@ STD_OK
Definition: fstd_types.h:82
struct definition for plausibility values of an AFE
const int16_t minimumPlausibleVoltage_mV
const int16_t maximumPlausibleVoltage_mV
Temperature Sensor Interface on Slave Unit driver header.
int16_t TSI_GetMaximumPlausibleTemperature(void)
Return the maximum plausible temperature.
Definition: tsi_limits.c:81
int16_t TSI_GetMinimumPlausibleTemperature(void)
Return the minimum plausible temperature.
Definition: tsi_limits.c:85