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