foxBMS-UnitTests  1.0.0
The foxBMS Unit Tests API Documentation
algorithm.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 algorithm.h
44  * @author foxBMS Team
45  * @date 2017-12-18 (date of creation)
46  * @updated 2020-06-30 (date of last update)
47  * @ingroup ALGORITHMS
48  * @prefix ALGO
49  *
50  * @brief Headers for the driver for the storage in the EEPROM memory
51  *
52  * @details Header file driver of external EEPROM device
53  *
54  */
55 
56 #ifndef FOXBMS__ALGORITHM_H_
57 #define FOXBMS__ALGORITHM_H_
58 
59 /*========== Includes =======================================================*/
60 #include "algorithm_cfg.h"
61 
62 /*========== Macros and Definitions =========================================*/
63 
64 /*========== Extern Constant and Variable Declarations ======================*/
65 
66 /*========== Extern Function Prototypes =====================================*/
67 /**
68  * @brief Calling this function sets a signal that lets
69  * #ALGO_Initialization() know that the initialization has to be run.
70  */
71 extern void ALGO_UnlockInitialization(void);
72 
73 /**
74  * @brief handles the call of different algorithm functions when cycle time
75  * has expired
76  */
77 extern void ALGO_MainFunction(void);
78 
79 /**
80  * @brief monitors the calculation duration of the different algorithms
81  */
82 extern void ALGO_MonitorExecutionTime(void);
83 
84 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
85 #ifdef UNITY_UNIT_TEST
86 extern void TEST_ALGO_ResetInitializationRequest(void);
87 #endif /* UNITY_UNIT_TEST */
88 #endif /* FOXBMS__ALGORITHM_H_ */
ALGO_MonitorExecutionTime
void ALGO_MonitorExecutionTime(void)
monitors the calculation duration of the different algorithms
Definition: algorithm.c:145
algorithm_cfg.h
Headers for the configuration of the algorithm module.
ALGO_UnlockInitialization
void ALGO_UnlockInitialization(void)
Calling this function sets a signal that lets ALGO_Initialization() know that the initialization has ...
Definition: algorithm.c:107
TEST_ALGO_ResetInitializationRequest
void TEST_ALGO_ResetInitializationRequest(void)
Definition: algorithm.c:161
ALGO_MainFunction
void ALGO_MainFunction(void)
handles the call of different algorithm functions when cycle time has expired
Definition: algorithm.c:113