foxBMS  1.0.1
The foxBMS Battery Management System API Documentation
meas.c
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.c
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 Driver for the measurements needed by the BMS (e.g., I,V,T).
51  *
52  */
53 
54 /*========== Includes =======================================================*/
55 #include "meas.h"
56 
57 #include "battery_system_cfg.h"
58 
59 #include "mic.h"
60 
61 /*========== Macros and Definitions =========================================*/
62 
63 /*========== Static Constant and Variable Definitions =======================*/
64 
65 /*========== Extern Constant and Variable Definitions =======================*/
66 
67 /*========== Static Function Prototypes =====================================*/
68 
69 /*========== Static Function Implementations ================================*/
70 
71 /*========== Extern Function Implementations ================================*/
72 
73 void MEAS_Control(void) {
74  MIC_TriggerIc();
75 }
76 
77 extern STD_RETURN_TYPE_e MEAS_RequestIoWrite(uint8_t string) {
78  FAS_ASSERT(string < BS_NR_OF_STRINGS);
79  return MIC_RequestIoWrite(string);
80 }
81 
82 extern STD_RETURN_TYPE_e MEAS_RequestIoRead(uint8_t string) {
83  FAS_ASSERT(string < BS_NR_OF_STRINGS);
84  return MIC_RequestIoRead(string);
85 }
86 
87 extern STD_RETURN_TYPE_e MEAS_RequestTemperatureRead(uint8_t string) {
88  FAS_ASSERT(string < BS_NR_OF_STRINGS);
89  return MIC_RequestTemperatureRead(string);
90 }
91 
92 extern STD_RETURN_TYPE_e MEAS_RequestBalancingFeedbackRead(uint8_t string) {
93  FAS_ASSERT(string < BS_NR_OF_STRINGS);
94  return MIC_RequestBalancingFeedbackRead(string);
95 }
96 
97 extern STD_RETURN_TYPE_e MEAS_RequestEepromRead(uint8_t string) {
98  FAS_ASSERT(string < BS_NR_OF_STRINGS);
99  return MIC_RequestEepromRead(string);
100 }
101 
102 extern STD_RETURN_TYPE_e MEAS_RequestEepromWrite(uint8_t string) {
103  FAS_ASSERT(string < BS_NR_OF_STRINGS);
104  return MIC_RequestEepromWrite(string);
105 }
106 
107 extern bool MEAS_IsFirstMeasurementCycleFinished(void) {
108  return MIC_IsFirstMeasurementCycleFinished();
109 }
110 
111 extern STD_RETURN_TYPE_e MEAS_StartMeasurement(void) {
112  return MIC_StartMeasurement();
113 }
114 
115 extern STD_RETURN_TYPE_e MEAS_Initialize(void) {
116  return MIC_Init();
117 }
118 
119 extern STD_RETURN_TYPE_e MEAS_RequestOpenWireCheck(uint8_t string) {
120  FAS_ASSERT(string < BS_NR_OF_STRINGS);
121  return MIC_RequestOpenWireCheck(string);
122 }
123 
124 /*========== Externalized Static Function Implementations (Unit Test) =======*/
MIC_TriggerIc
STD_RETURN_TYPE_e MIC_TriggerIc(void)
Definition: debug_default_mic.c:71
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
MEAS_RequestIoWrite
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
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
battery_system_cfg.h
Configuration of the battery system (e.g., number of battery modules, battery cells,...
MIC_StartMeasurement
STD_RETURN_TYPE_e MIC_StartMeasurement(void)
Makes the initialization request to the MIC state machine.
Definition: debug_default_mic.c:79
MEAS_IsFirstMeasurementCycleFinished
bool MEAS_IsFirstMeasurementCycleFinished(void)
Checks if the first MIC measurement cycle was made.
Definition: meas.c:107
FAS_ASSERT
#define FAS_ASSERT(x)
Assertion macro that asserts that x is true.
Definition: fassert.h:237
MEAS_StartMeasurement
STD_RETURN_TYPE_e MEAS_StartMeasurement(void)
Makes the initialization request to the MIC state machine.
Definition: meas.c:111
MEAS_RequestEepromRead
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
mic.h
Measurement IC driver header.
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
MEAS_Control
void MEAS_Control(void)
Control function that is called from the task every 1ms.
Definition: meas.c:73
MEAS_RequestTemperatureRead
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
MIC_IsFirstMeasurementCycleFinished
bool MIC_IsFirstMeasurementCycleFinished(void)
Checks if the first MIC measurement cycle was made.
Definition: debug_default_mic.c:83
meas.h
Headers for the driver for the measurements needed by the BMS (e.g., I,V,T).
MEAS_RequestBalancingFeedbackRead
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
MEAS_RequestIoRead
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
MEAS_Initialize
STD_RETURN_TYPE_e MEAS_Initialize(void)
Definition: meas.c:115
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
MEAS_RequestOpenWireCheck
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
BS_NR_OF_STRINGS
#define BS_NR_OF_STRINGS
Definition: battery_system_cfg.h:89
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
MEAS_RequestEepromWrite
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
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