foxBMS  1.2.0
The foxBMS Battery Management System API Documentation
algorithm_cfg.c
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2021, 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 algorithm_cfg.c
44  * @author foxBMS Team
45  * @date 2017-12-18 (date of creation)
46  * @updated 2020-06-30 (date of last update)
47  * @ingroup ALGORITHMS_CONFIGURATION
48  * @prefix ALGO
49  *
50  * @brief Configuration for the algorithm module
51  *
52  */
53 
54 /*========== Includes =======================================================*/
55 #include "algorithm_cfg.h"
56 
57 #include "moving_average.h"
58 #include "os.h"
59 
60 /*========== Macros and Definitions =========================================*/
61 
62 /*========== Static Constant and Variable Definitions =======================*/
63 
64 /*========== Extern Constant and Variable Definitions =======================*/
65 /** array of algorithms that should be executed */
67  {ALGO_UNINITIALIZED, 100, 1000, 0, NULL_PTR, &ALGO_MovAverage},
68 };
69 
70 const uint16_t algo_length = sizeof(algo_algorithms) / sizeof(algo_algorithms[0]);
71 
72 /*========== Static Function Prototypes =====================================*/
73 
74 /*========== Static Function Implementations ================================*/
75 
76 /*========== Extern Function Implementations ================================*/
77 
78 extern void ALGO_MarkAsDone(uint32_t algorithmIndex) {
79  FAS_ASSERT(algorithmIndex < algo_length);
80  if (algo_algorithms[algorithmIndex].state != ALGO_BLOCKED) {
81  algo_algorithms[algorithmIndex].state = ALGO_READY;
82  }
83 }
84 
85 /*========== Externalized Static Function Implementations (Unit Test) =======*/
const uint16_t algo_length
Definition: algorithm_cfg.c:70
ALGO_TASKS_s algo_algorithms[]
Definition: algorithm_cfg.c:66
void ALGO_MarkAsDone(uint32_t algorithmIndex)
Mark the current algorithm as done (will reset to ALGO_READY if possible)
Definition: algorithm_cfg.c:78
Headers for the configuration of the algorithm module.
@ ALGO_UNINITIALIZED
Definition: algorithm_cfg.h:81
@ ALGO_READY
Definition: algorithm_cfg.h:82
@ ALGO_BLOCKED
Definition: algorithm_cfg.h:85
#define FAS_ASSERT(x)
Assertion macro that asserts that x is true.
Definition: fassert.h:237
#define NULL_PTR
Null pointer.
Definition: fstd_types.h:66
void ALGO_MovAverage()
moving average algorithm
Implementation of the tasks used by the system, headers.
ALGO_STATE_e state
Definition: algorithm_cfg.h:91