foxBMS - Unit Tests  1.2.0
The foxBMS Unit Tests API Documentation
database_helper.h
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 database_helper.h
44  * @author foxBMS Team
45  * @date 2021-05-05 (date of creation)
46  * @updated 2021-05-05 (date of last update)
47  * @ingroup ENGINE
48  * @prefix DATA
49  *
50  * @brief Database module header
51  *
52  * @details Provides helper function to handle database entries
53  *
54  */
55 
56 #ifndef FOXBMS__DATABASE_HELPER_H_
57 #define FOXBMS__DATABASE_HELPER_H_
58 
59 /*========== Includes =======================================================*/
60 #include "database_cfg.h"
61 
62 /*========== Macros and Definitions =========================================*/
63 
64 /*========== Extern Constant and Variable Declarations ======================*/
65 
66 /*========== Extern Function Prototypes =====================================*/
67 /**
68  * @brief Checks if passed database entry has been updated at least once.
69  * @param[in] dataBlockHeader header of database entry
70  * @return true if database entry has been updated at least once, otherwise false
71  */
73 
74 /**
75  * @brief Checks if passed database entry has been updated within the last
76  * time interval
77  * @param[in] dataBlockHeader header of database entry
78  * @param[in] timeInterval in systicks (type: uint32_t)
79  * @return true if database entry has been updated within the time interval,
80  * otherwise false
81  */
82 extern bool DATA_EntryUpdatedWithinInterval(DATA_BLOCK_HEADER_s dataBlockHeader, uint32_t timeInterval);
83 
84 /**
85  * @brief Checks if passed database entry has been periodically updated
86  * within the time interval
87  * @details Checks if the last update timestamp is not older than time interval
88  * and if the difference between previous timestamp and timestamp is
89  * smaller than time interval
90  * @param[in] dataBlockHeader header of database entry
91  * @param[in] timeInterval in systicks (type: uint32_t)
92  * @return true if database entry has been periodically updated within the time
93  * interval, otherwise false
94  */
95 extern bool DATA_EntryUpdatedPeriodicallyWithinInterval(DATA_BLOCK_HEADER_s dataBlockHeader, uint32_t timeInterval);
96 
97 /**
98  * @brief Returns string number of passed cell index
99  * @param[in] cellIndex index of cell starting by 0
100  * @return string number of passed cell index
101  */
102 extern uint8_t DATA_GetStringNumberFromVoltageIndex(uint16_t cellIndex);
103 
104 /**
105  * @brief Returns module number of passed cell index
106  * @param[in] cellIndex index of cell starting by 0
107  * @return module number of passed cell index
108  */
109 extern uint8_t DATA_GetModuleNumberFromVoltageIndex(uint16_t cellIndex);
110 
111 /**
112  * @brief Returns cell number of passed cell index
113  * @param[in] cellIndex index of cell in starting by 0
114  * @return cell number of passed cell index
115  */
116 extern uint8_t DATA_GetCellNumberFromVoltageIndex(uint16_t cellIndex);
117 
118 /**
119  * @brief Returns string number of passed temperature sensor index
120  * @param[in] sensorIndex index of sensor starting by 0
121  * @return string number of passed temperature sensor index
122  */
123 extern uint8_t DATA_GetStringNumberFromTemperatureIndex(uint16_t sensorIndex);
124 
125 /**
126  * @brief Returns module number of passed temperature sensor index
127  * @param[in] sensorIndex index of sensor starting by 0
128  * @return module number of passed temperature sensor index
129  */
130 extern uint8_t DATA_GetModuleNumberFromTemperatureIndex(uint16_t sensorIndex);
131 
132 /**
133  * @brief Returns sensor number of passed temperature sensor index
134  * @param[in] sensorIndex index of sensorstarting by 0
135  * @return temperature sensor number of passed sensor index
136  */
137 extern uint8_t DATA_GetSensorNumberFromTemperatureIndex(uint16_t sensorIndex);
138 
139 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
140 
141 #endif /* FOXBMS__DATABASE_HELPER_H_ */
Database configuration header.
uint8_t DATA_GetSensorNumberFromTemperatureIndex(uint16_t sensorIndex)
Returns sensor number of passed temperature sensor index.
uint8_t DATA_GetModuleNumberFromVoltageIndex(uint16_t cellIndex)
Returns module number of passed cell index.
uint8_t DATA_GetModuleNumberFromTemperatureIndex(uint16_t sensorIndex)
Returns module number of passed temperature sensor index.
uint8_t DATA_GetStringNumberFromVoltageIndex(uint16_t cellIndex)
Returns string number of passed cell index.
uint8_t DATA_GetStringNumberFromTemperatureIndex(uint16_t sensorIndex)
Returns string number of passed temperature sensor index.
bool DATA_DatabaseEntryUpdatedAtLeastOnce(DATA_BLOCK_HEADER_s dataBlockHeader)
Checks if passed database entry has been updated at least once.
bool DATA_EntryUpdatedPeriodicallyWithinInterval(DATA_BLOCK_HEADER_s dataBlockHeader, uint32_t timeInterval)
Checks if passed database entry has been periodically updated within the time interval.
uint8_t DATA_GetCellNumberFromVoltageIndex(uint16_t cellIndex)
Returns cell number of passed cell index.
bool DATA_EntryUpdatedWithinInterval(DATA_BLOCK_HEADER_s dataBlockHeader, uint32_t timeInterval)
Checks if passed database entry has been updated within the last time interval.