foxBMS - Unit Tests  1.4.0
The foxBMS Unit Tests API Documentation
meas.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 meas.h
44  * @author foxBMS Team
45  * @date 2020-02-24 (date of creation)
46  * @updated 2022-07-28 (date of last update)
47  * @version v1.4.0
48  * @ingroup DRIVERS
49  * @prefix MEAS
50  *
51  * @brief Headers for the driver for the measurements needed by the BMS
52  * (e.g., I,V,T).
53  *
54  * @details TODO
55  */
56 
57 #ifndef FOXBMS__MEAS_H_
58 #define FOXBMS__MEAS_H_
59 
60 /*========== Includes =======================================================*/
61 #include "general.h"
62 
63 /*========== Macros and Definitions =========================================*/
64 
65 /*========== Extern Constant and Variable Declarations ======================*/
66 
67 /*========== Extern Function Prototypes =====================================*/
68 
69 /**
70  * Calls all initialization functions.
71  */
73 
74 /**
75  * @brief Control function that is called from the task every 1ms
76  * @details This control function or tick function is called every 1ms from the
77  * tasks. It calls the tick, trigger or control functions of the
78  * state machines belonging to the measurement module.
79  */
80 extern void MEAS_Control(void);
81 
82 /**
83  * @brief Checks if the first AFE measurement cycle was made
84  * @return true if the first measurement cycle was made, false otherwise
85  */
86 extern bool MEAS_IsFirstMeasurementCycleFinished(void);
87 
88 /**
89  * @brief Makes the initialization request to the AFE state machine
90  */
92 
93 /**
94  * @brief Makes the request to the AFE state machine to write to the IO
95  * port-expander
96  * @param string string addressed by the request
97  */
98 extern STD_RETURN_TYPE_e MEAS_RequestIoWrite(uint8_t string);
99 
100 /**
101  * @brief Makes the request to the AFE state machine to read from the IO
102  * port-expander
103  * @param string string addressed by the request
104  */
105 extern STD_RETURN_TYPE_e MEAS_RequestIoRead(uint8_t string);
106 
107 /**
108  * @brief Makes the request to the AFE state machine to read from the
109  * external temperature sensor on slaves
110  * @param string string addressed by the request
111  */
112 extern STD_RETURN_TYPE_e MEAS_RequestTemperatureRead(uint8_t string);
113 
114 /**
115  * @brief Makes the request to the AFE state machine to read balancing
116  * feedback from the slaves
117  * @param string string addressed by the request
118  */
120 
121 /**
122  * @brief Makes the request to the AFE state machine to read from the
123  * external EEPROM on slaves
124  * @param string string addressed by the request
125  */
126 extern STD_RETURN_TYPE_e MEAS_RequestEepromRead(uint8_t string);
127 
128 /**
129  * @brief Makes the request to the AFE state machine to write to the external
130  * EEPROM on slaves
131  * @param string string addressed by the request
132  */
133 extern STD_RETURN_TYPE_e MEAS_RequestEepromWrite(uint8_t string);
134 
135 /**
136  * @brief Makes the request to the AFE state machine to perform open-wire check
137  * @param string string addressed by the request
138  */
139 extern STD_RETURN_TYPE_e MEAS_RequestOpenWireCheck(uint8_t string);
140 
141 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
142 
143 #endif /* FOXBMS__MEAS_H_ */
STD_RETURN_TYPE_e
Definition: fstd_types.h:81
General macros and definitions for the whole platform.
STD_RETURN_TYPE_e MEAS_RequestTemperatureRead(uint8_t string)
Makes the request to the AFE state machine to read from the external temperature sensor on slaves.
Definition: meas.c:88
STD_RETURN_TYPE_e MEAS_RequestOpenWireCheck(uint8_t string)
Makes the request to the AFE state machine to perform open-wire check.
Definition: meas.c:120
void MEAS_Control(void)
Control function that is called from the task every 1ms.
Definition: meas.c:74
STD_RETURN_TYPE_e MEAS_RequestIoRead(uint8_t string)
Makes the request to the AFE state machine to read from the IO port-expander.
Definition: meas.c:83
STD_RETURN_TYPE_e MEAS_StartMeasurement(void)
Makes the initialization request to the AFE state machine.
Definition: meas.c:112
STD_RETURN_TYPE_e MEAS_Initialize(void)
Definition: meas.c:116
STD_RETURN_TYPE_e MEAS_RequestIoWrite(uint8_t string)
Makes the request to the AFE state machine to write to the IO port-expander.
Definition: meas.c:78
STD_RETURN_TYPE_e MEAS_RequestEepromRead(uint8_t string)
Makes the request to the AFE state machine to read from the external EEPROM on slaves.
Definition: meas.c:98
STD_RETURN_TYPE_e MEAS_RequestBalancingFeedbackRead(uint8_t string)
Makes the request to the AFE state machine to read balancing feedback from the slaves.
Definition: meas.c:93
bool MEAS_IsFirstMeasurementCycleFinished(void)
Checks if the first AFE measurement cycle was made.
Definition: meas.c:108
STD_RETURN_TYPE_e MEAS_RequestEepromWrite(uint8_t string)
Makes the request to the AFE state machine to write to the external EEPROM on slaves.
Definition: meas.c:103