foxBMS  1.1.2
The foxBMS Battery Management System API Documentation
mic.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 mic.h
44  * @author foxBMS Team
45  * @date 2020-05-08 (date of creation)
46  * @updated 2020-06-17 (date of last update)
47  * @ingroup DRIVER
48  * @prefix MIC
49  *
50  * @brief Measurement IC driver header
51  *
52  * @details TODO
53  */
54 
55 #ifndef FOXBMS__MIC_H_
56 #define FOXBMS__MIC_H_
57 
58 /*========== Includes =======================================================*/
59 #include "general.h"
60 
61 /*========== Macros and Definitions =========================================*/
62 
63 /** period for open wire measurement */
64 #define MIC_ERROR_OPEN_WIRE_PERIOD_ms (30000)
65 
66 /*========== Extern Constant and Variable Declarations ======================*/
67 
68 /*========== Extern Function Prototypes =====================================*/
69 /** tick function, this function is called to advance the state machine */
70 extern STD_RETURN_TYPE_e MIC_TriggerIc(void);
71 /** initializer, this function is called in order to initialize the MIC */
72 extern STD_RETURN_TYPE_e MIC_Init(void);
73 /** this function should tell the MIC that it should start measuring */
75 /** this function returns whether the first measurement cycle has finished */
76 extern bool MIC_IsFirstMeasurementCycleFinished(void);
77 
78 /**
79  * @brief Checks if the first MIC measurement cycle was made
80  * @return true is the first measurement cycle was made, false
81  * otherwise
82  */
83 extern bool MIC_IsFirstMeasurementCycleFinished(void);
84 
85 /**
86  * @brief Makes the initialization request to the MIC state machine
87  * @return true or false
88  */
90 
91 /**
92  * @brief Makes the request to the MIC state machine to write to the
93  * IO port-expander
94  * @param string string addressed by the request
95  */
96 extern STD_RETURN_TYPE_e MIC_RequestIoWrite(uint8_t string);
97 
98 /**
99  * @brief Makes the request to the MIC state machine to read from the
100  * IO port-expander
101  * @param string string addressed by the request
102  */
103 extern STD_RETURN_TYPE_e MIC_RequestIoRead(uint8_t string);
104 
105 /**
106  * @brief Makes the request to the MIC state machine to read from the
107  * external temperature sensor on slaves
108  * @param string string addressed by the request
109  */
110 extern STD_RETURN_TYPE_e MIC_RequestTemperatureRead(uint8_t string);
111 
112 /**
113  * @brief Makes the request to the MIC state machine to read
114  * balancing feedback from the slaves
115  * @param string string addressed by the request
116  */
118 
119 /**
120  * @brief Makes the request to the MIC state machine to read from the
121  * external EEPROM on slaves
122  * @param string string addressed by the request
123  */
124 extern STD_RETURN_TYPE_e MIC_RequestEepromRead(uint8_t string);
125 
126 /**
127  * @brief Makes the request to the MIC state machine to write to the
128  * external EEPROM on slaves
129  * @param string string addressed by the request
130  */
131 extern STD_RETURN_TYPE_e MIC_RequestEepromWrite(uint8_t string);
132 
133 /**
134  * @brief Makes the request to the MIC state machine to perform
135  * open-wire check
136  * @param string string addressed by the request
137  */
138 extern STD_RETURN_TYPE_e MIC_RequestOpenWireCheck(uint8_t string);
139 
140 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
141 
142 #endif /* FOXBMS__MIC_H_ */
enum STD_RETURN_TYPE STD_RETURN_TYPE_e
General macros and definitions for the whole platform.
STD_RETURN_TYPE_e MIC_RequestIoWrite(uint8_t string)
Makes the request to the MIC state machine to write to the IO port-expander.
STD_RETURN_TYPE_e MIC_Init(void)
STD_RETURN_TYPE_e MIC_RequestEepromWrite(uint8_t string)
Makes the request to the MIC state machine to write to the external EEPROM on slaves.
STD_RETURN_TYPE_e MIC_RequestOpenWireCheck(uint8_t string)
Makes the request to the MIC state machine to perform open-wire check.
bool MIC_IsFirstMeasurementCycleFinished(void)
Checks if the first MIC measurement cycle was made.
STD_RETURN_TYPE_e MIC_RequestBalancingFeedbackRead(uint8_t string)
Makes the request to the MIC state machine to read balancing feedback from the slaves.
STD_RETURN_TYPE_e MIC_StartMeasurement(void)
Makes the initialization request to the MIC state machine.
STD_RETURN_TYPE_e MIC_RequestEepromRead(uint8_t string)
Makes the request to the MIC state machine to read from the external EEPROM on slaves.
STD_RETURN_TYPE_e MIC_TriggerIc(void)
STD_RETURN_TYPE_e MIC_RequestIoRead(uint8_t string)
Makes the request to the MIC state machine to read from the IO port-expander.
STD_RETURN_TYPE_e MIC_RequestTemperatureRead(uint8_t string)
Makes the request to the MIC state machine to read from the external temperature sensor on slaves.