foxBMS  1.6.0
The foxBMS Battery Management System API Documentation
meas.c
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2023, 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 2023-10-12 (date of last update)
47  * @version v1.6.0
48  * @ingroup DRIVERS
49  * @prefix MEAS
50  *
51  * @brief Driver for the measurements needed by the BMS (e.g., I,V,T).
52  *
53  */
54 
55 /*========== Includes =======================================================*/
56 #include "meas.h"
57 
58 #include "battery_system_cfg.h"
59 
60 #include "afe.h"
61 #include "fassert.h"
62 #include "fstd_types.h"
63 
64 #include <stdbool.h>
65 #include <stdint.h>
66 
67 /*========== Macros and Definitions =========================================*/
68 
69 /*========== Static Constant and Variable Definitions =======================*/
70 
71 /*========== Extern Constant and Variable Definitions =======================*/
72 
73 /*========== Static Function Prototypes =====================================*/
74 
75 /*========== Static Function Implementations ================================*/
76 
77 /*========== Extern Function Implementations ================================*/
78 
79 void MEAS_Control(void) {
80  AFE_TriggerIc();
81 }
82 
83 extern STD_RETURN_TYPE_e MEAS_RequestIoWrite(uint8_t string) {
84  FAS_ASSERT(string < BS_NR_OF_STRINGS);
85  return AFE_RequestIoWrite(string);
86 }
87 
88 extern STD_RETURN_TYPE_e MEAS_RequestIoRead(uint8_t string) {
89  FAS_ASSERT(string < BS_NR_OF_STRINGS);
90  return AFE_RequestIoRead(string);
91 }
92 
93 extern STD_RETURN_TYPE_e MEAS_RequestTemperatureRead(uint8_t string) {
94  FAS_ASSERT(string < BS_NR_OF_STRINGS);
95  return AFE_RequestTemperatureRead(string);
96 }
97 
98 extern STD_RETURN_TYPE_e MEAS_RequestBalancingFeedbackRead(uint8_t string) {
99  FAS_ASSERT(string < BS_NR_OF_STRINGS);
100  return AFE_RequestBalancingFeedbackRead(string);
101 }
102 
103 extern STD_RETURN_TYPE_e MEAS_RequestEepromRead(uint8_t string) {
104  FAS_ASSERT(string < BS_NR_OF_STRINGS);
105  return AFE_RequestEepromRead(string);
106 }
107 
108 extern STD_RETURN_TYPE_e MEAS_RequestEepromWrite(uint8_t string) {
109  FAS_ASSERT(string < BS_NR_OF_STRINGS);
110  return AFE_RequestEepromWrite(string);
111 }
112 
113 extern bool MEAS_IsFirstMeasurementCycleFinished(void) {
114  return AFE_IsFirstMeasurementCycleFinished();
115 }
116 
117 extern STD_RETURN_TYPE_e MEAS_StartMeasurement(void) {
118  return AFE_StartMeasurement();
119 }
120 
121 extern STD_RETURN_TYPE_e MEAS_Initialize(void) {
122  return AFE_Initialize();
123 }
124 
125 extern STD_RETURN_TYPE_e MEAS_RequestOpenWireCheck(uint8_t string) {
126  FAS_ASSERT(string < BS_NR_OF_STRINGS);
127  return AFE_RequestOpenWireCheck(string);
128 }
129 
130 /*========== Externalized Static Function Implementations (Unit Test) =======*/
131 #ifdef UNITY_UNIT_TEST
132 #endif
AFE_RequestEepromRead
STD_RETURN_TYPE_e AFE_RequestEepromRead(uint8_t string)
Makes the request to the AFE state machine to read from the external EEPROM on slaves.
Definition: adi_ades183x_afe.c:85
AFE_RequestEepromWrite
STD_RETURN_TYPE_e AFE_RequestEepromWrite(uint8_t string)
Makes the request to the AFE state machine to write to the external EEPROM on slaves.
Definition: adi_ades183x_afe.c:92
AFE_RequestIoRead
STD_RETURN_TYPE_e AFE_RequestIoRead(uint8_t string)
Makes the request to the AFE state machine to read from the IO port-expander.
Definition: adi_ades183x_afe.c:128
AFE_TriggerIc
STD_RETURN_TYPE_e AFE_TriggerIc(void)
Definition: adi_ades183x_afe.c:75
AFE_RequestOpenWireCheck
STD_RETURN_TYPE_e AFE_RequestOpenWireCheck(uint8_t string)
Makes the request to the AFE state machine to perform open-wire check.
Definition: adi_ades183x_afe.c:113
AFE_IsFirstMeasurementCycleFinished
bool AFE_IsFirstMeasurementCycleFinished(void)
Checks if the first AFE measurement cycle was made.
Definition: adi_ades183x_afe.c:124
AFE_RequestBalancingFeedbackRead
STD_RETURN_TYPE_e AFE_RequestBalancingFeedbackRead(uint8_t string)
Makes the request to the AFE state machine to read balancing feedback from the slaves.
Definition: adi_ades183x_afe.c:106
AFE_RequestTemperatureRead
STD_RETURN_TYPE_e AFE_RequestTemperatureRead(uint8_t string)
Makes the request to the AFE state machine to read from the external temperature sensor on slaves.
Definition: adi_ades183x_afe.c:99
AFE_RequestIoWrite
STD_RETURN_TYPE_e AFE_RequestIoWrite(uint8_t string)
Makes the request to the AFE state machine to write to the IO port-expander.
Definition: adi_ades183x_afe.c:135
AFE_Initialize
STD_RETURN_TYPE_e AFE_Initialize(void)
Definition: adi_ades183x_afe.c:80
AFE_StartMeasurement
STD_RETURN_TYPE_e AFE_StartMeasurement(void)
Makes the initialization request to the AFE state machine.
Definition: adi_ades183x_afe.c:120
afe.h
AFE driver header.
battery_system_cfg.h
Configuration of the battery system (e.g., number of battery modules, battery cells,...
BS_NR_OF_STRINGS
#define BS_NR_OF_STRINGS
Number of parallel strings in the battery pack.
Definition: battery_system_cfg.h:99
fassert.h
Assert macro implementation.
FAS_ASSERT
#define FAS_ASSERT(x)
Assertion macro that asserts that x is true.
Definition: fassert.h:255
fstd_types.h
Definition of foxBMS standard types.
STD_RETURN_TYPE_e
STD_RETURN_TYPE_e
Definition: fstd_types.h:82
MEAS_RequestTemperatureRead
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:93
MEAS_RequestOpenWireCheck
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:125
MEAS_Control
void MEAS_Control(void)
Control function that is called from the task every 1ms.
Definition: meas.c:79
MEAS_RequestIoRead
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:88
MEAS_StartMeasurement
STD_RETURN_TYPE_e MEAS_StartMeasurement(void)
Makes the initialization request to the AFE state machine.
Definition: meas.c:117
MEAS_Initialize
STD_RETURN_TYPE_e MEAS_Initialize(void)
Definition: meas.c:121
MEAS_RequestIoWrite
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:83
MEAS_RequestEepromRead
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:103
MEAS_RequestBalancingFeedbackRead
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:98
MEAS_IsFirstMeasurementCycleFinished
bool MEAS_IsFirstMeasurementCycleFinished(void)
Checks if the first AFE measurement cycle was made.
Definition: meas.c:113
MEAS_RequestEepromWrite
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:108
meas.h
Headers for the driver for the measurements needed by the BMS (e.g., I,V,T).