foxBMS  1.0.0
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
4  * angewandten Forschung e.V. All rights reserved.
5  *
6  * BSD 3-Clause License
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  * 1. Redistributions of source code must retain the above copyright notice,
10  * this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the distribution.
14  * 3. Neither the name of the copyright holder nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  *
30  * We kindly request you to use one or more of the following phrases to refer
31  * to foxBMS in your hardware, software, documentation or advertising
32  * materials:
33  *
34  * ″This product uses parts of foxBMS®″
35  *
36  * ″This product includes parts of foxBMS®″
37  *
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_ */
MIC_TriggerIc
STD_RETURN_TYPE_e MIC_TriggerIc(void)
Definition: debug_default_mic.c:71
general.h
TODO.
MIC_RequestEepromWrite
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.
Definition: debug_default_mic.c:130
MIC_RequestIoWrite
STD_RETURN_TYPE_e MIC_RequestIoWrite(uint8_t string)
Makes the request to the MIC state machine to write to the IO port-expander.
Definition: debug_default_mic.c:90
STD_RETURN_TYPE_e
enum STD_RETURN_TYPE STD_RETURN_TYPE_e
MIC_Init
STD_RETURN_TYPE_e MIC_Init(void)
Definition: debug_default_mic.c:75
MIC_RequestEepromRead
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.
Definition: debug_default_mic.c:122
MIC_StartMeasurement
STD_RETURN_TYPE_e MIC_StartMeasurement(void)
Makes the initialization request to the MIC state machine.
Definition: debug_default_mic.c:79
MIC_RequestIoRead
STD_RETURN_TYPE_e MIC_RequestIoRead(uint8_t string)
Makes the request to the MIC state machine to read from the IO port-expander.
Definition: debug_default_mic.c:98
MIC_IsFirstMeasurementCycleFinished
bool MIC_IsFirstMeasurementCycleFinished(void)
Checks if the first MIC measurement cycle was made.
Definition: debug_default_mic.c:83
MIC_RequestBalancingFeedbackRead
STD_RETURN_TYPE_e MIC_RequestBalancingFeedbackRead(uint8_t string)
Makes the request to the MIC state machine to read balancing feedback from the slaves.
Definition: debug_default_mic.c:114
MIC_RequestTemperatureRead
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.
Definition: debug_default_mic.c:106
MIC_RequestOpenWireCheck
STD_RETURN_TYPE_e MIC_RequestOpenWireCheck(uint8_t string)
Makes the request to the MIC state machine to perform open-wire check.
Definition: debug_default_mic.c:138