foxBMS  1.4.0
The foxBMS Battery Management System API Documentation
soa.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 soa.h
44  * @author foxBMS Team
45  * @date 2020-10-14 (date of creation)
46  * @updated 2022-07-28 (date of last update)
47  * @version v1.4.0
48  * @ingroup APPLICATION
49  * @prefix SOA
50  *
51  * @brief Header for SOA module, responsible for checking battery parameters
52  * against safety limits
53  *
54  */
55 
56 #ifndef FOXBMS__SOA_H_
57 #define FOXBMS__SOA_H_
58 
59 /*========== Includes =======================================================*/
60 #include "soa_cfg.h"
61 
62 #include "database.h"
63 
64 /*========== Macros and Definitions =========================================*/
65 
66 /*========== Extern Constant and Variable Declarations ======================*/
67 
68 /*========== Extern Function Prototypes =====================================*/
69 
70 /**
71  * @brief checks the abidance by the safe operating area
72  * @param[in] pMinimumMaximumCellVoltages pointer to database entry with
73  * minimum and maximum cell voltages
74  * @details verify for cell voltage measurements (U), if minimum and maximum
75  * values are out of range
76  */
77 extern void SOA_CheckVoltages(DATA_BLOCK_MIN_MAX_s *pMinimumMaximumCellVoltages);
78 
79 /**
80  * @brief checks the abidance by the safe operating area
81  * @param[in] pMinimumMaximumCellTemperatures pointer to database entry with
82  * @param[in] pCurrent pointer to pack value database entry
83  * @details verify for cell temperature measurements (T), if minimum and
84  * maximum values are out of range
85  */
86 extern void SOA_CheckTemperatures(
87  DATA_BLOCK_MIN_MAX_s *pMinimumMaximumCellTemperatures,
88  DATA_BLOCK_PACK_VALUES_s *pCurrent);
89 
90 /**
91  * @brief checks the abidance by the safe operating area
92  * @param[in] pTablePackValues pointer to pack values database entry
93  * @details verify for cell current measurements (I), if minimum and maximum
94  * values are out of range
95  */
96 extern void SOA_CheckCurrent(DATA_BLOCK_PACK_VALUES_s *pTablePackValues);
97 
98 /**
99  * @brief FOR FUTURE COMPATIBILITY; DUMMY FUNCTION; DO NOT USE
100  * @details FOR FUTURE COMPATIBILITY; DUMMY FUNCTION; DO NOT USE
101  */
102 extern void SOA_CheckSlaveTemperatures(void);
103 
104 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
105 
106 #endif /* FOXBMS__SOA_H_ */
Database module header.
void SOA_CheckTemperatures(DATA_BLOCK_MIN_MAX_s *pMinimumMaximumCellTemperatures, DATA_BLOCK_PACK_VALUES_s *pCurrent)
checks the abidance by the safe operating area
Definition: soa.c:145
void SOA_CheckVoltages(DATA_BLOCK_MIN_MAX_s *pMinimumMaximumCellVoltages)
checks the abidance by the safe operating area
Definition: soa.c:78
void SOA_CheckSlaveTemperatures(void)
FOR FUTURE COMPATIBILITY; DUMMY FUNCTION; DO NOT USE.
Definition: soa.c:350
void SOA_CheckCurrent(DATA_BLOCK_PACK_VALUES_s *pTablePackValues)
checks the abidance by the safe operating area
Definition: soa.c:268
Configuration header for SOA.